pax_global_header00006660000000000000000000000064130000202520014472gustar00rootroot0000000000000052 comment=890d9de0bd3a306811ee6a472afa0592c1f48e82 .gitignore000066400000000000000000000001511300002025200130230ustar00rootroot00000000000000umltest.inner.sh umltest.status /build /cmake /.idea *~ src/gitversion/*.pyc src/gitversion/__pycache__ .travis.yml000066400000000000000000000034631300002025200131550ustar00rootroot00000000000000language: cpp sudo: required dist: trusty compiler: - gcc - clang os: - linux - osx matrix: allow_failures: - os: linux compiler: clang addons: apt: sources: # Both needed for clang 3.7 - llvm-toolchain-precise-3.7 - ubuntu-toolchain-r-test packages: - clang-3.7 - libcrypto++-dev - libfuse-dev install: # Use new clang - if [ "${TRAVIS_OS_NAME}" == "linux" ] && [ "$CXX" = "clang++" ]; then export CXX="clang++-3.7" CC="clang-3.7"; fi # Detect number of CPU cores - export NUMCORES=`grep -c ^processor /proc/cpuinfo` && if [ ! -n "$NUMCORES" ]; then export NUMCORES=`sysctl -n hw.ncpu`; fi - echo Using $NUMCORES cores # Install dependencies - if [ "${TRAVIS_OS_NAME}" == "linux" ]; then ./travis.install_boost.sh; fi - if [ "${TRAVIS_OS_NAME}" == "osx" ]; then brew cask install osxfuse && brew install cryptopp; fi # Install run_with_fuse.sh - mkdir cmake - cd cmake - wget https://raw.githubusercontent.com/smessmer/travis-utils/master/run_with_fuse.sh - chmod +x run_with_fuse.sh - cmake --version # Use /dev/urandom when /dev/random is accessed, because travis doesn't have enough entropy - sudo cp -a /dev/urandom /dev/random script: - cmake .. -DBUILD_TESTING=on -DCMAKE_BUILD_TYPE=Debug - make -j$NUMCORES - ./test/gitversion/gitversion-test - ./test/cpp-utils/cpp-utils-test # TODO Also run on osx once fixed - if [ "${TRAVIS_OS_NAME}" == "linux" ]; then ./run_with_fuse.sh ./test/fspp/fspp-test || exit 1; fi - ./test/parallelaccessstore/parallelaccessstore-test - ./test/blockstore/blockstore-test - ./test/blobstore/blobstore-test # TODO Also run on osx once fixed - if [ "${TRAVIS_OS_NAME}" == "linux" ]; then ./test/cryfs/cryfs-test || exit 1; fi - if [ "${TRAVIS_OS_NAME}" == "linux" ]; then ./test/cryfs-cli/cryfs-cli-test || exit 1; fi after_script: - rm run_with_fuse.sh CMakeLists.txt000066400000000000000000000013051300002025200135750ustar00rootroot00000000000000cmake_minimum_required(VERSION 2.8 FATAL_ERROR) project(cryfs) include(utils.cmake) require_gcc_version(4.8) require_clang_version(3.7) # Default value is not to build test cases if(NOT BUILD_TESTING) set(BUILD_TESTING OFF CACHE BOOL "BUILD_TESTING") endif(NOT BUILD_TESTING) # Default vaule is to build in release mode if(NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE Release CACHE INTERNAL "CMAKE_BUILD_TYPE") endif(NOT CMAKE_BUILD_TYPE) # Default value is to do update checks if(NOT CRYFS_UPDATE_CHECKS) set(CRYFS_UPDATE_CHECKS ON CACHE BOOL "CRYFS_UPDATE_CHECKS") endif(NOT CRYFS_UPDATE_CHECKS) add_subdirectory(vendor) add_subdirectory(src) add_subdirectory(test) add_subdirectory(cpack) ChangeLog.txt000066400000000000000000000174031300002025200134330ustar00rootroot00000000000000Version 0.9.6 --------------- Fixed bugs: * Fix potential deadlock * Fix potential crash Improvements: * Allow building with -DCRYFS_UPDATE_CHECKS=off, which will create an executable with disabled update checks (the alternative to disable them in the environment also still works). * Automatically disable update checks when running in noninteractive mode. * More detailed error reporting if key derivation fails Compatibility: * Compatible with libcurl version >= 7.50.0, and <= 7.21.6 (tested down to 7.19.0) * Compatible with Crypto++ 5.6.4 * Compatible with compilers running under hardening-wrapper Version 0.9.5 --------------- Fixed Bugs: * Fixed a bug that prevented mounting a file system on Mac OS X. * File system operations correctly update the timestamps (access time, modification time and status change time). * Reacts correctly to fsync() and fdatasync() syscalls by flushing the corresponding data to the disk. Improvements: * When mounting an old file system, CryFS will ask before migrating it to the newest version. * Operating system tools like the mount command or /proc/self/mountinfo report correct file system type and also report the base directory. * Compatibility with GCC 6 Version 0.9.4 --------------- Improvements: * Ciphertext blocks are split into subdirectories (before, all were on top level) to reduce number of files per directory. Some unix tools don't work well with directories with too many entries. Fixed Bugs: * Renaming a file to an existing file (i.e. overwriting an existing file) didn't free the allocated memory for the overwritten file * Renaming a file to an existing file could hurt an invariant in the directory layout (directory entries have to be sorted) and doing so could cause files to seemingly disappear. * Fix a potential deadlock in the cache Compatibility: * The generated .deb packages work for any Ubuntu/Debian based distribution, but will not install the package source for automatic updates if it's an unsupported operating system. Version 0.9.3 --------------- New Features: * The ciphertext block size is configurable. You can use the "--blocksize" command line argument. If not specified, CryFS will ask you for a block size when creating a file system. * It's easier for tools and scripts to use CryFS: If an environment variable CRYFS_FRONTEND=noninteractive is set, we don't ask for options (but take default values for everything that's not specified on command line). Furthermore, in noninteractive mode, we won't ask for password confirmation when creating a file system. The password only has to be sent once to stdin. * You can disable the automatic update check by setting CRYFS_NO_UPDATE_CHECK=true in your environment. Fixed Bugs: * Building CryFS from the GitHub tarball (i.e. when there is no .git directory present) works. * A bug in the fstat implementation caused problems with some text editors (e.g. nano) falsely thinking a file changed since they opened it. * When trying to rename a file to an already existing file name, a bug deleted it instead. * Rename operation allows overwriting existing files, as specified in the rename(2) man page. Compatibility: * The generated .deb packages for Debian also work for the Devuan operating system. Version 0.9.2 --------------- * Experimental support for installing CryFS on Mac OS X using homebrew (0.9.2 is not released for Linux) Version 0.9.1 --------------- * Report file system usage statistics to the operating system (e.g. amount of space used). This information can be queried using the 'df' tool on linux. See https://github.com/cryfs/cryfs/commit/68acc27e88ff5209ca55ddb4e91f5a449d77fb54 * Use stronger scrypt parameters when generating the config file key from the user password. This makes it a bit more secure, but also takes a bit longer to load a file system. See https://github.com/cryfs/cryfs/commit/7f1493ab9210319cab008e71d4ee8f4d7d920f39 * Fix a bug where deleting a non-empty directory could leave some blocks over. See https://github.com/cryfs/cryfs/commit/df041ac84511e4560c4f099cd8cc089d08e05737 Version 0.9.0 --------------- (warning) file systems created with earlier CryFS versions are incompatible with this release. * Fully support file access times * Fix: Password is read from stdin, not from glibc getpass(). This enables external tools (e.g. GUIs) to pass in the password without problems. * Remove --extpass parameter, because that encourages tool writers to do bad things like storing a password in a file and using --extpass="cat filename". The password can now be passed in to stdin without problems, so tools should use that. * Works with zuluMount GUI, https://mhogomchungu.github.io/zuluCrypt/ * Introduce version flags for file system entities to allow future CryFS versions to be backwards-compatible even if the format changes. * (for developers) New git repository layout. All subrepositories have been merged to one directory. * (for developers) Using CMake instead of biicode as build system. Version 0.8.6 --------------- * Fix a deadlock that was caused when a very high load of parallel resize operations was issued, see https://github.com/cryfs/cryfs/issues/3 * Fix a bug that prevented deleting symlinks, see https://github.com/cryfs/cryfs/issues/2 * Gracefully accept modifications to the file access times instead of failing, although they're not stored yet (they will be stored in 0.9.0). This should fix https://github.com/cryfs/cryfs/issues/4 Version 0.8.5 --------------- * Fix package manager warning when installing the .deb package * Offer a default configuration when creating new filesystems * If the given base or mount directory doesn't exist, offer to create them Version 0.8.4 --------------- * Offering .deb packages for Debian and Ubuntu * Compatibility with 32bit systems * Support files larger than 4GB Version 0.8.3 --------------- * Ask for password confirmation when creating new filesystem * Check for new CryFS versions and ask the user to update if a new version is available * Implemented a mechanism that can show warnings about security bugs to users of a certain CryFS version. Let's hope this won't be necessary ;) * Compatibility with GCC 4.8 (that allows compiling on Ubuntu 14.04 for example) Version 0.8.2 --------------- * Mount directory, base directory, logfile and config file can be specified as relative paths * Improved error messages Version 0.8.1 --------------- * Config File Encryption: Configuration files are encrypted with two ciphers. The user specifies a password, which is then used with the scrypt KDF to generate the two encryption keys. - Inner level: Encrypts the config data using the user specified cipher. - Outer level: Encrypts the name of the inner cipher and the inner level ciphertext using aes-256-gcm. The config file is padded to hide the size of the configuration data (including the name of the cipher used). * No external config file needed: If the configuration file is not specified as command line parameter, it will be put into the base directory. This way, the filesystem can be mounted with the password only, without specifying a config file on command line. * Logfiles: Added a --logfile option to specify where logs should be written to. If the option is not specified, CryFs logs to syslog. * Running in Background: Fixed daemonization. When CryFs is run without "-f" flag, it will run in background. * Better error messages when base directory is not existing, not readable or not writeable. * Allow --cipher=xxx to specify cipher on command line. If cryfs is creating a new filesystem, it will use this cipher. If it is opening an existing filesystem, it will check whether this is the cipher used by it. * --show-ciphers shows a list of all supported ciphers * --extpass allows using an external program for password input * --unmount-idle x automatically unmounts the filesystem after x minutes without a filesystem operation. LICENSE000066400000000000000000000167431300002025200120560ustar00rootroot00000000000000 GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. README.md000066400000000000000000000120401300002025200123120ustar00rootroot00000000000000# CryFS [![Build Status](https://travis-ci.org/cryfs/cryfs.svg?branch=master)](https://travis-ci.org/cryfs/cryfs) CryFS encrypts your files, so you can safely store them anywhere. It works well together with cloud services like Dropbox, iCloud, OneDrive and others. See [https://www.cryfs.org](https://www.cryfs.org). Install latest release ====================== Easy install (Ubuntu and Debian) -------------------------------- wget -O - https://www.cryfs.org/install.sh | sudo bash Manual install (Ubuntu) ----------------------- # Add apt key wget -O - https://www.cryfs.org/apt.key | sudo apt-key add - # Add apt repository sudo sh -c "echo \"deb http://apt.cryfs.org/ubuntu `lsb_release -s -c` main\" > /etc/apt/sources.list.d/cryfs.list" # Install cryfs sudo apt-get update sudo apt-get install cryfs Manual install (Debian) ----------------------- # Add apt key wget -O - https://www.cryfs.org/apt.key | sudo apt-key add - # Add apt repository sudo sh -c "echo \"deb http://apt.cryfs.org/debian `lsb_release -s -c` main\" > /etc/apt/sources.list.d/cryfs.list" # Install cryfs sudo apt-get update sudo apt-get install cryfs GUI === If you want to use a GUI to mount your CryFS volumes, take a look at the [SiriKali project](https://mhogomchungu.github.io/sirikali/). You have to install the GUI **and** also CryFS itself for it to work. Building from source ==================== Requirements ------------ - Git (for getting the source code) - GCC version >= 4.8 or Clang >= 3.7 - CMake version >= 2.8 - libcurl4 (including development headers) - Boost libraries version >= 1.56 (including development headers) - filesystem - system - chrono - program_options - thread - Crypto++ version == 5.6.3 (including development headers) (not compatible to Crypto++ 5.6.4, but will be compatible with Crypto++ 5.6.5+) - SSL development libraries (including development headers, e.g. libssl-dev) - libFUSE version >= 2.8.6 (including development headers), on Mac OS X instead install osxfuse from https://osxfuse.github.io/ - Python >= 2.7 You can use the following commands to install these requirements # Ubuntu $ sudo apt-get install git g++ cmake make libcurl4-openssl-dev libboost-filesystem-dev libboost-system-dev libboost-chrono-dev libboost-program-options-dev libboost-thread-dev libcrypto++-dev libssl-dev libfuse-dev python # Fedora sudo dnf install git gcc-c++ cmake make libcurl-devel boost-devel boost-static cryptopp-devel openssl-devel fuse-devel python # Macintosh brew install cmake boost cryptopp openssl Build & Install --------------- 1. Clone repository $ git clone https://github.com/cryfs/cryfs.git cryfs $ cd cryfs 2. Build $ mkdir cmake && cd cmake $ cmake .. $ make 3. Install $ sudo make install You can pass the following variables to the *cmake* command (using *-Dvariablename=value*): - -D**CMAKE_BUILD_TYPE**=[Release|Debug]: Whether to run code optimization or add debug symbols. Default: Release - -D**BUILD_TESTING**=[on|off]: Whether to build the test cases (can take a long time). Default: off - -D**CRYFS_UPDATE_CHECKS**=off: Build a CryFS that doesn't check online for updates and security vulnerabilities. Troubleshooting --------------- On most systems, CMake should find the libraries automatically. However, that doesn't always work. 1. **Boost headers not found** Pass in the boost include path with cmake .. -DBoost_INCLUDE_DIRS=/path/to/boost/headers If you want to link boost dynamically (e.g. you don't have the static libraries), use the following: cmake .. -DBoost_USE_STATIC_LIBS=off 2. **Fuse/Osxfuse library not found** Pass in the library path with cmake .. -DFUSE_LIB_PATH=/path/to/fuse/or/osxfuse 3. **Fuse/Osxfuse headers not found** Pass in the include path with cmake .. -DCMAKE_CXX_FLAGS="-I/path/to/fuse/or/osxfuse/headers" 4. **CryptoPP library not found** Pass in the library path with cmake .. -DCRYPTOPP_LIB_PATH=/path/to/cryptopp 5. **Openssl headers not found** Pass in the include path with cmake .. -DCMAKE_C_FLAGS="-I/path/to/openssl/include" Creating .deb packages ---------------------- There are additional requirements if you want to create .deb packages. They are: - CMake version >= 3.3 - (optional) rpmbuild 1. Clone repository $ git clone https://github.com/cryfs/cryfs.git cryfs $ cd cryfs 2. Build $ mkdir cmake && cd cmake $ cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=off $ make package Disclaimer ---------------------- On the event of a password leak, you are strongly advised to create a new filesystem and copy all the data over from the previous one. Done this, all copies of the compromised filesystem and config file must be removed (e.g, from the "previous versions" feature of your cloud system) to prevent access to the key (and, as a result, your data) using the leaked password. archive.sh000077500000000000000000000002251300002025200130150ustar00rootroot00000000000000#!/bin/bash TAG=$1 GPGHOMEDIR=$2 git archive --format=tgz "$1" > cryfs-$1.tar.gz gpg --homedir "$GPGHOMEDIR" --armor --detach-sign cryfs-$1.tar.gz cpack/000077500000000000000000000000001300002025200121175ustar00rootroot00000000000000cpack/CMakeLists.txt000066400000000000000000000065701300002025200146670ustar00rootroot00000000000000# We only allow generating distribution packages if: # - it is a release build (to ensure all generated debian packages are fine to be distributed) # - tests are not built (because otherwise CPack would start installing googletest with the package as well) string(TOUPPER "${CMAKE_BUILD_TYPE}" BUILDTYPE) if(BUILDTYPE MATCHES RELEASE AND NOT BUILD_TESTING) if("${CMAKE_VERSION}" VERSION_LESS "3.3") # Earlier cmake versions generate .deb packages for which the package manager says they're bad quality # and asks the user whether they really want to install it. Cmake 3.3 fixes this. message(WARNING "Distribution package generation is only supported for CMake version >= 3.3. You're using ${CMAKE_VERSION}. You will be able to build and install CryFS, but you won't be able to generate .deb packages.") else("${CMAKE_VERSION}" VERSION_LESS "3.3") # Fix debfiles permissions. Unfortunately, git doesn't store file permissions. # When installing the .deb package and these files have the wrong permissions, the package manager complains. execute_process(COMMAND /bin/bash -c "chmod 0755 ${CMAKE_CURRENT_SOURCE_DIR}/debfiles/*") set(CPACK_GENERATOR TGZ DEB RPM) set(CPACK_PACKAGE_NAME "cryfs") get_git_version(GITVERSION_VERSION_STRING) set(CPACK_PACKAGE_VERSION "${GITVERSION_VERSION_STRING}") set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Encrypt your files and store them in the cloud.") set(CPACK_PACKAGE_DESCRIPTION "CryFS encrypts your files, so you can safely store them anywhere. It works well together with cloud services like Dropbox, iCloud, OneDrive and others.") set(CPACK_PACKAGE_CONTACT "Sebastian Messmer ") set(CPACK_PACKAGE_VENDOR "Sebastian Messmer") set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/../LICENSE") set(CPACK_PACKAGE_INSTALL_DIRECTORY "CMake ${CMake_VERSION_MAJOR}.${CMake_VERSION_MINOR}") if(WIN32 AND NOT UNIX) # There is a bug in NSI that does not handle full unix paths properly. Make # sure there is at least one set of four (4) backlasshes. #set(CPACK_PACKAGE_ICON "${CMake_SOURCE_DIR}/Utilities/Release\\\\InstallIcon.bmp") #set(CPACK_NSIS_INSTALLED_ICON_NAME "bin\\\\cryfs.exe") #set(CPACK_NSIS_DISPLAY_NAME "${CPACK_PACKAGE_INSTALL_DIRECTORY} CryFS") #set(CPACK_NSIS_HELP_LINK "http:\\\\\\\\www.cryfs.org") #set(CPACK_NSIS_URL_INFO_ABOUT "http:\\\\\\\\www.cryfs.org") #set(CPACK_NSIS_CONTACT "messmer@cryfs.org") #set(CPACK_NSIS_MODIFY_PATH ON) else(WIN32 AND NOT UNIX) set(CPACK_STRIP_FILES ON) set(CPACK_SOURCE_STRIP_FILES ON) endif(WIN32 AND NOT UNIX) set(CPACK_PACKAGE_EXECUTABLES "cryfs" "CryFS") set(CPACK_DEBIAN_PACKAGE_SECTION "utils") set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS ON) # Needs gnupg2 for postinst script set(CPACK_DEBIAN_PACKAGE_DEPENDS "fuse, gnupg2") set(CPACK_DEBIAN_PACKAGE_HOMEPAGE "https://www.cryfs.org") set(CPACK_RPM_PACKAGE_LICENSE "LGPLv3") set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/debfiles/postinst;${CMAKE_CURRENT_SOURCE_DIR}/debfiles/postrm") include(CPack) endif("${CMAKE_VERSION}" VERSION_LESS "3.3") endif(BUILDTYPE MATCHES RELEASE AND NOT BUILD_TESTING) cpack/debfiles/000077500000000000000000000000001300002025200136745ustar00rootroot00000000000000cpack/debfiles/postinst000077500000000000000000000113161300002025200155070ustar00rootroot00000000000000#!/bin/bash # This script is called after the cryfs .deb package is installed. # It sets up the package source so the user gets automatic updates for cryfs. # DEVELOPER WARNING: There is a lot of redundancy between this file and the install.sh script in the cryfs-web repository. Please port modifications to there! set -e DEBIAN_REPO_URL="http://apt.cryfs.org/debian" UBUNTU_REPO_URL="http://apt.cryfs.org/ubuntu" DISTRIBUTION=`lsb_release -s -i` DISTRIBUTION_VERSION=`lsb_release -s -c` containsElement () { local e for e in "${@:2}"; do [[ "$e" == "$1" ]] && return 0; done return 1 } get_repo_url () { if [[ "$DISTRIBUTION" == "Debian" ]] || [[ "$DISTRIBUTION" == "Devuan" ]]; then echo $DEBIAN_REPO_URL elif [[ "$DISTRIBUTION" == "Ubuntu" ]]; then echo $UBUNTU_REPO_URL else echo Not adding package source because $DISTRIBUTION is not supported. Please keep CryFS manually up to date. 1>&2 exit 0 fi } get_apt_config () { apt-config dump|grep "$1 "|sed -e "s/^$1\ \"\([^\"]*\)\"\;/\1/g" } sources_list_dir () { root=$(get_apt_config "Dir") etc=$(get_apt_config "Dir::Etc") sourceparts=$(get_apt_config "Dir::Etc::sourceparts") echo "$root/$etc/$sourceparts" } add_repository () { dir=$(sources_list_dir) repo_url=$(get_repo_url) echo "deb $repo_url $DISTRIBUTION_VERSION main" > $dir/cryfs.list } install_key () { # Key from http://www.cryfs.org/apt.key apt-key add - > /dev/null <&2 exit 1 ;; esac set +e exit 0 cpack/debfiles/postrm000077500000000000000000000015461300002025200151540ustar00rootroot00000000000000#!/bin/bash # This script is called after the cryfs .deb package is uninstalled. # It removes the package source that was used to get automatic updates. set -e get_apt_config () { apt-config dump|grep "$1 "|sed -e "s/^$1\ \"\([^\"]*\)\"\;/\1/g" } sources_list_dir () { root=$(get_apt_config "Dir") etc=$(get_apt_config "Dir::Etc") sourceparts=$(get_apt_config "Dir::Etc::sourceparts") echo $root$etc$sourceparts } remove_repository () { dir=$(sources_list_dir) rm -f $dir/cryfs.list } remove_key () { # Don't fail if key was already removed apt-key rm 549E65B2 2>&1 > /dev/null || true } case "$1" in purge) remove_repository remove_key ;; abort-install|abort-upgrade|remove|upgrade|failed-upgrade) ;; *) echo "postrm called with unknown argument '$1'" >&2 exit 1 ;; esac set +e exit 0 src/000077500000000000000000000000001300002025200116255ustar00rootroot00000000000000src/CMakeLists.txt000066400000000000000000000004251300002025200143660ustar00rootroot00000000000000include_directories(${CMAKE_CURRENT_SOURCE_DIR}) add_subdirectory(gitversion) add_subdirectory(cpp-utils) add_subdirectory(fspp) add_subdirectory(parallelaccessstore) add_subdirectory(blockstore) add_subdirectory(blobstore) add_subdirectory(cryfs) add_subdirectory(cryfs-cli) src/blobstore/000077500000000000000000000000001300002025200136205ustar00rootroot00000000000000src/blobstore/CMakeLists.txt000066400000000000000000000021311300002025200163550ustar00rootroot00000000000000project (blobstore) set(SOURCES implementations/onblocks/parallelaccessdatatreestore/ParallelAccessDataTreeStoreAdapter.cpp implementations/onblocks/parallelaccessdatatreestore/DataTreeRef.cpp implementations/onblocks/parallelaccessdatatreestore/ParallelAccessDataTreeStore.cpp implementations/onblocks/utils/Math.cpp implementations/onblocks/BlobStoreOnBlocks.cpp implementations/onblocks/datanodestore/DataNode.cpp implementations/onblocks/datanodestore/DataLeafNode.cpp implementations/onblocks/datanodestore/DataInnerNode.cpp implementations/onblocks/datanodestore/DataNodeStore.cpp implementations/onblocks/datatreestore/impl/algorithms.cpp implementations/onblocks/datatreestore/DataTree.cpp implementations/onblocks/datatreestore/DataTreeStore.cpp implementations/onblocks/BlobOnBlocks.cpp ) add_library(${PROJECT_NAME} STATIC ${SOURCES}) target_link_libraries(${PROJECT_NAME} PUBLIC cpp-utils blockstore) target_add_boost(${PROJECT_NAME} filesystem system thread) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) src/blobstore/implementations/000077500000000000000000000000001300002025200170305ustar00rootroot00000000000000src/blobstore/implementations/onblocks/000077500000000000000000000000001300002025200206425ustar00rootroot00000000000000src/blobstore/implementations/onblocks/BlobOnBlocks.cpp000066400000000000000000000102141300002025200236550ustar00rootroot00000000000000#include "parallelaccessdatatreestore/DataTreeRef.h" #include "BlobOnBlocks.h" #include "datanodestore/DataLeafNode.h" #include "utils/Math.h" #include #include using std::function; using cpputils::unique_ref; using cpputils::Data; using blobstore::onblocks::datanodestore::DataLeafNode; using blobstore::onblocks::datanodestore::DataNodeLayout; using blockstore::Key; namespace blobstore { namespace onblocks { using parallelaccessdatatreestore::DataTreeRef; BlobOnBlocks::BlobOnBlocks(unique_ref datatree) : _datatree(std::move(datatree)), _sizeCache(boost::none) { } BlobOnBlocks::~BlobOnBlocks() { } uint64_t BlobOnBlocks::size() const { if (_sizeCache == boost::none) { _sizeCache = _datatree->numStoredBytes(); } return *_sizeCache; } void BlobOnBlocks::resize(uint64_t numBytes) { _datatree->resizeNumBytes(numBytes); _sizeCache = numBytes; } void BlobOnBlocks::traverseLeaves(uint64_t beginByte, uint64_t sizeBytes, function func) const { uint64_t endByte = beginByte + sizeBytes; uint32_t firstLeaf = beginByte / _datatree->maxBytesPerLeaf(); uint32_t endLeaf = utils::ceilDivision(endByte, _datatree->maxBytesPerLeaf()); bool writingOutside = size() < endByte; // TODO Calling size() is slow because it has to traverse the tree _datatree->traverseLeaves(firstLeaf, endLeaf, [&func, beginByte, endByte, endLeaf, writingOutside](DataLeafNode *leaf, uint32_t leafIndex) { uint64_t indexOfFirstLeafByte = leafIndex * leaf->maxStoreableBytes(); uint32_t dataBegin = utils::maxZeroSubtraction(beginByte, indexOfFirstLeafByte); uint32_t dataEnd = std::min(leaf->maxStoreableBytes(), endByte - indexOfFirstLeafByte); if (leafIndex == endLeaf-1 && writingOutside) { // If we are traversing an area that didn't exist before, then the last leaf was just created with a wrong size. We have to fix it. leaf->resize(dataEnd); } func(indexOfFirstLeafByte, leaf, dataBegin, dataEnd-dataBegin); }); if (writingOutside) { ASSERT(_datatree->numStoredBytes() == endByte, "Writing didn't grow by the correct number of bytes"); _sizeCache = endByte; } } Data BlobOnBlocks::readAll() const { //TODO Querying size is inefficient. Is this possible without a call to size()? uint64_t count = size(); Data result(count); _read(result.data(), 0, count); return result; } void BlobOnBlocks::read(void *target, uint64_t offset, uint64_t count) const { ASSERT(offset <= size() && offset + count <= size(), "BlobOnBlocks::read() read outside blob. Use BlobOnBlocks::tryRead() if this should be allowed."); uint64_t read = tryRead(target, offset, count); ASSERT(read == count, "BlobOnBlocks::read() couldn't read all requested bytes. Use BlobOnBlocks::tryRead() if this should be allowed."); } uint64_t BlobOnBlocks::tryRead(void *target, uint64_t offset, uint64_t count) const { //TODO Quite inefficient to call size() here, because that has to traverse the tree uint64_t realCount = std::max(UINT64_C(0), std::min(count, size()-offset)); _read(target, offset, realCount); return realCount; } void BlobOnBlocks::_read(void *target, uint64_t offset, uint64_t count) const { traverseLeaves(offset, count, [target, offset] (uint64_t indexOfFirstLeafByte, const DataLeafNode *leaf, uint32_t leafDataOffset, uint32_t leafDataSize) { //TODO Simplify formula, make it easier to understand leaf->read((uint8_t*)target + indexOfFirstLeafByte - offset + leafDataOffset, leafDataOffset, leafDataSize); }); } void BlobOnBlocks::write(const void *source, uint64_t offset, uint64_t count) { traverseLeaves(offset, count, [source, offset] (uint64_t indexOfFirstLeafByte, DataLeafNode *leaf, uint32_t leafDataOffset, uint32_t leafDataSize) { //TODO Simplify formula, make it easier to understand leaf->write((uint8_t*)source + indexOfFirstLeafByte - offset + leafDataOffset, leafDataOffset, leafDataSize); }); } void BlobOnBlocks::flush() { _datatree->flush(); } const Key &BlobOnBlocks::key() const { return _datatree->key(); } unique_ref BlobOnBlocks::releaseTree() { return std::move(_datatree); } } } src/blobstore/implementations/onblocks/BlobOnBlocks.h000066400000000000000000000026701300002025200233310ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_BLOBONBLOCKS_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_BLOBONBLOCKS_H_ #include "../../interface/Blob.h" #include #include namespace blobstore { namespace onblocks { namespace datanodestore { class DataLeafNode; } namespace parallelaccessdatatreestore { class DataTreeRef; } class BlobOnBlocks final: public Blob { public: BlobOnBlocks(cpputils::unique_ref datatree); ~BlobOnBlocks(); const blockstore::Key &key() const override; uint64_t size() const override; void resize(uint64_t numBytes) override; cpputils::Data readAll() const override; void read(void *target, uint64_t offset, uint64_t size) const override; uint64_t tryRead(void *target, uint64_t offset, uint64_t size) const override; void write(const void *source, uint64_t offset, uint64_t size) override; void flush() override; cpputils::unique_ref releaseTree(); private: void _read(void *target, uint64_t offset, uint64_t count) const; void traverseLeaves(uint64_t offsetBytes, uint64_t sizeBytes, std::function) const; cpputils::unique_ref _datatree; mutable boost::optional _sizeCache; DISALLOW_COPY_AND_ASSIGN(BlobOnBlocks); }; } } #endif src/blobstore/implementations/onblocks/BlobStoreOnBlocks.cpp000066400000000000000000000043661300002025200247050ustar00rootroot00000000000000#include "parallelaccessdatatreestore/DataTreeRef.h" #include "parallelaccessdatatreestore/ParallelAccessDataTreeStore.h" #include #include "datanodestore/DataLeafNode.h" #include "datanodestore/DataNodeStore.h" #include "datatreestore/DataTreeStore.h" #include "datatreestore/DataTree.h" #include "BlobStoreOnBlocks.h" #include "BlobOnBlocks.h" #include #include using cpputils::unique_ref; using cpputils::make_unique_ref; using blockstore::BlockStore; using blockstore::parallelaccess::ParallelAccessBlockStore; using blockstore::Key; using cpputils::dynamic_pointer_move; using boost::optional; using boost::none; namespace blobstore { namespace onblocks { using datanodestore::DataNodeStore; using datatreestore::DataTreeStore; using parallelaccessdatatreestore::ParallelAccessDataTreeStore; BlobStoreOnBlocks::BlobStoreOnBlocks(unique_ref blockStore, uint64_t physicalBlocksizeBytes) : _dataTreeStore(make_unique_ref(make_unique_ref(make_unique_ref(make_unique_ref(std::move(blockStore)), physicalBlocksizeBytes)))) { } BlobStoreOnBlocks::~BlobStoreOnBlocks() { } unique_ref BlobStoreOnBlocks::create() { return make_unique_ref(_dataTreeStore->createNewTree()); } optional> BlobStoreOnBlocks::load(const Key &key) { auto tree = _dataTreeStore->load(key); if (tree == none) { return none; } return optional>(make_unique_ref(std::move(*tree))); } void BlobStoreOnBlocks::remove(unique_ref blob) { auto _blob = dynamic_pointer_move(blob); ASSERT(_blob != none, "Passed Blob in BlobStoreOnBlocks::remove() is not a BlobOnBlocks."); _dataTreeStore->remove((*_blob)->releaseTree()); } uint64_t BlobStoreOnBlocks::virtualBlocksizeBytes() const { return _dataTreeStore->virtualBlocksizeBytes(); } uint64_t BlobStoreOnBlocks::numBlocks() const { return _dataTreeStore->numNodes(); } uint64_t BlobStoreOnBlocks::estimateSpaceForNumBlocksLeft() const { return _dataTreeStore->estimateSpaceForNumNodesLeft(); } } } src/blobstore/implementations/onblocks/BlobStoreOnBlocks.h000066400000000000000000000026441300002025200243470ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_BLOCKED_BLOBSTOREONBLOCKS_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_BLOCKED_BLOBSTOREONBLOCKS_H_ #include "../../interface/BlobStore.h" #include "BlobOnBlocks.h" #include namespace blobstore { namespace onblocks { namespace parallelaccessdatatreestore { class ParallelAccessDataTreeStore; } //TODO Make blobstore able to cope with incomplete data (some blocks missing, because they're not synchronized yet) and write test cases for that class BlobStoreOnBlocks final: public BlobStore { public: BlobStoreOnBlocks(cpputils::unique_ref blockStore, uint64_t physicalBlocksizeBytes); ~BlobStoreOnBlocks(); cpputils::unique_ref create() override; boost::optional> load(const blockstore::Key &key) override; void remove(cpputils::unique_ref blob) override; //TODO Test blocksizeBytes/numBlocks/estimateSpaceForNumBlocksLeft //virtual means "space we can use" as opposed to "space it takes on the disk" (i.e. virtual is without headers, checksums, ...) uint64_t virtualBlocksizeBytes() const override; uint64_t numBlocks() const override; uint64_t estimateSpaceForNumBlocksLeft() const override; private: cpputils::unique_ref _dataTreeStore; DISALLOW_COPY_AND_ASSIGN(BlobStoreOnBlocks); }; } } #endif src/blobstore/implementations/onblocks/datanodestore/000077500000000000000000000000001300002025200234765ustar00rootroot00000000000000src/blobstore/implementations/onblocks/datanodestore/DataInnerNode.cpp000066400000000000000000000054451300002025200266650ustar00rootroot00000000000000#include "DataInnerNode.h" #include "DataNodeStore.h" #include using blockstore::Block; using cpputils::Data; using cpputils::unique_ref; using cpputils::make_unique_ref; using blockstore::Key; namespace blobstore { namespace onblocks { namespace datanodestore { DataInnerNode::DataInnerNode(DataNodeView view) : DataNode(std::move(view)) { ASSERT(depth() > 0, "Inner node can't have depth 0. Is this a leaf maybe?"); if (node().FormatVersion() != FORMAT_VERSION_HEADER) { throw std::runtime_error("This node format is not supported. Was it created with a newer version of CryFS?"); } } DataInnerNode::~DataInnerNode() { } unique_ref DataInnerNode::InitializeNewNode(unique_ref block, const DataNode &first_child) { DataNodeView node(std::move(block)); node.setFormatVersion(DataNode::FORMAT_VERSION_HEADER); node.setDepth(first_child.depth() + 1); node.setSize(1); auto result = make_unique_ref(std::move(node)); result->ChildrenBegin()->setKey(first_child.key()); return result; } uint32_t DataInnerNode::numChildren() const { return node().Size(); } DataInnerNode::ChildEntry *DataInnerNode::ChildrenBegin() { return const_cast(const_cast(this)->ChildrenBegin()); } const DataInnerNode::ChildEntry *DataInnerNode::ChildrenBegin() const { return node().DataBegin(); } DataInnerNode::ChildEntry *DataInnerNode::ChildrenEnd() { return const_cast(const_cast(this)->ChildrenEnd()); } const DataInnerNode::ChildEntry *DataInnerNode::ChildrenEnd() const { return ChildrenBegin() + node().Size(); } DataInnerNode::ChildEntry *DataInnerNode::LastChild() { return const_cast(const_cast(this)->LastChild()); } const DataInnerNode::ChildEntry *DataInnerNode::LastChild() const { return getChild(numChildren()-1); } DataInnerNode::ChildEntry *DataInnerNode::getChild(unsigned int index) { return const_cast(const_cast(this)->getChild(index)); } const DataInnerNode::ChildEntry *DataInnerNode::getChild(unsigned int index) const { ASSERT(index < numChildren(), "Accessing child out of range"); return ChildrenBegin()+index; } void DataInnerNode::addChild(const DataNode &child) { ASSERT(numChildren() < maxStoreableChildren(), "Adding more children than we can store"); ASSERT(child.depth() == depth()-1, "The child that should be added has wrong depth"); node().setSize(node().Size()+1); LastChild()->setKey(child.key()); } void DataInnerNode::removeLastChild() { ASSERT(node().Size() > 1, "There is no child to remove"); node().setSize(node().Size()-1); } uint32_t DataInnerNode::maxStoreableChildren() const { return node().layout().maxChildrenPerInnerNode(); } } } } src/blobstore/implementations/onblocks/datanodestore/DataInnerNode.h000066400000000000000000000021701300002025200263220ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATANODESTORE_DATAINNERNODE_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATANODESTORE_DATAINNERNODE_H_ #include "DataNode.h" #include "DataInnerNode_ChildEntry.h" namespace blobstore { namespace onblocks { namespace datanodestore { class DataInnerNode final: public DataNode { public: static cpputils::unique_ref InitializeNewNode(cpputils::unique_ref block, const DataNode &first_child_key); DataInnerNode(DataNodeView block); ~DataInnerNode(); using ChildEntry = DataInnerNode_ChildEntry; uint32_t maxStoreableChildren() const; ChildEntry *getChild(unsigned int index); const ChildEntry *getChild(unsigned int index) const; uint32_t numChildren() const; void addChild(const DataNode &child_key); void removeLastChild(); ChildEntry *LastChild(); const ChildEntry *LastChild() const; private: ChildEntry *ChildrenBegin(); ChildEntry *ChildrenEnd(); const ChildEntry *ChildrenBegin() const; const ChildEntry *ChildrenEnd() const; DISALLOW_COPY_AND_ASSIGN(DataInnerNode); }; } } } #endif src/blobstore/implementations/onblocks/datanodestore/DataInnerNode_ChildEntry.h000066400000000000000000000012401300002025200304440ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATANODESTORE_DATAINNERNODE_CHILDENTRY_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATANODESTORE_DATAINNERNODE_CHILDENTRY_H_ #include namespace blobstore{ namespace onblocks{ namespace datanodestore{ struct DataInnerNode_ChildEntry final { public: blockstore::Key key() const { return blockstore::Key::FromBinary(_keydata); } private: void setKey(const blockstore::Key &key) { key.ToBinary(_keydata); } friend class DataInnerNode; uint8_t _keydata[blockstore::Key::BINARY_LENGTH]; DISALLOW_COPY_AND_ASSIGN(DataInnerNode_ChildEntry); }; } } } #endif src/blobstore/implementations/onblocks/datanodestore/DataLeafNode.cpp000066400000000000000000000046101300002025200264520ustar00rootroot00000000000000#include "DataLeafNode.h" #include "DataInnerNode.h" #include using blockstore::Block; using cpputils::Data; using blockstore::Key; using cpputils::unique_ref; using cpputils::make_unique_ref; namespace blobstore { namespace onblocks { namespace datanodestore { DataLeafNode::DataLeafNode(DataNodeView view) : DataNode(std::move(view)) { ASSERT(node().Depth() == 0, "Leaf node must have depth 0. Is it an inner node instead?"); ASSERT(numBytes() <= maxStoreableBytes(), "Leaf says it stores more bytes than it has space for"); if (node().FormatVersion() != FORMAT_VERSION_HEADER) { throw std::runtime_error("This node format is not supported. Was it created with a newer version of CryFS?"); } } DataLeafNode::~DataLeafNode() { } unique_ref DataLeafNode::InitializeNewNode(unique_ref block) { DataNodeView node(std::move(block)); node.setFormatVersion(DataNode::FORMAT_VERSION_HEADER); node.setDepth(0); node.setSize(0); //fillDataWithZeroes(); not needed, because a newly created block will be zeroed out. DataLeafNodeTest.SpaceIsZeroFilledWhenGrowing ensures this. return make_unique_ref(std::move(node)); } void DataLeafNode::read(void *target, uint64_t offset, uint64_t size) const { ASSERT(offset <= node().Size() && offset + size <= node().Size(), "Read out of valid area"); // Also check offset, because the addition could lead to overflows std::memcpy(target, (uint8_t*)node().data() + offset, size); } void DataLeafNode::write(const void *source, uint64_t offset, uint64_t size) { ASSERT(offset <= node().Size() && offset + size <= node().Size(), "Write out of valid area"); // Also check offset, because the addition could lead to overflows node().write(source, offset, size); } uint32_t DataLeafNode::numBytes() const { return node().Size(); } void DataLeafNode::resize(uint32_t new_size) { ASSERT(new_size <= maxStoreableBytes(), "Trying to resize to a size larger than the maximal size"); uint32_t old_size = node().Size(); if (new_size < old_size) { fillDataWithZeroesFromTo(new_size, old_size); } node().setSize(new_size); } void DataLeafNode::fillDataWithZeroesFromTo(off_t begin, off_t end) { Data ZEROES(end-begin); ZEROES.FillWithZeroes(); node().write(ZEROES.data(), begin, end-begin); } uint64_t DataLeafNode::maxStoreableBytes() const { return node().layout().maxBytesPerLeaf(); } } } } src/blobstore/implementations/onblocks/datanodestore/DataLeafNode.h000066400000000000000000000017301300002025200261170ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATANODESTORE_DATALEAFNODE_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATANODESTORE_DATALEAFNODE_H_ #include "DataNode.h" namespace blobstore { namespace onblocks { namespace datanodestore { class DataInnerNode; class DataLeafNode final: public DataNode { public: static cpputils::unique_ref InitializeNewNode(cpputils::unique_ref block); DataLeafNode(DataNodeView block); ~DataLeafNode(); //Returning uint64_t, because calculations handling this probably need to be done in 64bit to support >4GB blobs. uint64_t maxStoreableBytes() const; void read(void *target, uint64_t offset, uint64_t size) const; void write(const void *source, uint64_t offset, uint64_t size); uint32_t numBytes() const; void resize(uint32_t size); private: void fillDataWithZeroesFromTo(off_t begin, off_t end); DISALLOW_COPY_AND_ASSIGN(DataLeafNode); }; } } } #endif src/blobstore/implementations/onblocks/datanodestore/DataNode.cpp000066400000000000000000000021641300002025200256640ustar00rootroot00000000000000#include "DataInnerNode.h" #include "DataLeafNode.h" #include "DataNode.h" #include "DataNodeStore.h" #include using blockstore::Block; using blockstore::Key; using std::runtime_error; using cpputils::unique_ref; namespace blobstore { namespace onblocks { namespace datanodestore { constexpr uint16_t DataNode::FORMAT_VERSION_HEADER; DataNode::DataNode(DataNodeView node) : _node(std::move(node)) { } DataNode::~DataNode() { } DataNodeView &DataNode::node() { return const_cast(const_cast(this)->node()); } const DataNodeView &DataNode::node() const { return _node; } const Key &DataNode::key() const { return _node.key(); } uint8_t DataNode::depth() const { return _node.Depth(); } unique_ref DataNode::convertToNewInnerNode(unique_ref node, const DataNode &first_child) { Key key = node->key(); auto block = node->_node.releaseBlock(); blockstore::utils::fillWithZeroes(block.get()); return DataInnerNode::InitializeNewNode(std::move(block), first_child); } void DataNode::flush() const { _node.flush(); } } } } src/blobstore/implementations/onblocks/datanodestore/DataNode.h000066400000000000000000000017231300002025200253310ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATANODESTORE_DATANODE_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATANODESTORE_DATANODE_H_ #include "DataNodeView.h" #include namespace blobstore { namespace onblocks { namespace datanodestore { class DataNodeStore; class DataInnerNode; class DataNode { public: virtual ~DataNode(); const blockstore::Key &key() const; uint8_t depth() const; static cpputils::unique_ref convertToNewInnerNode(cpputils::unique_ref node, const DataNode &first_child); void flush() const; protected: // The FORMAT_VERSION_HEADER is used to allow future versions to have compatibility. static constexpr uint16_t FORMAT_VERSION_HEADER = 0; DataNode(DataNodeView block); DataNodeView &node(); const DataNodeView &node() const; friend class DataNodeStore; private: DataNodeView _node; DISALLOW_COPY_AND_ASSIGN(DataNode); }; } } } #endif src/blobstore/implementations/onblocks/datanodestore/DataNodeStore.cpp000066400000000000000000000107651300002025200267070ustar00rootroot00000000000000#include "DataInnerNode.h" #include "DataLeafNode.h" #include "DataNodeStore.h" #include #include #include #include using blockstore::BlockStore; using blockstore::Block; using blockstore::Key; using cpputils::Data; using cpputils::unique_ref; using cpputils::make_unique_ref; using std::runtime_error; using boost::optional; using boost::none; namespace blobstore { namespace onblocks { namespace datanodestore { DataNodeStore::DataNodeStore(unique_ref blockstore, uint64_t physicalBlocksizeBytes) : _blockstore(std::move(blockstore)), _layout(_blockstore->blockSizeFromPhysicalBlockSize(physicalBlocksizeBytes)) { } DataNodeStore::~DataNodeStore() { } unique_ref DataNodeStore::load(unique_ref block) { ASSERT(block->size() == _layout.blocksizeBytes(), "Loading block of wrong size"); DataNodeView node(std::move(block)); if (node.Depth() == 0) { return make_unique_ref(std::move(node)); } else if (node.Depth() <= MAX_DEPTH) { return make_unique_ref(std::move(node)); } else { throw runtime_error("Tree is to deep. Data corruption?"); } } unique_ref DataNodeStore::createNewInnerNode(const DataNode &first_child) { ASSERT(first_child.node().layout().blocksizeBytes() == _layout.blocksizeBytes(), "Source node has wrong layout. Is it from the same DataNodeStore?"); //TODO Initialize block and then create it in the blockstore - this is more efficient than creating it and then writing to it auto block = _blockstore->create(Data(_layout.blocksizeBytes()).FillWithZeroes()); return DataInnerNode::InitializeNewNode(std::move(block), first_child); } unique_ref DataNodeStore::createNewLeafNode() { //TODO Initialize block and then create it in the blockstore - this is more efficient than creating it and then writing to it auto block = _blockstore->create(Data(_layout.blocksizeBytes()).FillWithZeroes()); return DataLeafNode::InitializeNewNode(std::move(block)); } optional> DataNodeStore::load(const Key &key) { auto block = _blockstore->load(key); if (block == none) { return none; } else { return load(std::move(*block)); } } unique_ref DataNodeStore::createNewNodeAsCopyFrom(const DataNode &source) { ASSERT(source.node().layout().blocksizeBytes() == _layout.blocksizeBytes(), "Source node has wrong layout. Is it from the same DataNodeStore?"); auto newBlock = blockstore::utils::copyToNewBlock(_blockstore.get(), source.node().block()); return load(std::move(newBlock)); } unique_ref DataNodeStore::overwriteNodeWith(unique_ref target, const DataNode &source) { ASSERT(target->node().layout().blocksizeBytes() == _layout.blocksizeBytes(), "Target node has wrong layout. Is it from the same DataNodeStore?"); ASSERT(source.node().layout().blocksizeBytes() == _layout.blocksizeBytes(), "Source node has wrong layout. Is it from the same DataNodeStore?"); Key key = target->key(); { auto targetBlock = target->node().releaseBlock(); cpputils::destruct(std::move(target)); // Call destructor blockstore::utils::copyTo(targetBlock.get(), source.node().block()); } auto loaded = load(key); ASSERT(loaded != none, "Couldn't load the target node after overwriting it"); return std::move(*loaded); } void DataNodeStore::remove(unique_ref node) { auto block = node->node().releaseBlock(); cpputils::destruct(std::move(node)); // Call destructor _blockstore->remove(std::move(block)); } uint64_t DataNodeStore::numNodes() const { return _blockstore->numBlocks(); } uint64_t DataNodeStore::estimateSpaceForNumNodesLeft() const { return _blockstore->estimateNumFreeBytes() / _layout.blocksizeBytes(); } uint64_t DataNodeStore::virtualBlocksizeBytes() const { return _layout.blocksizeBytes(); } void DataNodeStore::removeSubtree(unique_ref node) { //TODO Make this faster by not loading the leaves but just deleting them. Can be recognized, because of the depth of their parents. DataInnerNode *inner = dynamic_cast(node.get()); if (inner != nullptr) { for (uint32_t i = 0; i < inner->numChildren(); ++i) { auto child = load(inner->getChild(i)->key()); ASSERT(child != none, "Couldn't load child node"); removeSubtree(std::move(*child)); } } remove(std::move(node)); } DataNodeLayout DataNodeStore::layout() const { return _layout; } } } } src/blobstore/implementations/onblocks/datanodestore/DataNodeStore.h000066400000000000000000000033521300002025200263460ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATANODESTORE_DATANODESTORE_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATANODESTORE_DATANODESTORE_H_ #include #include #include "DataNodeView.h" #include namespace blockstore{ class Block; class BlockStore; } namespace blobstore { namespace onblocks { namespace datanodestore { class DataNode; class DataLeafNode; class DataInnerNode; class DataNodeStore final { public: DataNodeStore(cpputils::unique_ref blockstore, uint64_t physicalBlocksizeBytes); ~DataNodeStore(); static constexpr uint8_t MAX_DEPTH = 10; DataNodeLayout layout() const; boost::optional> load(const blockstore::Key &key); cpputils::unique_ref createNewLeafNode(); cpputils::unique_ref createNewInnerNode(const DataNode &first_child); cpputils::unique_ref createNewNodeAsCopyFrom(const DataNode &source); cpputils::unique_ref overwriteNodeWith(cpputils::unique_ref target, const DataNode &source); void remove(cpputils::unique_ref node); void removeSubtree(cpputils::unique_ref node); //TODO Test blocksizeBytes/numBlocks/estimateSpaceForNumBlocksLeft uint64_t virtualBlocksizeBytes() const; uint64_t numNodes() const; uint64_t estimateSpaceForNumNodesLeft() const; //TODO Test overwriteNodeWith(), createNodeAsCopyFrom(), removeSubtree() private: cpputils::unique_ref load(cpputils::unique_ref block); cpputils::unique_ref _blockstore; const DataNodeLayout _layout; DISALLOW_COPY_AND_ASSIGN(DataNodeStore); }; } } } #endif src/blobstore/implementations/onblocks/datanodestore/DataNodeView.h000066400000000000000000000100541300002025200261610ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATANODESTORE_DATANODEVIEW_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATANODESTORE_DATANODEVIEW_H_ #include #include "../BlobStoreOnBlocks.h" #include "DataInnerNode_ChildEntry.h" #include #include #include #include namespace blobstore { namespace onblocks { namespace datanodestore { //TODO Move DataNodeLayout into own file class DataNodeLayout final { public: constexpr DataNodeLayout(uint64_t blocksizeBytes) :_blocksizeBytes( (HEADERSIZE_BYTES + 2*sizeof(DataInnerNode_ChildEntry) <= blocksizeBytes) ? blocksizeBytes : throw std::logic_error("Blocksize too small, not enough space to store two children in an inner node")) { } //Total size of the header static constexpr uint32_t HEADERSIZE_BYTES = 8; //Where in the header is the format version field (used to allow compatibility with future versions of CryFS) static constexpr uint32_t FORMAT_VERSION_OFFSET_BYTES = 0; //format version uses 2 bytes //Where in the header is the depth field static constexpr uint32_t DEPTH_OFFSET_BYTES = 3; // depth uses 1 byte //Where in the header is the size field (for inner nodes: number of children, for leafs: content data size) static constexpr uint32_t SIZE_OFFSET_BYTES = 4; // size uses 4 bytes //Size of a block (header + data region) constexpr uint64_t blocksizeBytes() const { return _blocksizeBytes; } //Number of bytes in the data region of a node constexpr uint64_t datasizeBytes() const { return _blocksizeBytes - HEADERSIZE_BYTES; } //Maximum number of children an inner node can store constexpr uint64_t maxChildrenPerInnerNode() const { return datasizeBytes() / sizeof(DataInnerNode_ChildEntry); } //Maximum number of bytes a leaf can store constexpr uint64_t maxBytesPerLeaf() const { return datasizeBytes(); } private: uint32_t _blocksizeBytes; }; class DataNodeView final { public: DataNodeView(cpputils::unique_ref block): _block(std::move(block)) { } ~DataNodeView() {} DataNodeView(DataNodeView &&rhs) = default; uint16_t FormatVersion() const { return *((uint8_t*)_block->data()+DataNodeLayout::FORMAT_VERSION_OFFSET_BYTES); } void setFormatVersion(uint16_t value) { _block->write(&value, DataNodeLayout::FORMAT_VERSION_OFFSET_BYTES, sizeof(value)); } uint8_t Depth() const { return *((uint8_t*)_block->data()+DataNodeLayout::DEPTH_OFFSET_BYTES); } void setDepth(uint8_t value) { _block->write(&value, DataNodeLayout::DEPTH_OFFSET_BYTES, sizeof(value)); } uint32_t Size() const { return *(uint32_t*)((uint8_t*)_block->data()+DataNodeLayout::SIZE_OFFSET_BYTES); } void setSize(uint32_t value) { _block->write(&value, DataNodeLayout::SIZE_OFFSET_BYTES, sizeof(value)); } const void *data() const { return (uint8_t*)_block->data() + DataNodeLayout::HEADERSIZE_BYTES; } void write(const void *source, uint64_t offset, uint64_t size) { _block->write(source, offset + DataNodeLayout::HEADERSIZE_BYTES, size); } template const Entry *DataBegin() const { return GetOffset(); } template const Entry *DataEnd() const { const unsigned int NUM_ENTRIES = layout().datasizeBytes() / sizeof(Entry); return DataBegin() + NUM_ENTRIES; } DataNodeLayout layout() const { return DataNodeLayout(_block->size()); } cpputils::unique_ref releaseBlock() { return std::move(_block); } const blockstore::Block &block() const { return *_block; } const blockstore::Key &key() const { return _block->key(); } void flush() const { _block->flush(); } private: template const Type *GetOffset() const { return (Type*)(((const int8_t*)_block->data())+offset); } cpputils::unique_ref _block; DISALLOW_COPY_AND_ASSIGN(DataNodeView); }; } } } #endif src/blobstore/implementations/onblocks/datatreestore/000077500000000000000000000000001300002025200235105ustar00rootroot00000000000000src/blobstore/implementations/onblocks/datatreestore/DataTree.cpp000066400000000000000000000326221300002025200257120ustar00rootroot00000000000000#include "DataTree.h" #include "../datanodestore/DataNodeStore.h" #include "../datanodestore/DataInnerNode.h" #include "../datanodestore/DataLeafNode.h" #include "../utils/Math.h" #include "impl/algorithms.h" #include #include #include #include using blockstore::Key; using blobstore::onblocks::datanodestore::DataNodeStore; using blobstore::onblocks::datanodestore::DataNode; using blobstore::onblocks::datanodestore::DataInnerNode; using blobstore::onblocks::datanodestore::DataLeafNode; using blobstore::onblocks::datanodestore::DataNodeLayout; using std::dynamic_pointer_cast; using std::function; using boost::shared_mutex; using boost::shared_lock; using boost::unique_lock; using boost::none; using std::vector; using cpputils::dynamic_pointer_move; using cpputils::optional_ownership_ptr; using cpputils::WithOwnership; using cpputils::WithoutOwnership; using cpputils::unique_ref; namespace blobstore { namespace onblocks { namespace datatreestore { DataTree::DataTree(DataNodeStore *nodeStore, unique_ref rootNode) : _mutex(), _nodeStore(nodeStore), _rootNode(std::move(rootNode)) { } DataTree::~DataTree() { } void DataTree::removeLastDataLeaf() { auto deletePosOrNull = algorithms::GetLowestRightBorderNodeWithMoreThanOneChildOrNull(_nodeStore, _rootNode.get()); ASSERT(deletePosOrNull.get() != nullptr, "Tree has only one leaf, can't shrink it."); deleteLastChildSubtree(deletePosOrNull.get()); ifRootHasOnlyOneChildReplaceRootWithItsChild(); } void DataTree::ifRootHasOnlyOneChildReplaceRootWithItsChild() { DataInnerNode *rootNode = dynamic_cast(_rootNode.get()); ASSERT(rootNode != nullptr, "RootNode is not an inner node"); if (rootNode->numChildren() == 1) { auto child = _nodeStore->load(rootNode->getChild(0)->key()); ASSERT(child != none, "Couldn't load first child of root node"); _rootNode = _nodeStore->overwriteNodeWith(std::move(_rootNode), **child); _nodeStore->remove(std::move(*child)); } } void DataTree::deleteLastChildSubtree(DataInnerNode *node) { auto lastChild = _nodeStore->load(node->LastChild()->key()); ASSERT(lastChild != none, "Couldn't load last child"); _nodeStore->removeSubtree(std::move(*lastChild)); node->removeLastChild(); } unique_ref DataTree::addDataLeaf() { auto insertPosOrNull = algorithms::GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNull(_nodeStore, _rootNode.get()); if (insertPosOrNull) { return addDataLeafAt(insertPosOrNull.get()); } else { return addDataLeafToFullTree(); } } unique_ref DataTree::addDataLeafAt(DataInnerNode *insertPos) { auto new_leaf = _nodeStore->createNewLeafNode(); auto chain = createChainOfInnerNodes(insertPos->depth()-1, new_leaf.get()); insertPos->addChild(*chain); return new_leaf; } optional_ownership_ptr DataTree::createChainOfInnerNodes(unsigned int num, DataNode *child) { //TODO This function is implemented twice, once with optional_ownership_ptr, once with unique_ref. Redundancy! optional_ownership_ptr chain = cpputils::WithoutOwnership(child); for(unsigned int i=0; icreateNewInnerNode(*chain); chain = cpputils::WithOwnership(std::move(newnode)); } return chain; } unique_ref DataTree::createChainOfInnerNodes(unsigned int num, unique_ref child) { unique_ref chain = std::move(child); for(unsigned int i=0; icreateNewInnerNode(*chain); } return chain; } DataInnerNode* DataTree::increaseTreeDepth(unsigned int levels) { ASSERT(levels >= 1, "Parameter out of bounds: tried to increase tree depth by zero."); auto copyOfOldRoot = _nodeStore->createNewNodeAsCopyFrom(*_rootNode); auto chain = createChainOfInnerNodes(levels-1, copyOfOldRoot.get()); auto newRootNode = DataNode::convertToNewInnerNode(std::move(_rootNode), *chain); DataInnerNode *result = newRootNode.get(); _rootNode = std::move(newRootNode); return result; } unique_ref DataTree::addDataLeafToFullTree() { DataInnerNode *rootNode = increaseTreeDepth(1); auto newLeaf = addDataLeafAt(rootNode); return newLeaf; } const Key &DataTree::key() const { return _rootNode->key(); } void DataTree::flush() const { // By grabbing a lock, we ensure that all modifying functions don't run currently and are therefore flushed unique_lock lock(_mutex); // We also have to flush the root node _rootNode->flush(); } unique_ref DataTree::releaseRootNode() { return std::move(_rootNode); } //TODO Test numLeaves(), for example also two configurations with same number of bytes but different number of leaves (last leaf has 0 bytes) uint32_t DataTree::numLeaves() const { shared_lock lock(_mutex); return _numLeaves(*_rootNode); } uint32_t DataTree::_numLeaves(const DataNode &node) const { const DataLeafNode *leaf = dynamic_cast(&node); if (leaf != nullptr) { return 1; } const DataInnerNode &inner = dynamic_cast(node); uint64_t numLeavesInLeftChildren = (uint64_t)(inner.numChildren()-1) * leavesPerFullChild(inner); auto lastChild = _nodeStore->load(inner.LastChild()->key()); ASSERT(lastChild != none, "Couldn't load last child"); uint64_t numLeavesInRightChild = _numLeaves(**lastChild); return numLeavesInLeftChildren + numLeavesInRightChild; } void DataTree::traverseLeaves(uint32_t beginIndex, uint32_t endIndex, function func) { //TODO Can we traverse in parallel? unique_lock lock(_mutex); //TODO Only lock when resizing. Otherwise parallel read/write to a blob is not possible! ASSERT(beginIndex <= endIndex, "Invalid parameters"); if (0 == endIndex) { // In this case the utils::ceilLog(_, endIndex) below would fail return; } uint8_t neededTreeDepth = utils::ceilLog(_nodeStore->layout().maxChildrenPerInnerNode(), (uint64_t)endIndex); uint32_t numLeaves = this->_numLeaves(*_rootNode); // TODO Querying the size causes a tree traversal down to the leaves. Possible without querying the size? if (_rootNode->depth() < neededTreeDepth) { //TODO Test cases that actually increase it here by 0 level / 1 level / more than 1 level increaseTreeDepth(neededTreeDepth - _rootNode->depth()); } if (numLeaves <= beginIndex) { //TODO Test cases with numLeaves < / >= beginIndex // There is a gap between the current size and the begin of the traversal return _traverseLeaves(_rootNode.get(), 0, numLeaves-1, endIndex, [beginIndex, numLeaves, &func, this](DataLeafNode* node, uint32_t index) { if (index >= beginIndex) { func(node, index); } else if (index == numLeaves - 1) { // It is the old last leaf - resize it to maximum node->resize(_nodeStore->layout().maxBytesPerLeaf()); } }); } else if (numLeaves < endIndex) { // We are starting traversal in the valid region, but traverse until after it (we grow new leaves) return _traverseLeaves(_rootNode.get(), 0, beginIndex, endIndex, [numLeaves, &func, this] (DataLeafNode *node, uint32_t index) { if (index == numLeaves - 1) { // It is the old last leaf - resize it to maximum node->resize(_nodeStore->layout().maxBytesPerLeaf()); } func(node, index); }); } else { //We are traversing entirely inside the valid region _traverseLeaves(_rootNode.get(), 0, beginIndex, endIndex, func); } } void DataTree::_traverseLeaves(DataNode *root, uint32_t leafOffset, uint32_t beginIndex, uint32_t endIndex, function func) { DataLeafNode *leaf = dynamic_cast(root); if (leaf != nullptr) { ASSERT(beginIndex <= 1 && endIndex <= 1, "If root node is a leaf, the (sub)tree has only one leaf - access indices must be 0 or 1."); if (beginIndex == 0 && endIndex == 1) { func(leaf, leafOffset); } return; } DataInnerNode *inner = dynamic_cast(root); uint32_t leavesPerChild = leavesPerFullChild(*inner); uint32_t beginChild = beginIndex/leavesPerChild; uint32_t endChild = utils::ceilDivision(endIndex, leavesPerChild); vector> children = getOrCreateChildren(inner, beginChild, endChild); for (uint32_t childIndex = beginChild; childIndex < endChild; ++childIndex) { uint32_t childOffset = childIndex * leavesPerChild; uint32_t localBeginIndex = utils::maxZeroSubtraction(beginIndex, childOffset); uint32_t localEndIndex = std::min(leavesPerChild, endIndex - childOffset); auto child = std::move(children[childIndex-beginChild]); _traverseLeaves(child.get(), leafOffset + childOffset, localBeginIndex, localEndIndex, func); } } vector> DataTree::getOrCreateChildren(DataInnerNode *node, uint32_t begin, uint32_t end) { vector> children; children.reserve(end-begin); for (uint32_t childIndex = begin; childIndex < std::min(node->numChildren(), end); ++childIndex) { auto child = _nodeStore->load(node->getChild(childIndex)->key()); ASSERT(child != none, "Couldn't load child node"); children.emplace_back(std::move(*child)); } for (uint32_t childIndex = node->numChildren(); childIndex < end; ++childIndex) { //TODO This creates each child with one chain to one leaf only, and then on the next lower level it // has to create the children for the child. Would be faster to directly create full trees if necessary. children.emplace_back(addChildTo(node)); } ASSERT(children.size() == end-begin, "Number of children in the result is wrong"); return children; } unique_ref DataTree::addChildTo(DataInnerNode *node) { auto new_leaf = _nodeStore->createNewLeafNode(); new_leaf->resize(_nodeStore->layout().maxBytesPerLeaf()); auto chain = createChainOfInnerNodes(node->depth()-1, std::move(new_leaf)); node->addChild(*chain); return std::move(chain); } uint32_t DataTree::leavesPerFullChild(const DataInnerNode &root) const { return utils::intPow(_nodeStore->layout().maxChildrenPerInnerNode(), (uint64_t)root.depth()-1); } uint64_t DataTree::numStoredBytes() const { shared_lock lock(_mutex); return _numStoredBytes(); } uint64_t DataTree::_numStoredBytes() const { return _numStoredBytes(*_rootNode); } uint64_t DataTree::_numStoredBytes(const DataNode &root) const { const DataLeafNode *leaf = dynamic_cast(&root); if (leaf != nullptr) { return leaf->numBytes(); } const DataInnerNode &inner = dynamic_cast(root); uint64_t numBytesInLeftChildren = (inner.numChildren()-1) * leavesPerFullChild(inner) * _nodeStore->layout().maxBytesPerLeaf(); auto lastChild = _nodeStore->load(inner.LastChild()->key()); ASSERT(lastChild != none, "Couldn't load last child"); uint64_t numBytesInRightChild = _numStoredBytes(**lastChild); return numBytesInLeftChildren + numBytesInRightChild; } void DataTree::resizeNumBytes(uint64_t newNumBytes) { //TODO Can we resize in parallel? Especially creating new blocks (i.e. encrypting them) is expensive and should be done in parallel. boost::upgrade_lock lock(_mutex); { boost::upgrade_to_unique_lock exclusiveLock(lock); //TODO Faster implementation possible (no addDataLeaf()/removeLastDataLeaf() in a loop, but directly resizing) LastLeaf(_rootNode.get())->resize(_nodeStore->layout().maxBytesPerLeaf()); uint64_t currentNumBytes = _numStoredBytes(); ASSERT(currentNumBytes % _nodeStore->layout().maxBytesPerLeaf() == 0, "The last leaf is not a max data leaf, although we just resized it to be one."); uint32_t currentNumLeaves = currentNumBytes / _nodeStore->layout().maxBytesPerLeaf(); uint32_t newNumLeaves = std::max(UINT64_C(1), utils::ceilDivision(newNumBytes, _nodeStore->layout().maxBytesPerLeaf())); for(uint32_t i = currentNumLeaves; i < newNumLeaves; ++i) { addDataLeaf()->resize(_nodeStore->layout().maxBytesPerLeaf()); } for(uint32_t i = currentNumLeaves; i > newNumLeaves; --i) { removeLastDataLeaf(); } uint32_t newLastLeafSize = newNumBytes - (newNumLeaves-1)*_nodeStore->layout().maxBytesPerLeaf(); LastLeaf(_rootNode.get())->resize(newLastLeafSize); } ASSERT(newNumBytes == _numStoredBytes(), "We resized to the wrong number of bytes ("+std::to_string(numStoredBytes())+" instead of "+std::to_string(newNumBytes)+")"); } optional_ownership_ptr DataTree::LastLeaf(DataNode *root) { DataLeafNode *leaf = dynamic_cast(root); if (leaf != nullptr) { return WithoutOwnership(leaf); } DataInnerNode *inner = dynamic_cast(root); auto lastChild = _nodeStore->load(inner->LastChild()->key()); ASSERT(lastChild != none, "Couldn't load last child"); return WithOwnership(LastLeaf(std::move(*lastChild))); } unique_ref DataTree::LastLeaf(unique_ref root) { auto leaf = dynamic_pointer_move(root); if (leaf != none) { return std::move(*leaf); } auto inner = dynamic_pointer_move(root); ASSERT(inner != none, "Root node is neither a leaf nor an inner node"); auto child = _nodeStore->load((*inner)->LastChild()->key()); ASSERT(child != none, "Couldn't load last child"); return LastLeaf(std::move(*child)); } uint64_t DataTree::maxBytesPerLeaf() const { return _nodeStore->layout().maxBytesPerLeaf(); } } } } src/blobstore/implementations/onblocks/datatreestore/DataTree.h000066400000000000000000000064141300002025200253570ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATATREE_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATATREE_H_ #include #include #include #include "../datanodestore/DataNodeView.h" //TODO Replace with C++14 once std::shared_mutex is supported #include #include namespace blobstore { namespace onblocks { namespace datanodestore { class DataNodeStore; class DataInnerNode; class DataLeafNode; class DataNode; } namespace datatreestore { //TODO It is strange that DataLeafNode is still part in the public interface of DataTree. This should be separated somehow. class DataTree final { public: DataTree(datanodestore::DataNodeStore *nodeStore, cpputils::unique_ref rootNode); ~DataTree(); const blockstore::Key &key() const; //Returning uint64_t, because calculations handling this probably need to be done in 64bit to support >4GB blobs. uint64_t maxBytesPerLeaf() const; void traverseLeaves(uint32_t beginIndex, uint32_t endIndex, std::function func); void resizeNumBytes(uint64_t newNumBytes); uint32_t numLeaves() const; uint64_t numStoredBytes() const; void flush() const; private: mutable boost::shared_mutex _mutex; datanodestore::DataNodeStore *_nodeStore; cpputils::unique_ref _rootNode; cpputils::unique_ref addDataLeaf(); void removeLastDataLeaf(); cpputils::unique_ref releaseRootNode(); friend class DataTreeStore; cpputils::unique_ref addDataLeafAt(datanodestore::DataInnerNode *insertPos); cpputils::optional_ownership_ptr createChainOfInnerNodes(unsigned int num, datanodestore::DataNode *child); cpputils::unique_ref createChainOfInnerNodes(unsigned int num, cpputils::unique_ref child); cpputils::unique_ref addDataLeafToFullTree(); void deleteLastChildSubtree(datanodestore::DataInnerNode *node); void ifRootHasOnlyOneChildReplaceRootWithItsChild(); //TODO Use underscore for private methods void _traverseLeaves(datanodestore::DataNode *root, uint32_t leafOffset, uint32_t beginIndex, uint32_t endIndex, std::function func); uint32_t leavesPerFullChild(const datanodestore::DataInnerNode &root) const; uint64_t _numStoredBytes() const; uint64_t _numStoredBytes(const datanodestore::DataNode &root) const; uint32_t _numLeaves(const datanodestore::DataNode &node) const; cpputils::optional_ownership_ptr LastLeaf(datanodestore::DataNode *root); cpputils::unique_ref LastLeaf(cpputils::unique_ref root); datanodestore::DataInnerNode* increaseTreeDepth(unsigned int levels); std::vector> getOrCreateChildren(datanodestore::DataInnerNode *node, uint32_t begin, uint32_t end); cpputils::unique_ref addChildTo(datanodestore::DataInnerNode *node); DISALLOW_COPY_AND_ASSIGN(DataTree); }; } } } #endif src/blobstore/implementations/onblocks/datatreestore/DataTreeStore.cpp000066400000000000000000000022451300002025200267250ustar00rootroot00000000000000#include "DataTreeStore.h" #include "../datanodestore/DataNodeStore.h" #include "../datanodestore/DataLeafNode.h" #include "DataTree.h" using cpputils::unique_ref; using cpputils::make_unique_ref; using boost::optional; using boost::none; using blobstore::onblocks::datanodestore::DataNodeStore; using blobstore::onblocks::datanodestore::DataNode; namespace blobstore { namespace onblocks { namespace datatreestore { DataTreeStore::DataTreeStore(unique_ref nodeStore) : _nodeStore(std::move(nodeStore)) { } DataTreeStore::~DataTreeStore() { } optional> DataTreeStore::load(const blockstore::Key &key) { auto node = _nodeStore->load(key); if (node == none) { return none; } return make_unique_ref(_nodeStore.get(), std::move(*node)); } unique_ref DataTreeStore::createNewTree() { auto newleaf = _nodeStore->createNewLeafNode(); return make_unique_ref(_nodeStore.get(), std::move(newleaf)); } void DataTreeStore::remove(unique_ref tree) { auto root = tree->releaseRootNode(); cpputils::destruct(std::move(tree)); // Destruct tree _nodeStore->removeSubtree(std::move(root)); } } } } src/blobstore/implementations/onblocks/datatreestore/DataTreeStore.h000066400000000000000000000026441300002025200263750ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATATREESTORE_DATATREESTORE_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATATREESTORE_DATATREESTORE_H_ #include #include #include #include #include #include "../datanodestore/DataNodeStore.h" namespace blobstore { namespace onblocks { namespace datatreestore { class DataTree; class DataTreeStore final { public: DataTreeStore(cpputils::unique_ref nodeStore); ~DataTreeStore(); boost::optional> load(const blockstore::Key &key); cpputils::unique_ref createNewTree(); void remove(cpputils::unique_ref tree); //TODO Test blocksizeBytes/numBlocks/estimateSpaceForNumBlocksLeft uint64_t virtualBlocksizeBytes() const; uint64_t numNodes() const; uint64_t estimateSpaceForNumNodesLeft() const; private: cpputils::unique_ref _nodeStore; DISALLOW_COPY_AND_ASSIGN(DataTreeStore); }; inline uint64_t DataTreeStore::numNodes() const { return _nodeStore->numNodes(); } inline uint64_t DataTreeStore::estimateSpaceForNumNodesLeft() const { return _nodeStore->estimateSpaceForNumNodesLeft(); } inline uint64_t DataTreeStore::virtualBlocksizeBytes() const { return _nodeStore->virtualBlocksizeBytes(); } } } } #endif src/blobstore/implementations/onblocks/datatreestore/impl/000077500000000000000000000000001300002025200244515ustar00rootroot00000000000000src/blobstore/implementations/onblocks/datatreestore/impl/algorithms.cpp000066400000000000000000000054321300002025200273320ustar00rootroot00000000000000#include "algorithms.h" #include #include #include "../../datanodestore/DataInnerNode.h" #include "../../datanodestore/DataNodeStore.h" #include using std::function; using cpputils::optional_ownership_ptr; using cpputils::dynamic_pointer_move; using cpputils::unique_ref; using blobstore::onblocks::datanodestore::DataInnerNode; using blobstore::onblocks::datanodestore::DataNode; using blobstore::onblocks::datanodestore::DataNodeStore; using blockstore::Key; using boost::optional; using boost::none; namespace blobstore { namespace onblocks { namespace datatreestore { namespace algorithms { optional> getLastChildAsInnerNode(DataNodeStore *nodeStore, const DataInnerNode &node) { Key key = node.LastChild()->key(); auto lastChild = nodeStore->load(key); ASSERT(lastChild != none, "Couldn't load last child"); return dynamic_pointer_move(*lastChild); } //Returns the lowest right border node meeting the condition specified (exclusive the leaf). //Returns nullptr, if no inner right border node meets the condition. optional_ownership_ptr GetLowestInnerRightBorderNodeWithConditionOrNull(DataNodeStore *nodeStore, datanodestore::DataNode *rootNode, function condition) { optional_ownership_ptr currentNode = cpputils::WithoutOwnership(dynamic_cast(rootNode)); optional_ownership_ptr result = cpputils::null(); for (unsigned int i=0; i < rootNode->depth(); ++i) { //TODO This unnecessarily loads the leaf node in the last loop run auto lastChild = getLastChildAsInnerNode(nodeStore, *currentNode); if (condition(*currentNode)) { result = std::move(currentNode); } ASSERT(lastChild != none || static_cast(i) == rootNode->depth()-1, "Couldn't get last child as inner node but we're not deep enough yet for the last child to be a leaf"); if (lastChild != none) { currentNode = cpputils::WithOwnership(std::move(*lastChild)); } } return result; } optional_ownership_ptr GetLowestRightBorderNodeWithMoreThanOneChildOrNull(DataNodeStore *nodeStore, DataNode *rootNode) { return GetLowestInnerRightBorderNodeWithConditionOrNull(nodeStore, rootNode, [] (const datanodestore::DataInnerNode &node) { return node.numChildren() > 1; }); } optional_ownership_ptr GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNull(datanodestore::DataNodeStore *nodeStore, datanodestore::DataNode *rootNode) { return GetLowestInnerRightBorderNodeWithConditionOrNull(nodeStore, rootNode, [] (const datanodestore::DataInnerNode &node) { return node.numChildren() < node.maxStoreableChildren(); }); } } } } } src/blobstore/implementations/onblocks/datatreestore/impl/algorithms.h000066400000000000000000000023011300002025200267670ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATATREESTORE_IMPL_ALGORITHMS_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_DATATREESTORE_IMPL_ALGORITHMS_H_ #include namespace blobstore { namespace onblocks { namespace datanodestore{ class DataNode; class DataInnerNode; class DataNodeStore; } namespace datatreestore { namespace algorithms { //Returns the lowest right border node with at least two children. //Returns nullptr, if all right border nodes have only one child (since the root is a right border node, this means that the whole tree has exactly one leaf) cpputils::optional_ownership_ptr GetLowestRightBorderNodeWithMoreThanOneChildOrNull(datanodestore::DataNodeStore *nodeStore, datanodestore::DataNode *rootNode); //Returns the lowest right border node with less than k children (not considering leaves). //Returns nullptr, if all right border nodes have k children (the tree is full) cpputils::optional_ownership_ptr GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNull(datanodestore::DataNodeStore *nodeStore, datanodestore::DataNode *rootNode); } } } } #endif src/blobstore/implementations/onblocks/parallelaccessdatatreestore/000077500000000000000000000000001300002025200264075ustar00rootroot00000000000000src/blobstore/implementations/onblocks/parallelaccessdatatreestore/DataTreeRef.cpp000066400000000000000000000000311300002025200312330ustar00rootroot00000000000000#include "DataTreeRef.h" src/blobstore/implementations/onblocks/parallelaccessdatatreestore/DataTreeRef.h000066400000000000000000000025451300002025200307140ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_PARALLELACCESSDATATREESTORE_DATATREEREF_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_PARALLELACCESSDATATREESTORE_DATATREEREF_H_ #include #include "../datatreestore/DataTree.h" namespace blobstore { namespace onblocks { namespace parallelaccessdatatreestore { class DataTreeRef final: public parallelaccessstore::ParallelAccessStore::ResourceRefBase { public: DataTreeRef(datatreestore::DataTree *baseTree): _baseTree(baseTree) {} const blockstore::Key &key() const { return _baseTree->key(); } uint64_t maxBytesPerLeaf() const { return _baseTree->maxBytesPerLeaf(); } void traverseLeaves(uint32_t beginIndex, uint32_t endIndex, std::function func) { return _baseTree->traverseLeaves(beginIndex, endIndex, func); } uint32_t numLeaves() const { return _baseTree->numLeaves(); } void resizeNumBytes(uint64_t newNumBytes) { return _baseTree->resizeNumBytes(newNumBytes); } uint64_t numStoredBytes() const { return _baseTree->numStoredBytes(); } void flush() { return _baseTree->flush(); } private: datatreestore::DataTree *_baseTree; DISALLOW_COPY_AND_ASSIGN(DataTreeRef); }; } } } #endif src/blobstore/implementations/onblocks/parallelaccessdatatreestore/ParallelAccessDataTreeStore.cpp000066400000000000000000000026371300002025200344300ustar00rootroot00000000000000#include "DataTreeRef.h" #include "ParallelAccessDataTreeStore.h" #include "ParallelAccessDataTreeStoreAdapter.h" #include "../datanodestore/DataNodeStore.h" #include "../datanodestore/DataLeafNode.h" using cpputils::unique_ref; using cpputils::make_unique_ref; using boost::optional; using blobstore::onblocks::datatreestore::DataTreeStore; using blockstore::Key; namespace blobstore { namespace onblocks { using datatreestore::DataTreeStore; using datatreestore::DataTree; namespace parallelaccessdatatreestore { //TODO Here and for other stores (DataTreeStore, ...): Make small functions inline ParallelAccessDataTreeStore::ParallelAccessDataTreeStore(unique_ref dataTreeStore) : _dataTreeStore(std::move(dataTreeStore)), _parallelAccessStore(make_unique_ref(_dataTreeStore.get())) { } ParallelAccessDataTreeStore::~ParallelAccessDataTreeStore() { } optional> ParallelAccessDataTreeStore::load(const blockstore::Key &key) { return _parallelAccessStore.load(key); } unique_ref ParallelAccessDataTreeStore::createNewTree() { auto dataTree = _dataTreeStore->createNewTree(); Key key = dataTree->key(); return _parallelAccessStore.add(key, std::move(dataTree)); } void ParallelAccessDataTreeStore::remove(unique_ref tree) { Key key = tree->key(); return _parallelAccessStore.remove(key, std::move(tree)); } } } } src/blobstore/implementations/onblocks/parallelaccessdatatreestore/ParallelAccessDataTreeStore.h000066400000000000000000000033631300002025200340720ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_PARALLELACCESSDATATREESTORE_PARALLELACCESSDATATREESTORE_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_PARALLELACCESSDATATREESTORE_PARALLELACCESSDATATREESTORE_H_ #include #include #include #include #include "../datatreestore/DataTreeStore.h" namespace blobstore { namespace onblocks { namespace parallelaccessdatatreestore { class DataTreeRef; //TODO Test CachingDataTreeStore class ParallelAccessDataTreeStore final { public: ParallelAccessDataTreeStore(cpputils::unique_ref dataTreeStore); ~ParallelAccessDataTreeStore(); boost::optional> load(const blockstore::Key &key); cpputils::unique_ref createNewTree(); void remove(cpputils::unique_ref tree); //TODO Test blocksizeBytes/numBlocks/estimateSpaceForNumBlocksLeft uint64_t virtualBlocksizeBytes() const; uint64_t numNodes() const; uint64_t estimateSpaceForNumNodesLeft() const; private: cpputils::unique_ref _dataTreeStore; parallelaccessstore::ParallelAccessStore _parallelAccessStore; DISALLOW_COPY_AND_ASSIGN(ParallelAccessDataTreeStore); }; inline uint64_t ParallelAccessDataTreeStore::virtualBlocksizeBytes() const { return _dataTreeStore->virtualBlocksizeBytes(); } inline uint64_t ParallelAccessDataTreeStore::numNodes() const { return _dataTreeStore->numNodes(); } inline uint64_t ParallelAccessDataTreeStore::estimateSpaceForNumNodesLeft() const { return _dataTreeStore->estimateSpaceForNumNodesLeft(); } } } } #endif ParallelAccessDataTreeStoreAdapter.cpp000066400000000000000000000000601300002025200356360ustar00rootroot00000000000000src/blobstore/implementations/onblocks/parallelaccessdatatreestore#include "ParallelAccessDataTreeStoreAdapter.h" ParallelAccessDataTreeStoreAdapter.h000066400000000000000000000023641300002025200353140ustar00rootroot00000000000000src/blobstore/implementations/onblocks/parallelaccessdatatreestore#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_PARALLELACCESSDATATREESTORE_PARALLELACCESSDATATREESTOREADAPTER_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_PARALLELACCESSDATATREESTORE_PARALLELACCESSDATATREESTOREADAPTER_H_ #include #include #include "../datatreestore/DataTreeStore.h" #include "../datatreestore/DataTree.h" namespace blobstore { namespace onblocks { namespace parallelaccessdatatreestore { class ParallelAccessDataTreeStoreAdapter final: public parallelaccessstore::ParallelAccessBaseStore { public: ParallelAccessDataTreeStoreAdapter(datatreestore::DataTreeStore *baseDataTreeStore) :_baseDataTreeStore(std::move(baseDataTreeStore)) { } boost::optional> loadFromBaseStore(const blockstore::Key &key) override { return _baseDataTreeStore->load(key); } void removeFromBaseStore(cpputils::unique_ref dataTree) override { return _baseDataTreeStore->remove(std::move(dataTree)); } private: datatreestore::DataTreeStore *_baseDataTreeStore; DISALLOW_COPY_AND_ASSIGN(ParallelAccessDataTreeStoreAdapter); }; } } } #endif src/blobstore/implementations/onblocks/utils/000077500000000000000000000000001300002025200220025ustar00rootroot00000000000000src/blobstore/implementations/onblocks/utils/Math.cpp000066400000000000000000000000221300002025200233710ustar00rootroot00000000000000#include "Math.h" src/blobstore/implementations/onblocks/utils/Math.h000066400000000000000000000017151300002025200230500ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_UTILS_MATH_H_ #define MESSMER_BLOBSTORE_IMPLEMENTATIONS_ONBLOCKS_UTILS_MATH_H_ #include #include namespace blobstore { namespace onblocks { namespace utils { template inline INT_TYPE intPow(INT_TYPE base, INT_TYPE exponent) { INT_TYPE result = 1; for(INT_TYPE i = 0; i < exponent; ++i) { result *= base; } return result; } template inline INT_TYPE ceilDivision(INT_TYPE dividend, INT_TYPE divisor) { return (dividend + divisor - 1)/divisor; } template inline INT_TYPE maxZeroSubtraction(INT_TYPE minuend, INT_TYPE subtrahend) { if (minuend < subtrahend) { return 0u; } return minuend-subtrahend; } template inline INT_TYPE ceilLog(INT_TYPE base, INT_TYPE value) { return std::ceil((long double)std::log(value)/(long double)std::log(base)); } } } } #endif src/blobstore/interface/000077500000000000000000000000001300002025200155605ustar00rootroot00000000000000src/blobstore/interface/Blob.h000066400000000000000000000014421300002025200166100ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_INTERFACE_BLOB_H_ #define MESSMER_BLOBSTORE_INTERFACE_BLOB_H_ #include #include #include #include namespace blobstore { class Blob { public: virtual ~Blob() {} //TODO Use own Key class for blobstore virtual const blockstore::Key &key() const = 0; virtual uint64_t size() const = 0; virtual void resize(uint64_t numBytes) = 0; virtual cpputils::Data readAll() const = 0; virtual void read(void *target, uint64_t offset, uint64_t size) const = 0; virtual uint64_t tryRead(void *target, uint64_t offset, uint64_t size) const = 0; virtual void write(const void *source, uint64_t offset, uint64_t size) = 0; virtual void flush() = 0; //TODO Test tryRead }; } #endif src/blobstore/interface/BlobStore.h000066400000000000000000000017021300002025200176240ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_INTERFACE_BLOBSTORE_H_ #define MESSMER_BLOBSTORE_INTERFACE_BLOBSTORE_H_ #include "Blob.h" #include #include #include #include namespace blobstore { //TODO Remove this interface. We'll only use BlobStoreOnBlocks and never a different one. Rename BlobStoreOnBlocks to simply BlobStore. class BlobStore { public: virtual ~BlobStore() {} virtual cpputils::unique_ref create() = 0; virtual boost::optional> load(const blockstore::Key &key) = 0; virtual void remove(cpputils::unique_ref blob) = 0; virtual uint64_t numBlocks() const = 0; virtual uint64_t estimateSpaceForNumBlocksLeft() const = 0; //virtual means "space we can use" as opposed to "space it takes on the disk" (i.e. virtual is without headers, checksums, ...) virtual uint64_t virtualBlocksizeBytes() const = 0; }; } #endif src/blockstore/000077500000000000000000000000001300002025200137745ustar00rootroot00000000000000src/blockstore/CMakeLists.txt000066400000000000000000000027261300002025200165430ustar00rootroot00000000000000project (blockstore) set(SOURCES utils/Key.cpp utils/BlockStoreUtils.cpp utils/FileDoesntExistException.cpp interface/helpers/BlockStoreWithRandomKeys.cpp implementations/testfake/FakeBlockStore.cpp implementations/testfake/FakeBlock.cpp implementations/inmemory/InMemoryBlock.cpp implementations/inmemory/InMemoryBlockStore.cpp implementations/parallelaccess/ParallelAccessBlockStore.cpp implementations/parallelaccess/BlockRef.cpp implementations/parallelaccess/ParallelAccessBlockStoreAdapter.cpp implementations/compressing/CompressingBlockStore.cpp implementations/compressing/CompressedBlock.cpp implementations/compressing/compressors/RunLengthEncoding.cpp implementations/compressing/compressors/Gzip.cpp implementations/encrypted/EncryptedBlockStore.cpp implementations/encrypted/EncryptedBlock.cpp implementations/ondisk/OnDiskBlockStore.cpp implementations/ondisk/OnDiskBlock.cpp implementations/caching/CachingBlockStore.cpp implementations/caching/cache/PeriodicTask.cpp implementations/caching/cache/CacheEntry.cpp implementations/caching/cache/Cache.cpp implementations/caching/cache/QueueMap.cpp implementations/caching/CachedBlock.cpp implementations/caching/NewBlock.cpp ) add_library(${PROJECT_NAME} STATIC ${SOURCES}) target_link_libraries(${PROJECT_NAME} PUBLIC cpp-utils) target_add_boost(${PROJECT_NAME} filesystem system thread) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) src/blockstore/implementations/000077500000000000000000000000001300002025200172045ustar00rootroot00000000000000src/blockstore/implementations/caching/000077500000000000000000000000001300002025200206005ustar00rootroot00000000000000src/blockstore/implementations/caching/CachedBlock.cpp000066400000000000000000000016611300002025200234320ustar00rootroot00000000000000#include "CachedBlock.h" #include "CachingBlockStore.h" using cpputils::unique_ref; namespace blockstore { namespace caching { CachedBlock::CachedBlock(unique_ref baseBlock, CachingBlockStore *blockStore) :Block(baseBlock->key()), _blockStore(blockStore), _baseBlock(std::move(baseBlock)) { } CachedBlock::~CachedBlock() { if (_baseBlock.get() != nullptr) { _blockStore->release(std::move(_baseBlock)); } } const void *CachedBlock::data() const { return _baseBlock->data(); } void CachedBlock::write(const void *source, uint64_t offset, uint64_t size) { return _baseBlock->write(source, offset, size); } void CachedBlock::flush() { return _baseBlock->flush(); } size_t CachedBlock::size() const { return _baseBlock->size(); } void CachedBlock::resize(size_t newSize) { return _baseBlock->resize(newSize); } unique_ref CachedBlock::releaseBlock() { return std::move(_baseBlock); } } } src/blockstore/implementations/caching/CachedBlock.h000066400000000000000000000016551300002025200231020ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_CACHEDBLOCK_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_CACHEDBLOCK_H_ #include "../../interface/Block.h" #include namespace blockstore { namespace caching { class CachingBlockStore; class CachedBlock final: public Block { public: //TODO Storing key twice (in parent class and in object pointed to). Once would be enough. CachedBlock(cpputils::unique_ref baseBlock, CachingBlockStore *blockStore); ~CachedBlock(); const void *data() const override; void write(const void *source, uint64_t offset, uint64_t size) override; void flush() override; size_t size() const override; void resize(size_t newSize) override; cpputils::unique_ref releaseBlock(); private: CachingBlockStore *_blockStore; cpputils::unique_ref _baseBlock; DISALLOW_COPY_AND_ASSIGN(CachedBlock); }; } } #endif src/blockstore/implementations/caching/CachingBlockStore.cpp000066400000000000000000000061331300002025200246330ustar00rootroot00000000000000#include "CachedBlock.h" #include "NewBlock.h" #include "CachingBlockStore.h" #include "../../interface/Block.h" #include #include #include using cpputils::dynamic_pointer_move; using cpputils::Data; using boost::optional; using cpputils::unique_ref; using cpputils::make_unique_ref; using boost::none; namespace blockstore { namespace caching { CachingBlockStore::CachingBlockStore(cpputils::unique_ref baseBlockStore) :_baseBlockStore(std::move(baseBlockStore)), _cache(), _numNewBlocks(0) { } Key CachingBlockStore::createKey() { return _baseBlockStore->createKey(); } optional> CachingBlockStore::tryCreate(const Key &key, Data data) { ASSERT(_cache.pop(key) == none, "Key already exists in cache"); //TODO Shouldn't we return boost::none if the key already exists? //TODO Key can also already exist but not be in the cache right now. ++_numNewBlocks; return unique_ref(make_unique_ref(make_unique_ref(key, std::move(data), this), this)); } optional> CachingBlockStore::load(const Key &key) { optional> optBlock = _cache.pop(key); //TODO an optional<> class with .getOrElse() would make this code simpler. boost::optional<>::value_or_eval didn't seem to work with unique_ptr members. if (optBlock != none) { return optional>(make_unique_ref(std::move(*optBlock), this)); } else { auto block = _baseBlockStore->load(key); if (block == none) { return none; } else { return optional>(make_unique_ref(std::move(*block), this)); } } } void CachingBlockStore::remove(cpputils::unique_ref block) { auto cached_block = dynamic_pointer_move(block); ASSERT(cached_block != none, "Passed block is not a CachedBlock"); auto baseBlock = (*cached_block)->releaseBlock(); auto baseNewBlock = dynamic_pointer_move(baseBlock); if (baseNewBlock != none) { if(!(*baseNewBlock)->alreadyExistsInBaseStore()) { --_numNewBlocks; } (*baseNewBlock)->remove(); } else { _baseBlockStore->remove(std::move(baseBlock)); } } uint64_t CachingBlockStore::numBlocks() const { return _baseBlockStore->numBlocks() + _numNewBlocks; } uint64_t CachingBlockStore::estimateNumFreeBytes() const { return _baseBlockStore->estimateNumFreeBytes(); } void CachingBlockStore::release(unique_ref block) { Key key = block->key(); _cache.push(key, std::move(block)); } optional> CachingBlockStore::tryCreateInBaseStore(const Key &key, Data data) { auto block = _baseBlockStore->tryCreate(key, std::move(data)); if (block != none) { --_numNewBlocks; } return block; } void CachingBlockStore::removeFromBaseStore(cpputils::unique_ref block) { _baseBlockStore->remove(std::move(block)); } void CachingBlockStore::flush() { _cache.flush(); } uint64_t CachingBlockStore::blockSizeFromPhysicalBlockSize(uint64_t blockSize) const { return _baseBlockStore->blockSizeFromPhysicalBlockSize(blockSize); } } } src/blockstore/implementations/caching/CachingBlockStore.h000066400000000000000000000026021300002025200242750ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_CACHINGBLOCKSTORE_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_CACHINGBLOCKSTORE_H_ #include "cache/Cache.h" #include "../../interface/BlockStore.h" namespace blockstore { namespace caching { //TODO Check that this blockstore allows parallel destructing of blocks (otherwise we won't encrypt blocks in parallel) class CachingBlockStore final: public BlockStore { public: explicit CachingBlockStore(cpputils::unique_ref baseBlockStore); Key createKey() override; boost::optional> tryCreate(const Key &key, cpputils::Data data) override; boost::optional> load(const Key &key) override; void remove(cpputils::unique_ref block) override; uint64_t numBlocks() const override; uint64_t estimateNumFreeBytes() const override; uint64_t blockSizeFromPhysicalBlockSize(uint64_t blockSize) const override; void release(cpputils::unique_ref block); boost::optional> tryCreateInBaseStore(const Key &key, cpputils::Data data); void removeFromBaseStore(cpputils::unique_ref block); void flush(); private: cpputils::unique_ref _baseBlockStore; Cache, 1000> _cache; uint32_t _numNewBlocks; DISALLOW_COPY_AND_ASSIGN(CachingBlockStore); }; } } #endif src/blockstore/implementations/caching/NewBlock.cpp000066400000000000000000000036321300002025200230140ustar00rootroot00000000000000#include "NewBlock.h" #include "CachingBlockStore.h" #include #include using cpputils::Data; using boost::none; namespace blockstore { namespace caching { NewBlock::NewBlock(const Key &key, Data data, CachingBlockStore *blockStore) :Block(key), _blockStore(blockStore), _data(std::move(data)), _baseBlock(none), _dataChanged(true) { } NewBlock::~NewBlock() { writeToBaseBlockIfChanged(); } const void *NewBlock::data() const { return _data.data(); } void NewBlock::write(const void *source, uint64_t offset, uint64_t size) { ASSERT(offset <= _data.size() && offset + size <= _data.size(), "Write outside of valid area"); std::memcpy((uint8_t*)_data.data()+offset, source, size); _dataChanged = true; } void NewBlock::writeToBaseBlockIfChanged() { if (_dataChanged) { if (_baseBlock == none) { //TODO _data.copy() necessary? auto newBase = _blockStore->tryCreateInBaseStore(key(), _data.copy()); ASSERT(newBase != boost::none, "Couldn't create base block"); //TODO What if tryCreate fails due to a duplicate key? We should ensure we don't use duplicate keys. _baseBlock = std::move(*newBase); } else { (*_baseBlock)->write(_data.data(), 0, _data.size()); } _dataChanged = false; } } void NewBlock::remove() { if (_baseBlock != none) { _blockStore->removeFromBaseStore(std::move(*_baseBlock)); } _dataChanged = false; } void NewBlock::flush() { writeToBaseBlockIfChanged(); ASSERT(_baseBlock != none, "At this point, the base block should already have been created but wasn't"); (*_baseBlock)->flush(); } size_t NewBlock::size() const { return _data.size(); } void NewBlock::resize(size_t newSize) { _data = cpputils::DataUtils::resize(std::move(_data), newSize); _dataChanged = true; } bool NewBlock::alreadyExistsInBaseStore() const { return _baseBlock != none; } } } src/blockstore/implementations/caching/NewBlock.h000066400000000000000000000026131300002025200224570ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_NEWBLOCK_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_NEWBLOCK_H_ #include "../../interface/BlockStore.h" #include #include #include namespace blockstore { namespace caching { class CachingBlockStore; //TODO Does it make sense to write a general DataBackedBlock that just stores a Data object and maps the block operations to it? // Can we reuse that object somewhere else? // Maybe a second abstract class for BlockRefBackedBlock? // This is a block that was created in CachingBlockStore, but doesn't exist in the base block store yet. // It only exists in the cache and it is created in the base block store when destructed. class NewBlock final: public Block { public: NewBlock(const Key &key, cpputils::Data data, CachingBlockStore *blockStore); ~NewBlock(); const void *data() const override; void write(const void *source, uint64_t offset, uint64_t size) override; void flush() override; size_t size() const override; void resize(size_t newSize) override; void remove(); bool alreadyExistsInBaseStore() const; private: CachingBlockStore *_blockStore; cpputils::Data _data; boost::optional> _baseBlock; bool _dataChanged; void writeToBaseBlockIfChanged(); DISALLOW_COPY_AND_ASSIGN(NewBlock); }; } } #endif src/blockstore/implementations/caching/cache/000077500000000000000000000000001300002025200216435ustar00rootroot00000000000000src/blockstore/implementations/caching/cache/Cache.cpp000066400000000000000000000000231300002025200233450ustar00rootroot00000000000000#include "Cache.h" src/blockstore/implementations/caching/cache/Cache.h000066400000000000000000000173251300002025200230270ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_CACHE_CACHE_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_CACHE_CACHE_H_ #include "CacheEntry.h" #include "QueueMap.h" #include "PeriodicTask.h" #include #include #include #include #include #include namespace blockstore { namespace caching { template class Cache final { public: //TODO Current MAX_LIFETIME_SEC only considers time since the element was last pushed to the Cache. Also insert a real MAX_LIFETIME_SEC that forces resync of entries that have been pushed/popped often (e.g. the root blob) //TODO Experiment with good values static constexpr double PURGE_LIFETIME_SEC = 0.5; //When an entry has this age, it will be purged from the cache static constexpr double PURGE_INTERVAL = 0.5; // With this interval, we check for entries to purge static constexpr double MAX_LIFETIME_SEC = PURGE_LIFETIME_SEC + PURGE_INTERVAL; // This is the oldest age an entry can reach (given purging works in an ideal world, i.e. with the ideal interval and in zero time) Cache(); ~Cache(); uint32_t size() const; void push(const Key &key, Value value); boost::optional pop(const Key &key); void flush(); private: void _makeSpaceForEntry(std::unique_lock *lock); void _deleteEntry(std::unique_lock *lock); void _deleteOldEntriesParallel(); void _deleteAllEntriesParallel(); void _deleteMatchingEntriesAtBeginningParallel(std::function &)> matches); void _deleteMatchingEntriesAtBeginning(std::function &)> matches); bool _deleteMatchingEntryAtBeginning(std::function &)> matches); mutable std::mutex _mutex; cpputils::LockPool _currentlyFlushingEntries; QueueMap> _cachedBlocks; std::unique_ptr _timeoutFlusher; DISALLOW_COPY_AND_ASSIGN(Cache); }; template constexpr double Cache::PURGE_LIFETIME_SEC; template constexpr double Cache::PURGE_INTERVAL; template constexpr double Cache::MAX_LIFETIME_SEC; template Cache::Cache(): _mutex(), _currentlyFlushingEntries(), _cachedBlocks(), _timeoutFlusher(nullptr) { //Don't initialize timeoutFlusher in the initializer list, //because it then might already call Cache::popOldEntries() before Cache is done constructing. _timeoutFlusher = std::make_unique(std::bind(&Cache::_deleteOldEntriesParallel, this), PURGE_INTERVAL); } template Cache::~Cache() { _deleteAllEntriesParallel(); ASSERT(_cachedBlocks.size() == 0, "Error in _deleteAllEntriesParallel()"); } template boost::optional Cache::pop(const Key &key) { std::unique_lock lock(_mutex); cpputils::MutexPoolLock lockEntryFromBeingPopped(&_currentlyFlushingEntries, key, &lock); auto found = _cachedBlocks.pop(key); if (!found) { return boost::none; } return found->releaseValue(); } template void Cache::push(const Key &key, Value value) { std::unique_lock lock(_mutex); ASSERT(_cachedBlocks.size() <= MAX_ENTRIES, "Cache too full"); _makeSpaceForEntry(&lock); _cachedBlocks.push(key, CacheEntry(std::move(value))); } template void Cache::_makeSpaceForEntry(std::unique_lock *lock) { // _deleteEntry releases the lock while the Value destructor is running. // So we can destruct multiple entries in parallel and also call pop() or push() while doing so. // However, if another thread calls push() before we get the lock back, the cache is full again. // That's why we need the while() loop here. while (_cachedBlocks.size() == MAX_ENTRIES) { _deleteEntry(lock); } ASSERT(_cachedBlocks.size() < MAX_ENTRIES, "Removing entry from cache didn't work"); }; template void Cache::_deleteEntry(std::unique_lock *lock) { ASSERT(lock->owns_lock(), "The operations in this function require a locked mutex"); auto key = _cachedBlocks.peekKey(); ASSERT(key != boost::none, "There was no entry to delete"); cpputils::MutexPoolLock lockEntryFromBeingPopped(&_currentlyFlushingEntries, *key); auto value = _cachedBlocks.pop(); // Call destructor outside of the unique_lock, // i.e. pop() and push() can be called here, except for pop() on the element in _currentlyFlushingEntries lock->unlock(); value = boost::none; // Call destructor lockEntryFromBeingPopped.unlock(); // unlock this one first to keep same locking oder (preventing potential deadlock) lock->lock(); }; template void Cache::_deleteAllEntriesParallel() { return _deleteMatchingEntriesAtBeginningParallel([] (const CacheEntry &) { return true; }); } template void Cache::_deleteOldEntriesParallel() { return _deleteMatchingEntriesAtBeginningParallel([] (const CacheEntry &entry) { return entry.ageSeconds() > PURGE_LIFETIME_SEC; }); } template void Cache::_deleteMatchingEntriesAtBeginningParallel(std::function &)> matches) { // Twice the number of cores, so we use full CPU even if half the threads are doing I/O unsigned int numThreads = 2 * std::max(1u, std::thread::hardware_concurrency()); std::vector> waitHandles; for (unsigned int i = 0; i < numThreads; ++i) { waitHandles.push_back(std::async(std::launch::async, [this, matches] { _deleteMatchingEntriesAtBeginning(matches); })); } for (auto & waitHandle : waitHandles) { waitHandle.wait(); } }; template void Cache::_deleteMatchingEntriesAtBeginning(std::function &)> matches) { while (_deleteMatchingEntryAtBeginning(matches)) {} } template bool Cache::_deleteMatchingEntryAtBeginning(std::function &)> matches) { // This function can be called in parallel by multiple threads and will then cause the Value destructors // to be called in parallel. The call to _deleteEntry() releases the lock while the Value destructor is running. std::unique_lock lock(_mutex); if (_cachedBlocks.size() > 0 && matches(*_cachedBlocks.peek())) { _deleteEntry(&lock); ASSERT(lock.owns_lock(), "Something strange happened with the lock. It should be locked again when we come back."); return true; } else { return false; } }; template uint32_t Cache::size() const { std::unique_lock lock(_mutex); return _cachedBlocks.size(); }; template void Cache::flush() { //TODO Test flush() return _deleteAllEntriesParallel(); }; } } #endif src/blockstore/implementations/caching/cache/CacheEntry.cpp000066400000000000000000000000301300002025200243650ustar00rootroot00000000000000#include "CacheEntry.h" src/blockstore/implementations/caching/cache/CacheEntry.h000066400000000000000000000016701300002025200240450ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_CACHE_CACHEENTRY_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_CACHE_CACHEENTRY_H_ #include #include #include #include namespace blockstore { namespace caching { template class CacheEntry final { public: explicit CacheEntry(Value value): _lastAccess(currentTime()), _value(std::move(value)) { } CacheEntry(CacheEntry &&) = default; double ageSeconds() const { return ((double)(currentTime() - _lastAccess).total_nanoseconds()) / ((double)1000000000); } Value releaseValue() { return std::move(_value); } private: boost::posix_time::ptime _lastAccess; Value _value; static boost::posix_time::ptime currentTime() { return boost::posix_time::microsec_clock::local_time(); } DISALLOW_COPY_AND_ASSIGN(CacheEntry); }; } } #endif src/blockstore/implementations/caching/cache/PeriodicTask.cpp000066400000000000000000000014221300002025200247270ustar00rootroot00000000000000#include "PeriodicTask.h" #include using std::function; using std::endl; using namespace cpputils::logging; namespace blockstore { namespace caching { PeriodicTask::PeriodicTask(function task, double intervalSec) : _task(task), _interval((uint64_t)(UINT64_C(1000000000) * intervalSec)), _thread(std::bind(&PeriodicTask::_loopIteration, this)) { _thread.start(); } bool PeriodicTask::_loopIteration() { //Has to be boost::this_thread::sleep_for and not std::this_thread::sleep_for, because it has to be interruptible. //LoopThread will interrupt this method if it has to be restarted. boost::this_thread::sleep_for(_interval); _task(); return true; // Run another iteration (don't terminate thread) } } } src/blockstore/implementations/caching/cache/PeriodicTask.h000066400000000000000000000013531300002025200243770ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_CACHE_PERIODICTASK_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_CACHE_PERIODICTASK_H_ #include #include #include namespace blockstore { namespace caching { class PeriodicTask final { public: PeriodicTask(std::function task, double intervalSec); private: bool _loopIteration(); std::function _task; boost::chrono::nanoseconds _interval; //This member has to be last, so the thread is destructed first. Otherwise the thread might access elements from a //partly destructed PeriodicTask. cpputils::LoopThread _thread; DISALLOW_COPY_AND_ASSIGN(PeriodicTask); }; } } #endif src/blockstore/implementations/caching/cache/QueueMap.cpp000066400000000000000000000000261300002025200240670ustar00rootroot00000000000000#include "QueueMap.h" src/blockstore/implementations/caching/cache/QueueMap.h000066400000000000000000000065031300002025200235420ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_CACHE_QUEUEMAP_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_CACHING_CACHE_QUEUEMAP_H_ #include #include #include #include #include #include namespace blockstore { namespace caching { //TODO FreeList for performance (malloc is expensive) //TODO Single linked list with pointer to last element (for insertion) should be enough for a queue. No double linked list needed. // But then, popping arbitrary elements needs to be rewritten so that _removeFromQueue() is _removeSuccessorFromQueue() // and the map doesn't store the element itself, but its predecessor. That is, popping might be a bit slower. Test with experiments! // A class that is a queue and a map at the same time. We could also see it as an addressable queue. template class QueueMap final { public: QueueMap(): _entries(), _sentinel(&_sentinel, &_sentinel) { } ~QueueMap() { for (auto &entry : _entries) { entry.second.release(); } } void push(const Key &key, Value value) { auto newEntry = _entries.emplace(std::piecewise_construct, std::forward_as_tuple(key), std::forward_as_tuple(_sentinel.prev, &_sentinel)); if (!newEntry.second) { throw std::logic_error("There is already an element with this key"); } newEntry.first->second.init(&newEntry.first->first, std::move(value)); //The following is ok, because std::unordered_map never invalidates pointers to its entries _sentinel.prev->next = &newEntry.first->second; _sentinel.prev = &newEntry.first->second; } boost::optional pop(const Key &key) { auto found = _entries.find(key); if (found == _entries.end()) { return boost::none; } _removeFromQueue(found->second); auto value = found->second.release(); _entries.erase(found); return std::move(value); } boost::optional pop() { if(_sentinel.next == &_sentinel) { return boost::none; } return pop(*_sentinel.next->key); } boost::optional peekKey() { if(_sentinel.next == &_sentinel) { return boost::none; } return *_sentinel.next->key; } boost::optional peek() { if(_sentinel.next == &_sentinel) { return boost::none; } return _sentinel.next->value(); } uint32_t size() const { return _entries.size(); } private: class Entry final { public: Entry(Entry *prev_, Entry *next_): prev(prev_), next(next_), key(nullptr), __value() { } void init(const Key *key_, Value value_) { key = key_; new(__value) Value(std::move(value_)); } Value release() { Value value = std::move(*_value()); _value()->~Value(); return value; } const Value &value() { return *_value(); } Entry *prev; Entry *next; const Key *key; private: Value *_value() { return reinterpret_cast(__value); } alignas(Value) char __value[sizeof(Value)]; DISALLOW_COPY_AND_ASSIGN(Entry); }; void _removeFromQueue(const Entry &entry) { entry.prev->next = entry.next; entry.next->prev = entry.prev; } std::unordered_map _entries; Entry _sentinel; DISALLOW_COPY_AND_ASSIGN(QueueMap); }; } } #endif src/blockstore/implementations/compressing/000077500000000000000000000000001300002025200215355ustar00rootroot00000000000000src/blockstore/implementations/compressing/CompressedBlock.cpp000066400000000000000000000000351300002025200253160ustar00rootroot00000000000000#include "CompressedBlock.h" src/blockstore/implementations/compressing/CompressedBlock.h000066400000000000000000000101201300002025200247570ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_COMPRESSING_COMPRESSEDBLOCK_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_COMPRESSING_COMPRESSEDBLOCK_H_ #include "../../interface/Block.h" #include "../../interface/BlockStore.h" #include #include #include namespace blockstore { class BlockStore; namespace compressing { template class CompressingBlockStore; template class CompressedBlock final: public Block { public: static boost::optional> TryCreateNew(BlockStore *baseBlockStore, const Key &key, cpputils::Data decompressedData); static cpputils::unique_ref Decompress(cpputils::unique_ref baseBlock); CompressedBlock(cpputils::unique_ref baseBlock, cpputils::Data decompressedData); ~CompressedBlock(); const void *data() const override; void write(const void *source, uint64_t offset, uint64_t size) override; void flush() override; size_t size() const override; void resize(size_t newSize) override; cpputils::unique_ref releaseBaseBlock(); private: void _compressToBaseBlock(); cpputils::unique_ref _baseBlock; cpputils::Data _decompressedData; std::mutex _mutex; bool _dataChanged; DISALLOW_COPY_AND_ASSIGN(CompressedBlock); }; template boost::optional>> CompressedBlock::TryCreateNew(BlockStore *baseBlockStore, const Key &key, cpputils::Data decompressedData) { cpputils::Data compressed = Compressor::Compress(decompressedData); auto baseBlock = baseBlockStore->tryCreate(key, std::move(compressed)); if (baseBlock == boost::none) { //TODO Test this code branch return boost::none; } return cpputils::make_unique_ref>(std::move(*baseBlock), std::move(decompressedData)); } template cpputils::unique_ref> CompressedBlock::Decompress(cpputils::unique_ref baseBlock) { cpputils::Data decompressed = Compressor::Decompress((byte*)baseBlock->data(), baseBlock->size()); return cpputils::make_unique_ref>(std::move(baseBlock), std::move(decompressed)); } template CompressedBlock::CompressedBlock(cpputils::unique_ref baseBlock, cpputils::Data decompressedData) : Block(baseBlock->key()), _baseBlock(std::move(baseBlock)), _decompressedData(std::move(decompressedData)), _dataChanged(false) { } template CompressedBlock::~CompressedBlock() { std::unique_lock lock(_mutex); _compressToBaseBlock(); } template const void *CompressedBlock::data() const { return _decompressedData.data(); } template void CompressedBlock::write(const void *source, uint64_t offset, uint64_t size) { std::memcpy((uint8_t*)_decompressedData.dataOffset(offset), source, size); _dataChanged = true; } template void CompressedBlock::flush() { std::unique_lock lock(_mutex); _compressToBaseBlock(); return _baseBlock->flush(); } template size_t CompressedBlock::size() const { return _decompressedData.size(); } template void CompressedBlock::resize(size_t newSize) { _decompressedData = cpputils::DataUtils::resize(std::move(_decompressedData), newSize); _dataChanged = true; } template cpputils::unique_ref CompressedBlock::releaseBaseBlock() { std::unique_lock lock(_mutex); _compressToBaseBlock(); return std::move(_baseBlock); } template void CompressedBlock::_compressToBaseBlock() { if (_dataChanged) { cpputils::Data compressed = Compressor::Compress(_decompressedData); _baseBlock->resize(compressed.size()); _baseBlock->write(compressed.data(), 0, compressed.size()); _dataChanged = false; } } } } #endif src/blockstore/implementations/compressing/CompressingBlockStore.cpp000066400000000000000000000000431300002025200265170ustar00rootroot00000000000000#include "CompressingBlockStore.h" src/blockstore/implementations/compressing/CompressingBlockStore.h000066400000000000000000000062601300002025200261730ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_COMPRESSING_COMPRESSINGBLOCKSTORE_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_COMPRESSING_COMPRESSINGBLOCKSTORE_H_ #include "../../interface/BlockStore.h" #include "CompressedBlock.h" namespace blockstore { namespace compressing { template class CompressingBlockStore final: public BlockStore { public: CompressingBlockStore(cpputils::unique_ref baseBlockStore); ~CompressingBlockStore(); Key createKey() override; boost::optional> tryCreate(const Key &key, cpputils::Data data) override; boost::optional> load(const Key &key) override; void remove(cpputils::unique_ref block) override; uint64_t numBlocks() const override; uint64_t estimateNumFreeBytes() const override; uint64_t blockSizeFromPhysicalBlockSize(uint64_t blockSize) const override; private: cpputils::unique_ref _baseBlockStore; DISALLOW_COPY_AND_ASSIGN(CompressingBlockStore); }; template CompressingBlockStore::CompressingBlockStore(cpputils::unique_ref baseBlockStore) : _baseBlockStore(std::move(baseBlockStore)) { } template CompressingBlockStore::~CompressingBlockStore() { } template Key CompressingBlockStore::createKey() { return _baseBlockStore->createKey(); } template boost::optional> CompressingBlockStore::tryCreate(const Key &key, cpputils::Data data) { auto result = CompressedBlock::TryCreateNew(_baseBlockStore.get(), key, std::move(data)); if (result == boost::none) { return boost::none; } return cpputils::unique_ref(std::move(*result)); } template boost::optional> CompressingBlockStore::load(const Key &key) { auto loaded = _baseBlockStore->load(key); if (loaded == boost::none) { return boost::none; } return boost::optional>(CompressedBlock::Decompress(std::move(*loaded))); } template void CompressingBlockStore::remove(cpputils::unique_ref block) { auto _block = cpputils::dynamic_pointer_move>(block); ASSERT(_block != boost::none, "Wrong block type"); auto baseBlock = (*_block)->releaseBaseBlock(); return _baseBlockStore->remove(std::move(baseBlock)); } template uint64_t CompressingBlockStore::numBlocks() const { return _baseBlockStore->numBlocks(); } template uint64_t CompressingBlockStore::estimateNumFreeBytes() const { return _baseBlockStore->estimateNumFreeBytes(); } template uint64_t CompressingBlockStore::blockSizeFromPhysicalBlockSize(uint64_t blockSize) const { //We probably have more since we're compressing, but we don't know exactly how much. //The best we can do is ignore the compression step here. return _baseBlockStore->blockSizeFromPhysicalBlockSize(blockSize); } } } #endif src/blockstore/implementations/compressing/compressors/000077500000000000000000000000001300002025200241145ustar00rootroot00000000000000src/blockstore/implementations/compressing/compressors/Gzip.cpp000066400000000000000000000017661300002025200255430ustar00rootroot00000000000000#include "Gzip.h" #include using cpputils::Data; namespace blockstore { namespace compressing { Data Gzip::Compress(const Data &data) { CryptoPP::Gzip zipper; zipper.Put((byte *) data.data(), data.size()); zipper.MessageEnd(); Data compressed(zipper.MaxRetrievable()); zipper.Get((byte *) compressed.data(), compressed.size()); return compressed; } Data Gzip::Decompress(const void *data, size_t size) { //TODO Change interface to taking cpputils::Data objects (needs changing blockstore so we can read their "class Data", because this is called from CompressedBlock::Decompress()). CryptoPP::Gunzip zipper; zipper.Put((byte *) data, size); zipper.MessageEnd(); Data decompressed(zipper.MaxRetrievable()); zipper.Get((byte *) decompressed.data(), decompressed.size()); return decompressed; } } }src/blockstore/implementations/compressing/compressors/Gzip.h000066400000000000000000000007151300002025200252010ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_COMPRESSING_COMPRESSORS_GZIP_H #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_COMPRESSING_COMPRESSORS_GZIP_H #include namespace blockstore { namespace compressing { class Gzip { public: static cpputils::Data Compress(const cpputils::Data &data); static cpputils::Data Decompress(const void *data, size_t size); }; } } #endif src/blockstore/implementations/compressing/compressors/RunLengthEncoding.cpp000066400000000000000000000137061300002025200302040ustar00rootroot00000000000000#include "RunLengthEncoding.h" #include #include using cpputils::Data; using std::string; using std::ostringstream; using std::istringstream; namespace blockstore { namespace compressing { // Alternatively store a run of arbitrary bytes and a run of identical bytes. // Each run is preceded by its length. Length fields are uint16_t. // Example: 2 - 5 - 8 - 10 - 3 - 0 - 2 - 0 // Length 2 arbitrary bytes (values: 5, 8), the next 10 bytes store "3" each, // then 0 arbitrary bytes and 2x "0". Data RunLengthEncoding::Compress(const Data &data) { ostringstream compressed; uint8_t *current = (uint8_t*)data.data(); uint8_t *end = (uint8_t*)data.data()+data.size(); while (current < end) { _encodeArbitraryWords(¤t, end, &compressed); ASSERT(current <= end, "Overflow"); if (current == end) { break; } _encodeIdenticalWords(¤t, end, &compressed); ASSERT(current <= end, "Overflow"); } return _extractData(&compressed); } void RunLengthEncoding::_encodeArbitraryWords(uint8_t **current, uint8_t* end, ostringstream *output) { uint16_t size = _arbitraryRunLength(*current, end); output->write((const char*)&size, sizeof(uint16_t)); output->write((const char*)*current, size); *current += size; } uint16_t RunLengthEncoding::_arbitraryRunLength(uint8_t *start, uint8_t* end) { // Each stopping of an arbitrary bytes run costs us 5 byte, because we have to store the length // for the identical bytes run (2 byte), the identical byte itself (1 byte) and the length for the next arbitrary bytes run (2 byte). // So to get an advantage from stopping an arbitrary bytes run, at least 6 bytes have to be identical. // realEnd avoids an overflow of the 16bit counter uint8_t *realEnd = std::min(end, start + std::numeric_limits::max()); // Count the number of identical bytes and return if it finds a run of more than 6 identical bytes. uint8_t lastByte = *start + 1; // Something different from the first byte uint8_t numIdenticalBytes = 1; for(uint8_t *current = start; current != realEnd; ++current) { if (*current == lastByte) { ++numIdenticalBytes; if (numIdenticalBytes == 6) { return current - start - 5; //-5, because the end pointer for the arbitrary byte run should point to the first identical byte, not the one before. } } else { numIdenticalBytes = 1; } lastByte = *current; } //It wasn't worth stopping the arbitrary bytes run anywhere. The whole region should be an arbitrary run. return realEnd-start; } void RunLengthEncoding::_encodeIdenticalWords(uint8_t **current, uint8_t* end, ostringstream *output) { uint16_t size = _countIdenticalBytes(*current, end); output->write((const char*)&size, sizeof(uint16_t)); output->write((const char*)*current, 1); *current += size; } uint16_t RunLengthEncoding::_countIdenticalBytes(uint8_t *start, uint8_t *end) { uint8_t *realEnd = std::min(end, start + std::numeric_limits::max()); // This prevents overflow of the 16bit counter for (uint8_t *current = start+1; current != realEnd; ++current) { if (*current != *start) { return current-start; } } // All bytes have been identical return realEnd - start; } Data RunLengthEncoding::_extractData(ostringstream *stream) { string str = stream->str(); Data data(str.size()); std::memcpy(data.data(), str.c_str(), str.size()); return data; } Data RunLengthEncoding::Decompress(const void *data, size_t size) { istringstream stream; _parseData((uint8_t*)data, size, &stream); ostringstream decompressed; while(_hasData(&stream)) { _decodeArbitraryWords(&stream, &decompressed); if (!_hasData(&stream)) { break; } _decodeIdenticalWords(&stream, &decompressed); } return _extractData(&decompressed); } bool RunLengthEncoding::_hasData(istringstream *str) { str->peek(); return !str->eof(); } void RunLengthEncoding::_parseData(const uint8_t *data, size_t size, istringstream *result) { result->str(string((const char*)data, size)); } void RunLengthEncoding::_decodeArbitraryWords(istringstream *stream, ostringstream *decompressed) { uint16_t size; stream->read((char*)&size, sizeof(uint16_t)); ASSERT(stream->good(), "Premature end of stream"); Data run(size); stream->read((char*)run.data(), size); ASSERT(stream->good(), "Premature end of stream"); decompressed->write((const char*)run.data(), run.size()); } void RunLengthEncoding::_decodeIdenticalWords(istringstream *stream, ostringstream *decompressed) { uint16_t size; stream->read((char*)&size, sizeof(uint16_t)); ASSERT(stream->good(), "Premature end of stream"); uint8_t value; stream->read((char*)&value, 1); ASSERT(stream->good(), "Premature end of stream"); Data run(size); std::memset(run.data(), value, run.size()); decompressed->write((const char*)run.data(), run.size()); } } } src/blockstore/implementations/compressing/compressors/RunLengthEncoding.h000066400000000000000000000025031300002025200276420ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_COMPRESSING_COMPRESSORS_RUNLENGTHENCODING_H #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_COMPRESSING_COMPRESSORS_RUNLENGTHENCODING_H #include namespace blockstore { namespace compressing { class RunLengthEncoding { public: static cpputils::Data Compress(const cpputils::Data &data); static cpputils::Data Decompress(const void *data, size_t size); private: static void _encodeArbitraryWords(uint8_t **current, uint8_t* end, std::ostringstream *output); static uint16_t _arbitraryRunLength(uint8_t *start, uint8_t* end); static void _encodeIdenticalWords(uint8_t **current, uint8_t* end, std::ostringstream *output); static uint16_t _countIdenticalBytes(uint8_t *start, uint8_t *end); static bool _hasData(std::istringstream *stream); static cpputils::Data _extractData(std::ostringstream *stream); static void _parseData(const uint8_t *data, size_t size, std::istringstream *result); static void _decodeArbitraryWords(std::istringstream *stream, std::ostringstream *decompressed); static void _decodeIdenticalWords(std::istringstream *stream, std::ostringstream *decompressed); }; } } #endif src/blockstore/implementations/encrypted/000077500000000000000000000000001300002025200212015ustar00rootroot00000000000000src/blockstore/implementations/encrypted/EncryptedBlock.cpp000066400000000000000000000000341300002025200246120ustar00rootroot00000000000000#include "EncryptedBlock.h" src/blockstore/implementations/encrypted/EncryptedBlock.h000066400000000000000000000222571300002025200242720ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_ENCRYPTED_ENCRYPTEDBLOCK_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_ENCRYPTED_ENCRYPTEDBLOCK_H_ #include "../../interface/Block.h" #include #include "../../interface/BlockStore.h" #include #include #include #include #include #include #include #include #include namespace blockstore { namespace encrypted { template class EncryptedBlockStore; //TODO Test EncryptedBlock //TODO Fix mutexes & locks (basically true for all blockstores) template class EncryptedBlock final: public Block { public: BOOST_CONCEPT_ASSERT((cpputils::CipherConcept)); static boost::optional> TryCreateNew(BlockStore *baseBlockStore, const Key &key, cpputils::Data data, const typename Cipher::EncryptionKey &encKey); static boost::optional> TryDecrypt(cpputils::unique_ref baseBlock, const typename Cipher::EncryptionKey &key); static uint64_t blockSizeFromPhysicalBlockSize(uint64_t blockSize); //TODO Storing key twice (in parent class and in object pointed to). Once would be enough. EncryptedBlock(cpputils::unique_ref baseBlock, const typename Cipher::EncryptionKey &key, cpputils::Data plaintextWithHeader); ~EncryptedBlock(); const void *data() const override; void write(const void *source, uint64_t offset, uint64_t count) override; void flush() override; size_t size() const override; void resize(size_t newSize) override; cpputils::unique_ref releaseBlock(); private: cpputils::unique_ref _baseBlock; // TODO Do I need the ciphertext block in memory or is the key enough? cpputils::Data _plaintextWithHeader; typename Cipher::EncryptionKey _encKey; bool _dataChanged; static constexpr unsigned int HEADER_LENGTH = Key::BINARY_LENGTH; void _encryptToBaseBlock(); static cpputils::Data _prependKeyHeaderToData(const Key &key, cpputils::Data data); static bool _keyHeaderIsCorrect(const Key &key, const cpputils::Data &data); static cpputils::Data _prependFormatHeader(const cpputils::Data &data); static void _checkFormatHeader(const void *data); // This header is prepended to blocks to allow future versions to have compatibility. static constexpr uint16_t FORMAT_VERSION_HEADER = 0; std::mutex _mutex; DISALLOW_COPY_AND_ASSIGN(EncryptedBlock); }; template constexpr unsigned int EncryptedBlock::HEADER_LENGTH; template constexpr uint16_t EncryptedBlock::FORMAT_VERSION_HEADER; template boost::optional>> EncryptedBlock::TryCreateNew(BlockStore *baseBlockStore, const Key &key, cpputils::Data data, const typename Cipher::EncryptionKey &encKey) { //TODO Is it possible to avoid copying the whole plaintext data into plaintextWithHeader? Maybe an encrypt() object that has an .addData() function and concatenates all data for encryption? Maybe Crypto++ offers this functionality already. cpputils::Data plaintextWithHeader = _prependKeyHeaderToData(key, std::move(data)); cpputils::Data encrypted = Cipher::encrypt((byte*)plaintextWithHeader.data(), plaintextWithHeader.size(), encKey); //TODO Avoid copying the whole encrypted block into a encryptedWithFormatHeader by creating a Data object with full size and then giving it as an encryption target to Cipher::encrypt() cpputils::Data encryptedWithFormatHeader = _prependFormatHeader(std::move(encrypted)); auto baseBlock = baseBlockStore->tryCreate(key, std::move(encryptedWithFormatHeader)); if (baseBlock == boost::none) { //TODO Test this code branch return boost::none; } return cpputils::make_unique_ref(std::move(*baseBlock), encKey, std::move(plaintextWithHeader)); } template cpputils::Data EncryptedBlock::_prependFormatHeader(const cpputils::Data &data) { cpputils::Data dataWithHeader(sizeof(FORMAT_VERSION_HEADER) + data.size()); std::memcpy(dataWithHeader.dataOffset(0), &FORMAT_VERSION_HEADER, sizeof(FORMAT_VERSION_HEADER)); std::memcpy(dataWithHeader.dataOffset(sizeof(FORMAT_VERSION_HEADER)), data.data(), data.size()); return dataWithHeader; } template boost::optional>> EncryptedBlock::TryDecrypt(cpputils::unique_ref baseBlock, const typename Cipher::EncryptionKey &encKey) { _checkFormatHeader(baseBlock->data()); boost::optional plaintextWithHeader = Cipher::decrypt((byte*)baseBlock->data() + sizeof(FORMAT_VERSION_HEADER), baseBlock->size() - sizeof(FORMAT_VERSION_HEADER), encKey); if(plaintextWithHeader == boost::none) { //Decryption failed (e.g. an authenticated cipher detected modifications to the ciphertext) cpputils::logging::LOG(cpputils::logging::WARN) << "Decrypting block " << baseBlock->key().ToString() << " failed. Was the block modified by an attacker?"; return boost::none; } if(!_keyHeaderIsCorrect(baseBlock->key(), *plaintextWithHeader)) { //The stored key in the block data is incorrect - an attacker might have exchanged the contents with the encrypted data from a different block cpputils::logging::LOG(cpputils::logging::WARN) << "Decrypting block " << baseBlock->key().ToString() << " failed due to invalid block key. Was the block modified by an attacker?"; return boost::none; } return cpputils::make_unique_ref>(std::move(baseBlock), encKey, std::move(*plaintextWithHeader)); } template void EncryptedBlock::_checkFormatHeader(const void *data) { if (*reinterpret_cast(data) != FORMAT_VERSION_HEADER) { throw std::runtime_error("The encrypted block has the wrong format. Was it created with a newer version of CryFS?"); } } template cpputils::Data EncryptedBlock::_prependKeyHeaderToData(const Key &key, cpputils::Data data) { static_assert(HEADER_LENGTH >= Key::BINARY_LENGTH, "Key doesn't fit into the header"); cpputils::Data result(data.size() + HEADER_LENGTH); std::memcpy(result.data(), key.data(), Key::BINARY_LENGTH); std::memcpy((uint8_t*)result.data() + Key::BINARY_LENGTH, data.data(), data.size()); return result; } template bool EncryptedBlock::_keyHeaderIsCorrect(const Key &key, const cpputils::Data &data) { return 0 == std::memcmp(key.data(), data.data(), Key::BINARY_LENGTH); } template EncryptedBlock::EncryptedBlock(cpputils::unique_ref baseBlock, const typename Cipher::EncryptionKey &encKey, cpputils::Data plaintextWithHeader) :Block(baseBlock->key()), _baseBlock(std::move(baseBlock)), _plaintextWithHeader(std::move(plaintextWithHeader)), _encKey(encKey), _dataChanged(false), _mutex() { } template EncryptedBlock::~EncryptedBlock() { std::unique_lock lock(_mutex); _encryptToBaseBlock(); } template const void *EncryptedBlock::data() const { return (uint8_t*)_plaintextWithHeader.data() + HEADER_LENGTH; } template void EncryptedBlock::write(const void *source, uint64_t offset, uint64_t count) { ASSERT(offset <= size() && offset + count <= size(), "Write outside of valid area"); //Also check offset < size() because of possible overflow in the addition std::memcpy((uint8_t*)_plaintextWithHeader.data()+HEADER_LENGTH+offset, source, count); _dataChanged = true; } template void EncryptedBlock::flush() { std::unique_lock lock(_mutex); _encryptToBaseBlock(); return _baseBlock->flush(); } template size_t EncryptedBlock::size() const { return _plaintextWithHeader.size() - HEADER_LENGTH; } template void EncryptedBlock::resize(size_t newSize) { _plaintextWithHeader = cpputils::DataUtils::resize(std::move(_plaintextWithHeader), newSize + HEADER_LENGTH); _dataChanged = true; } template void EncryptedBlock::_encryptToBaseBlock() { if (_dataChanged) { cpputils::Data encrypted = Cipher::encrypt((byte*)_plaintextWithHeader.data(), _plaintextWithHeader.size(), _encKey); if (_baseBlock->size() != sizeof(FORMAT_VERSION_HEADER) + encrypted.size()) { _baseBlock->resize(sizeof(FORMAT_VERSION_HEADER) + encrypted.size()); } _baseBlock->write(&FORMAT_VERSION_HEADER, 0, sizeof(FORMAT_VERSION_HEADER)); _baseBlock->write(encrypted.data(), sizeof(FORMAT_VERSION_HEADER), encrypted.size()); _dataChanged = false; } } template cpputils::unique_ref EncryptedBlock::releaseBlock() { std::unique_lock lock(_mutex); _encryptToBaseBlock(); return std::move(_baseBlock); } template uint64_t EncryptedBlock::blockSizeFromPhysicalBlockSize(uint64_t blockSize) { if (blockSize <= Cipher::ciphertextSize(HEADER_LENGTH) + sizeof(FORMAT_VERSION_HEADER)) { return 0; } return Cipher::plaintextSize(blockSize - sizeof(FORMAT_VERSION_HEADER)) - HEADER_LENGTH; } } } #endif src/blockstore/implementations/encrypted/EncryptedBlockStore.cpp000066400000000000000000000000411300002025200256250ustar00rootroot00000000000000#include "EncryptedBlockStore.h" src/blockstore/implementations/encrypted/EncryptedBlockStore.h000066400000000000000000000072501300002025200253030ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_ENCRYPTED_ENCRYPTEDBLOCKSTORE_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_ENCRYPTED_ENCRYPTEDBLOCKSTORE_H_ #include "../../interface/BlockStore.h" #include #include #include "EncryptedBlock.h" #include namespace blockstore { namespace encrypted { template class EncryptedBlockStore final: public BlockStore { public: EncryptedBlockStore(cpputils::unique_ref baseBlockStore, const typename Cipher::EncryptionKey &encKey); //TODO Are createKey() tests included in generic BlockStoreTest? If not, add it! Key createKey() override; boost::optional> tryCreate(const Key &key, cpputils::Data data) override; boost::optional> load(const Key &key) override; void remove(cpputils::unique_ref block) override; uint64_t numBlocks() const override; uint64_t estimateNumFreeBytes() const override; uint64_t blockSizeFromPhysicalBlockSize(uint64_t blockSize) const override; //This function should only be used by test cases void __setKey(const typename Cipher::EncryptionKey &encKey); private: cpputils::unique_ref _baseBlockStore; typename Cipher::EncryptionKey _encKey; DISALLOW_COPY_AND_ASSIGN(EncryptedBlockStore); }; template EncryptedBlockStore::EncryptedBlockStore(cpputils::unique_ref baseBlockStore, const typename Cipher::EncryptionKey &encKey) : _baseBlockStore(std::move(baseBlockStore)), _encKey(encKey) { } template Key EncryptedBlockStore::createKey() { return _baseBlockStore->createKey(); } template boost::optional> EncryptedBlockStore::tryCreate(const Key &key, cpputils::Data data) { //TODO Test that this returns boost::none when base blockstore returns nullptr (for all pass-through-blockstores) //TODO Easier implementation? This is only so complicated because of the cast EncryptedBlock -> Block auto result = EncryptedBlock::TryCreateNew(_baseBlockStore.get(), key, std::move(data), _encKey); if (result == boost::none) { return boost::none; } return cpputils::unique_ref(std::move(*result)); } template boost::optional> EncryptedBlockStore::load(const Key &key) { auto block = _baseBlockStore->load(key); if (block == boost::none) { //TODO Test this path (for all pass-through-blockstores) return boost::none; } return boost::optional>(EncryptedBlock::TryDecrypt(std::move(*block), _encKey)); } template void EncryptedBlockStore::remove(cpputils::unique_ref block) { auto encryptedBlock = cpputils::dynamic_pointer_move>(block); ASSERT(encryptedBlock != boost::none, "Block is not an EncryptedBlock"); auto baseBlock = (*encryptedBlock)->releaseBlock(); return _baseBlockStore->remove(std::move(baseBlock)); } template uint64_t EncryptedBlockStore::numBlocks() const { return _baseBlockStore->numBlocks(); } template uint64_t EncryptedBlockStore::estimateNumFreeBytes() const { return _baseBlockStore->estimateNumFreeBytes(); } template void EncryptedBlockStore::__setKey(const typename Cipher::EncryptionKey &encKey) { _encKey = encKey; } template uint64_t EncryptedBlockStore::blockSizeFromPhysicalBlockSize(uint64_t blockSize) const { return EncryptedBlock::blockSizeFromPhysicalBlockSize(_baseBlockStore->blockSizeFromPhysicalBlockSize(blockSize)); } } } #endif src/blockstore/implementations/inmemory/000077500000000000000000000000001300002025200210435ustar00rootroot00000000000000src/blockstore/implementations/inmemory/InMemoryBlock.cpp000066400000000000000000000022641300002025200242650ustar00rootroot00000000000000#include "InMemoryBlock.h" #include "InMemoryBlockStore.h" #include #include #include using std::make_shared; using std::istream; using std::ostream; using std::ifstream; using std::ofstream; using std::ios; using cpputils::Data; namespace blockstore { namespace inmemory { InMemoryBlock::InMemoryBlock(const Key &key, Data data) : Block(key), _data(make_shared(std::move(data))) { } InMemoryBlock::InMemoryBlock(const InMemoryBlock &rhs) : Block(rhs), _data(rhs._data) { } InMemoryBlock::~InMemoryBlock() { } const void *InMemoryBlock::data() const { return _data->data(); } void InMemoryBlock::write(const void *source, uint64_t offset, uint64_t size) { ASSERT(offset <= _data->size() && offset + size <= _data->size(), "Write outside of valid area"); //Also check offset < _data->size() because of possible overflow in the addition std::memcpy((uint8_t*)_data->data()+offset, source, size); } size_t InMemoryBlock::size() const { return _data->size(); } void InMemoryBlock::resize(size_t newSize) { *_data = cpputils::DataUtils::resize(std::move(*_data), newSize); } void InMemoryBlock::flush() { } } } src/blockstore/implementations/inmemory/InMemoryBlock.h000066400000000000000000000013421300002025200237260ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_INMEMORY_INMEMORYBLOCK_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_INMEMORY_INMEMORYBLOCK_H_ #include "../../interface/Block.h" #include namespace blockstore { namespace inmemory { class InMemoryBlockStore; class InMemoryBlock final: public Block { public: InMemoryBlock(const Key &key, cpputils::Data size); InMemoryBlock(const InMemoryBlock &rhs); ~InMemoryBlock(); const void *data() const override; void write(const void *source, uint64_t offset, uint64_t size) override; void flush() override; size_t size() const override; void resize(size_t newSize) override; private: std::shared_ptr _data; }; } } #endif src/blockstore/implementations/inmemory/InMemoryBlockStore.cpp000066400000000000000000000033151300002025200253000ustar00rootroot00000000000000#include "InMemoryBlock.h" #include "InMemoryBlockStore.h" #include #include #include using std::make_unique; using std::string; using std::mutex; using std::lock_guard; using std::piecewise_construct; using std::make_tuple; using cpputils::Data; using cpputils::unique_ref; using cpputils::make_unique_ref; using boost::optional; using boost::none; namespace blockstore { namespace inmemory { InMemoryBlockStore::InMemoryBlockStore() : _blocks() {} optional> InMemoryBlockStore::tryCreate(const Key &key, Data data) { auto insert_result = _blocks.emplace(piecewise_construct, make_tuple(key), make_tuple(key, std::move(data))); if (!insert_result.second) { return none; } //Return a pointer to the stored InMemoryBlock return optional>(make_unique_ref(insert_result.first->second)); } optional> InMemoryBlockStore::load(const Key &key) { //Return a pointer to the stored InMemoryBlock try { return optional>(make_unique_ref(_blocks.at(key))); } catch (const std::out_of_range &e) { return none; } } void InMemoryBlockStore::remove(unique_ref block) { Key key = block->key(); cpputils::destruct(std::move(block)); int numRemoved = _blocks.erase(key); ASSERT(1==numRemoved, "Didn't find block to remove"); } uint64_t InMemoryBlockStore::numBlocks() const { return _blocks.size(); } uint64_t InMemoryBlockStore::estimateNumFreeBytes() const { return cpputils::system::get_total_memory(); } uint64_t InMemoryBlockStore::blockSizeFromPhysicalBlockSize(uint64_t blockSize) const { return blockSize; } } } src/blockstore/implementations/inmemory/InMemoryBlockStore.h000066400000000000000000000017521300002025200247500ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_INMEMORY_INMEMORYBLOCKSTORE_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_INMEMORY_INMEMORYBLOCKSTORE_H_ #include "../../interface/helpers/BlockStoreWithRandomKeys.h" #include #include #include #include "InMemoryBlock.h" namespace blockstore { namespace inmemory { class InMemoryBlockStore final: public BlockStoreWithRandomKeys { public: InMemoryBlockStore(); boost::optional> tryCreate(const Key &key, cpputils::Data data) override; boost::optional> load(const Key &key) override; void remove(cpputils::unique_ref block) override; uint64_t numBlocks() const override; uint64_t estimateNumFreeBytes() const override; uint64_t blockSizeFromPhysicalBlockSize(uint64_t blockSize) const override; private: std::unordered_map _blocks; DISALLOW_COPY_AND_ASSIGN(InMemoryBlockStore); }; } } #endif src/blockstore/implementations/ondisk/000077500000000000000000000000001300002025200204735ustar00rootroot00000000000000src/blockstore/implementations/ondisk/OnDiskBlock.cpp000066400000000000000000000127671300002025200233560ustar00rootroot00000000000000#include #include #include #include "OnDiskBlock.h" #include "OnDiskBlockStore.h" #include "../../utils/FileDoesntExistException.h" #include #include #include using std::istream; using std::ostream; using std::ifstream; using std::ofstream; using std::ios; using std::string; using cpputils::Data; using cpputils::make_unique_ref; using cpputils::unique_ref; using boost::optional; using boost::none; namespace bf = boost::filesystem; using namespace cpputils::logging; namespace blockstore { namespace ondisk { const string OnDiskBlock::FORMAT_VERSION_HEADER_PREFIX = "cryfs;block;"; const string OnDiskBlock::FORMAT_VERSION_HEADER = OnDiskBlock::FORMAT_VERSION_HEADER_PREFIX + "0"; OnDiskBlock::OnDiskBlock(const Key &key, const bf::path &filepath, Data data) : Block(key), _filepath(filepath), _data(std::move(data)), _dataChanged(false), _mutex() { } OnDiskBlock::~OnDiskBlock() { flush(); } const void *OnDiskBlock::data() const { return _data.data(); } void OnDiskBlock::write(const void *source, uint64_t offset, uint64_t size) { ASSERT(offset <= _data.size() && offset + size <= _data.size(), "Write outside of valid area"); //Also check offset < _data->size() because of possible overflow in the addition std::memcpy(_data.dataOffset(offset), source, size); _dataChanged = true; } size_t OnDiskBlock::size() const { return _data.size(); } void OnDiskBlock::resize(size_t newSize) { _data = cpputils::DataUtils::resize(std::move(_data), newSize); _dataChanged = true; } bf::path OnDiskBlock::_getFilepath(const bf::path &rootdir, const Key &key) { string keyStr = key.ToString(); return rootdir / keyStr.substr(0,3) / keyStr.substr(3); } optional> OnDiskBlock::LoadFromDisk(const bf::path &rootdir, const Key &key) { auto filepath = _getFilepath(rootdir, key); try { boost::optional data = _loadFromDisk(filepath); if (data == none) { return none; } return make_unique_ref(key, filepath, std::move(*data)); } catch (const FileDoesntExistException &e) { return none; } } optional> OnDiskBlock::CreateOnDisk(const bf::path &rootdir, const Key &key, Data data) { auto filepath = _getFilepath(rootdir, key); bf::create_directory(filepath.parent_path()); if (bf::exists(filepath)) { return none; } auto block = make_unique_ref(key, filepath, std::move(data)); block->_storeToDisk(); return std::move(block); } void OnDiskBlock::RemoveFromDisk(const bf::path &rootdir, const Key &key) { auto filepath = _getFilepath(rootdir, key); ASSERT(bf::is_regular_file(filepath), "Block not found on disk"); bool retval = bf::remove(filepath); if (!retval) { LOG(ERROR) << "Couldn't find block " << key.ToString() << " to remove"; } if (bf::is_empty(filepath.parent_path())) { bf::remove(filepath.parent_path()); } } void OnDiskBlock::_storeToDisk() const { std::ofstream file(_filepath.c_str(), std::ios::binary | std::ios::trunc); if (!file.good()) { throw std::runtime_error("Could not open file for writing"); } file.write(FORMAT_VERSION_HEADER.c_str(), formatVersionHeaderSize()); if (!file.good()) { throw std::runtime_error("Error writing block header"); } _data.StoreToStream(file); if (!file.good()) { throw std::runtime_error("Error writing block data"); } } optional OnDiskBlock::_loadFromDisk(const bf::path &filepath) { //If it isn't a file, ifstream::good() would return false. We still need this extra check //upfront, because ifstream::good() doesn't crash if we give it the path of a directory //instead the path of a file. if(!bf::is_regular_file(filepath)) { return none; } ifstream file(filepath.c_str(), ios::binary); if (!file.good()) { return none; } _checkHeader(&file); Data result = Data::LoadFromStream(file); //TODO With newer compilers, "return result;" would be enough return boost::optional(std::move(result)); } void OnDiskBlock::_checkHeader(istream *str) { Data header(formatVersionHeaderSize()); str->read(reinterpret_cast(header.data()), formatVersionHeaderSize()); if (!_isAcceptedCryfsHeader(header)) { if (_isOtherCryfsHeader(header)) { throw std::runtime_error("This block is not supported yet. Maybe it was created with a newer version of CryFS?"); } else { throw std::runtime_error("This is not a valid block."); } } } bool OnDiskBlock::_isAcceptedCryfsHeader(const Data &data) { ASSERT(data.size() == formatVersionHeaderSize(), "We extracted the wrong header size from the block."); return 0 == std::memcmp(data.data(), FORMAT_VERSION_HEADER.c_str(), formatVersionHeaderSize()); } bool OnDiskBlock::_isOtherCryfsHeader(const Data &data) { ASSERT(data.size() >= FORMAT_VERSION_HEADER_PREFIX.size(), "We extracted the wrong header size from the block."); return 0 == std::memcmp(data.data(), FORMAT_VERSION_HEADER_PREFIX.c_str(), FORMAT_VERSION_HEADER_PREFIX.size()); } unsigned int OnDiskBlock::formatVersionHeaderSize() { return FORMAT_VERSION_HEADER.size() + 1; // +1 because of the null byte } void OnDiskBlock::flush() { std::unique_lock lock(_mutex); if (_dataChanged) { _storeToDisk(); _dataChanged = false; } } uint64_t OnDiskBlock::blockSizeFromPhysicalBlockSize(uint64_t blockSize) { if(blockSize <= formatVersionHeaderSize()) { return 0; } return blockSize - formatVersionHeaderSize(); } } } src/blockstore/implementations/ondisk/OnDiskBlock.h000066400000000000000000000036351300002025200230150ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_ONDISK_ONDISKBLOCK_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_ONDISK_ONDISKBLOCK_H_ #include #include "../../interface/Block.h" #include #include #include #include namespace blockstore { namespace ondisk { class OnDiskBlockStore; class OnDiskBlock final: public Block { public: OnDiskBlock(const Key &key, const boost::filesystem::path &filepath, cpputils::Data data); ~OnDiskBlock(); static const std::string FORMAT_VERSION_HEADER_PREFIX; static const std::string FORMAT_VERSION_HEADER; static unsigned int formatVersionHeaderSize(); static uint64_t blockSizeFromPhysicalBlockSize(uint64_t blockSize); static boost::optional> LoadFromDisk(const boost::filesystem::path &rootdir, const Key &key); static boost::optional> CreateOnDisk(const boost::filesystem::path &rootdir, const Key &key, cpputils::Data data); static void RemoveFromDisk(const boost::filesystem::path &rootdir, const Key &key); const void *data() const override; void write(const void *source, uint64_t offset, uint64_t size) override; void flush() override; size_t size() const override; void resize(size_t newSize) override; private: static bool _isAcceptedCryfsHeader(const cpputils::Data &data); static bool _isOtherCryfsHeader(const cpputils::Data &data); static void _checkHeader(std::istream *str); static boost::filesystem::path _getFilepath(const boost::filesystem::path &rootdir, const Key &key); const boost::filesystem::path _filepath; cpputils::Data _data; bool _dataChanged; static boost::optional _loadFromDisk(const boost::filesystem::path &filepath); void _storeToDisk() const; std::mutex _mutex; DISALLOW_COPY_AND_ASSIGN(OnDiskBlock); }; } } #endif src/blockstore/implementations/ondisk/OnDiskBlockStore.cpp000066400000000000000000000061761300002025200243700ustar00rootroot00000000000000#include "OnDiskBlock.h" #include "OnDiskBlockStore.h" #include using std::string; using cpputils::Data; using cpputils::unique_ref; using boost::optional; using boost::none; using std::vector; namespace bf = boost::filesystem; namespace blockstore { namespace ondisk { OnDiskBlockStore::OnDiskBlockStore(const boost::filesystem::path &rootdir) : _rootdir(rootdir) { if (!bf::exists(rootdir)) { throw std::runtime_error("Base directory not found"); } if (!bf::is_directory(rootdir)) { throw std::runtime_error("Base directory is not a directory"); } //TODO Test for read access, write access, enter (x) access, and throw runtime_error in case #ifndef CRYFS_NO_COMPATIBILITY _migrateBlockStore(); #endif } #ifndef CRYFS_NO_COMPATIBILITY void OnDiskBlockStore::_migrateBlockStore() { vector blocksToMigrate; for (auto entry = bf::directory_iterator(_rootdir); entry != bf::directory_iterator(); ++entry) { if (bf::is_regular_file(entry->path()) && _isValidBlockKey(entry->path().filename().native())) { blocksToMigrate.push_back(entry->path().filename().native()); } } if (blocksToMigrate.size() != 0) { std::cout << "Migrating CryFS filesystem..." << std::flush; for (auto key : blocksToMigrate) { Key::FromString(key); // Assert that it can be parsed as a key string dir = key.substr(0, 3); string file = key.substr(3); bf::create_directory(_rootdir / dir); bf::rename(_rootdir / key, _rootdir / dir / file); } std::cout << "done" << std::endl; } } bool OnDiskBlockStore::_isValidBlockKey(const string &key) { return key.size() == 32 && key.find_first_not_of("0123456789ABCDEF") == string::npos; } #endif //TODO Do I have to lock tryCreate/remove and/or load? Or does ParallelAccessBlockStore take care of that? optional> OnDiskBlockStore::tryCreate(const Key &key, Data data) { //TODO Easier implementation? This is only so complicated because of the cast OnDiskBlock -> Block auto result = std::move(OnDiskBlock::CreateOnDisk(_rootdir, key, std::move(data))); if (result == boost::none) { return boost::none; } return unique_ref(std::move(*result)); } optional> OnDiskBlockStore::load(const Key &key) { return optional>(OnDiskBlock::LoadFromDisk(_rootdir, key)); } void OnDiskBlockStore::remove(unique_ref block) { Key key = block->key(); cpputils::destruct(std::move(block)); OnDiskBlock::RemoveFromDisk(_rootdir, key); } uint64_t OnDiskBlockStore::numBlocks() const { uint64_t count = 0; for (auto entry = bf::directory_iterator(_rootdir); entry != bf::directory_iterator(); ++entry) { if (bf::is_directory(entry->path())) { count += std::distance(bf::directory_iterator(entry->path()), bf::directory_iterator()); } } return count; } uint64_t OnDiskBlockStore::estimateNumFreeBytes() const { struct statvfs stat; ::statvfs(_rootdir.c_str(), &stat); return stat.f_bsize*stat.f_bavail; } uint64_t OnDiskBlockStore::blockSizeFromPhysicalBlockSize(uint64_t blockSize) const { return OnDiskBlock::blockSizeFromPhysicalBlockSize(blockSize); } } } src/blockstore/implementations/ondisk/OnDiskBlockStore.h000066400000000000000000000023161300002025200240250ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_ONDISK_ONDISKBLOCKSTORE_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_ONDISK_ONDISKBLOCKSTORE_H_ #include #include "../../interface/helpers/BlockStoreWithRandomKeys.h" #include namespace blockstore { namespace ondisk { class OnDiskBlockStore final: public BlockStoreWithRandomKeys { public: explicit OnDiskBlockStore(const boost::filesystem::path &rootdir); boost::optional> tryCreate(const Key &key, cpputils::Data data) override; boost::optional> load(const Key &key) override; //TODO Can we make this faster by allowing to delete blocks by only having theiy Key? So we wouldn't have to load it first? void remove(cpputils::unique_ref block) override; uint64_t numBlocks() const override; uint64_t estimateNumFreeBytes() const override; uint64_t blockSizeFromPhysicalBlockSize(uint64_t blockSize) const override; private: const boost::filesystem::path _rootdir; #ifndef CRYFS_NO_COMPATIBILITY void _migrateBlockStore(); bool _isValidBlockKey(const std::string &key); #endif DISALLOW_COPY_AND_ASSIGN(OnDiskBlockStore); }; } } #endif src/blockstore/implementations/parallelaccess/000077500000000000000000000000001300002025200221625ustar00rootroot00000000000000src/blockstore/implementations/parallelaccess/BlockRef.cpp000066400000000000000000000000261300002025200243530ustar00rootroot00000000000000#include "BlockRef.h" src/blockstore/implementations/parallelaccess/BlockRef.h000066400000000000000000000022331300002025200240220ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_PARALLELACCESS_BLOCKREF_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_PARALLELACCESS_BLOCKREF_H_ #include #include "../../interface/Block.h" #include #include namespace blockstore { namespace parallelaccess { class ParallelAccessBlockStore; class BlockRef final: public Block, public parallelaccessstore::ParallelAccessStore::ResourceRefBase { public: //TODO Unneccessarily storing Key twice here (in parent class and in _baseBlock). explicit BlockRef(Block *baseBlock): Block(baseBlock->key()), _baseBlock(baseBlock) {} const void *data() const override { return _baseBlock->data(); } void write(const void *source, uint64_t offset, uint64_t size) override { return _baseBlock->write(source, offset, size); } void flush() override { return _baseBlock->flush(); } size_t size() const override { return _baseBlock->size(); } void resize(size_t newSize) override { return _baseBlock->resize(newSize); } private: Block *_baseBlock; DISALLOW_COPY_AND_ASSIGN(BlockRef); }; } } #endif src/blockstore/implementations/parallelaccess/ParallelAccessBlockStore.cpp000066400000000000000000000040641300002025200275400ustar00rootroot00000000000000#include "BlockRef.h" #include "ParallelAccessBlockStore.h" #include "ParallelAccessBlockStoreAdapter.h" #include #include #include using std::string; using std::promise; using cpputils::dynamic_pointer_move; using cpputils::make_unique_ref; using boost::none; using cpputils::unique_ref; using cpputils::make_unique_ref; using boost::optional; using boost::none; namespace blockstore { namespace parallelaccess { ParallelAccessBlockStore::ParallelAccessBlockStore(unique_ref baseBlockStore) : _baseBlockStore(std::move(baseBlockStore)), _parallelAccessStore(make_unique_ref(_baseBlockStore.get())) { } Key ParallelAccessBlockStore::createKey() { return _baseBlockStore->createKey(); } optional> ParallelAccessBlockStore::tryCreate(const Key &key, cpputils::Data data) { ASSERT(!_parallelAccessStore.isOpened(key), ("Key "+key.ToString()+"already exists").c_str()); auto block = _baseBlockStore->tryCreate(key, std::move(data)); if (block == none) { //TODO Test this code branch return none; } return unique_ref(_parallelAccessStore.add(key, std::move(*block))); } optional> ParallelAccessBlockStore::load(const Key &key) { auto block = _parallelAccessStore.load(key); if (block == none) { return none; } return unique_ref(std::move(*block)); } void ParallelAccessBlockStore::remove(unique_ref block) { Key key = block->key(); auto block_ref = dynamic_pointer_move(block); ASSERT(block_ref != none, "Block is not a BlockRef"); return _parallelAccessStore.remove(key, std::move(*block_ref)); } uint64_t ParallelAccessBlockStore::numBlocks() const { return _baseBlockStore->numBlocks(); } uint64_t ParallelAccessBlockStore::estimateNumFreeBytes() const { return _baseBlockStore->estimateNumFreeBytes(); } uint64_t ParallelAccessBlockStore::blockSizeFromPhysicalBlockSize(uint64_t blockSize) const { return _baseBlockStore->blockSizeFromPhysicalBlockSize(blockSize); } } } src/blockstore/implementations/parallelaccess/ParallelAccessBlockStore.h000066400000000000000000000024541300002025200272060ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_PARALLELACCESS_PARALLELACCESSBLOCKSTORE_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_PARALLELACCESS_PARALLELACCESSBLOCKSTORE_H_ #include #include "BlockRef.h" #include "../../interface/BlockStore.h" #include namespace blockstore { namespace parallelaccess { //TODO Check that this blockstore allows parallel destructing of blocks (otherwise we won't encrypt blocks in parallel) class ParallelAccessBlockStore final: public BlockStore { public: explicit ParallelAccessBlockStore(cpputils::unique_ref baseBlockStore); Key createKey() override; boost::optional> tryCreate(const Key &key, cpputils::Data data) override; boost::optional> load(const Key &key) override; void remove(cpputils::unique_ref block) override; uint64_t numBlocks() const override; uint64_t estimateNumFreeBytes() const override; uint64_t blockSizeFromPhysicalBlockSize(uint64_t blockSize) const override; private: cpputils::unique_ref _baseBlockStore; parallelaccessstore::ParallelAccessStore _parallelAccessStore; DISALLOW_COPY_AND_ASSIGN(ParallelAccessBlockStore); }; } } #endif src/blockstore/implementations/parallelaccess/ParallelAccessBlockStoreAdapter.cpp000066400000000000000000000000551300002025200310350ustar00rootroot00000000000000#include "ParallelAccessBlockStoreAdapter.h" src/blockstore/implementations/parallelaccess/ParallelAccessBlockStoreAdapter.h000066400000000000000000000017501300002025200305050ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_PARALLELACCESS_PARALLELACCESSBLOCKSTOREADAPTER_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_PARALLELACCESS_PARALLELACCESSBLOCKSTOREADAPTER_H_ #include #include #include "../../interface/BlockStore.h" namespace blockstore { namespace parallelaccess { class ParallelAccessBlockStoreAdapter final: public parallelaccessstore::ParallelAccessBaseStore { public: explicit ParallelAccessBlockStoreAdapter(BlockStore *baseBlockStore) :_baseBlockStore(std::move(baseBlockStore)) { } boost::optional> loadFromBaseStore(const Key &key) override { return _baseBlockStore->load(key); } void removeFromBaseStore(cpputils::unique_ref block) override { return _baseBlockStore->remove(std::move(block)); } private: BlockStore *_baseBlockStore; DISALLOW_COPY_AND_ASSIGN(ParallelAccessBlockStoreAdapter); }; } } #endif src/blockstore/implementations/testfake/000077500000000000000000000000001300002025200210125ustar00rootroot00000000000000src/blockstore/implementations/testfake/FakeBlock.cpp000066400000000000000000000024041300002025200233370ustar00rootroot00000000000000#include "FakeBlock.h" #include "FakeBlockStore.h" #include #include #include using std::shared_ptr; using std::istream; using std::ostream; using std::ifstream; using std::ofstream; using std::ios; using std::string; using cpputils::Data; namespace blockstore { namespace testfake { FakeBlock::FakeBlock(FakeBlockStore *store, const Key &key, shared_ptr data, bool dirty) : Block(key), _store(store), _data(data), _dataChanged(dirty) { } FakeBlock::~FakeBlock() { flush(); } const void *FakeBlock::data() const { return _data->data(); } void FakeBlock::write(const void *source, uint64_t offset, uint64_t size) { ASSERT(offset <= _data->size() && offset + size <= _data->size(), "Write outside of valid area"); //Also check offset < _data->size() because of possible overflow in the addition std::memcpy((uint8_t*)_data->data()+offset, source, size); _dataChanged = true; } size_t FakeBlock::size() const { return _data->size(); } void FakeBlock::resize(size_t newSize) { *_data = cpputils::DataUtils::resize(std::move(*_data), newSize); _dataChanged = true; } void FakeBlock::flush() { if(_dataChanged) { _store->updateData(key(), *_data); _dataChanged = false; } } } } src/blockstore/implementations/testfake/FakeBlock.h000066400000000000000000000015121300002025200230030ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_TESTFAKE_FAKEBLOCK_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_TESTFAKE_FAKEBLOCK_H_ #include "../../interface/Block.h" #include #include namespace blockstore { namespace testfake { class FakeBlockStore; class FakeBlock final: public Block { public: FakeBlock(FakeBlockStore *store, const Key &key, std::shared_ptr data, bool dirty); ~FakeBlock(); const void *data() const override; void write(const void *source, uint64_t offset, uint64_t size) override; void flush() override; size_t size() const override; void resize(size_t newSize) override; private: FakeBlockStore *_store; std::shared_ptr _data; bool _dataChanged; DISALLOW_COPY_AND_ASSIGN(FakeBlock); }; } } #endif src/blockstore/implementations/testfake/FakeBlockStore.cpp000066400000000000000000000046021300002025200243560ustar00rootroot00000000000000#include "FakeBlock.h" #include "FakeBlockStore.h" #include #include using std::make_shared; using std::string; using std::mutex; using std::lock_guard; using cpputils::Data; using cpputils::unique_ref; using cpputils::make_unique_ref; using boost::optional; using boost::none; namespace blockstore { namespace testfake { FakeBlockStore::FakeBlockStore() : _blocks(), _used_dataregions_for_blocks(), _mutex() {} optional> FakeBlockStore::tryCreate(const Key &key, Data data) { std::unique_lock lock(_mutex); auto insert_result = _blocks.emplace(key, std::move(data)); if (!insert_result.second) { return none; } //Return a copy of the stored data return _load(key); } optional> FakeBlockStore::load(const Key &key) { std::unique_lock lock(_mutex); return _load(key); } optional> FakeBlockStore::_load(const Key &key) { //Return a copy of the stored data try { return makeFakeBlockFromData(key, _blocks.at(key), false); } catch (const std::out_of_range &e) { return none; } } void FakeBlockStore::remove(unique_ref block) { Key key = block->key(); cpputils::destruct(std::move(block)); std::unique_lock lock(_mutex); int numRemoved = _blocks.erase(key); ASSERT(numRemoved == 1, "Block not found"); } unique_ref FakeBlockStore::makeFakeBlockFromData(const Key &key, const Data &data, bool dirty) { auto newdata = make_shared(data.copy()); _used_dataregions_for_blocks.push_back(newdata); return make_unique_ref(this, key, newdata, dirty); } void FakeBlockStore::updateData(const Key &key, const Data &data) { std::unique_lock lock(_mutex); auto found = _blocks.find(key); if (found == _blocks.end()) { auto insertResult = _blocks.emplace(key, data.copy()); ASSERT(true == insertResult.second, "Inserting didn't work"); found = insertResult.first; } Data &stored_data = found->second; stored_data = data.copy(); } uint64_t FakeBlockStore::numBlocks() const { std::unique_lock lock(_mutex); return _blocks.size(); } uint64_t FakeBlockStore::estimateNumFreeBytes() const { return cpputils::system::get_total_memory(); } uint64_t FakeBlockStore::blockSizeFromPhysicalBlockSize(uint64_t blockSize) const { return blockSize; } } } src/blockstore/implementations/testfake/FakeBlockStore.h000066400000000000000000000054361300002025200240310ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_IMPLEMENTATIONS_TESTFAKE_FAKEBLOCKSTORE_H_ #define MESSMER_BLOCKSTORE_IMPLEMENTATIONS_TESTFAKE_FAKEBLOCKSTORE_H_ #include "../../interface/helpers/BlockStoreWithRandomKeys.h" #include #include #include #include namespace blockstore { namespace testfake { class FakeBlock; /** * This blockstore is meant to be used for unit tests when the module under test needs a blockstore to work with. * It basically is the same as the InMemoryBlockStore, but much less forgiving for programming mistakes. * * InMemoryBlockStore for example simply ignores flushing and gives you access to the same data region each time * you request a block. This is very performant, but also forgiving to mistakes. Say you write over the boundaries * of a block, then you wouldn't notice, since the next time you access the block, the overflow data is (probably) * still there. Or say an application is relying on flushing the block store in the right moment. Since flushing * is a no-op in InMemoryBlockStore, you wouldn't notice either. * * So this FakeBlockStore has a background copy of each block. When you request a block, you will get a copy of * the data (instead of a direct pointer as InMemoryBlockStore does) and flushing will copy the data back to the * background. This way, tests are more likely to fail if they use the blockstore wrongly. */ class FakeBlockStore final: public BlockStoreWithRandomKeys { public: FakeBlockStore(); boost::optional> tryCreate(const Key &key, cpputils::Data data) override; boost::optional> load(const Key &key) override; void remove(cpputils::unique_ref block) override; uint64_t numBlocks() const override; uint64_t estimateNumFreeBytes() const override; uint64_t blockSizeFromPhysicalBlockSize(uint64_t blockSize) const override; void updateData(const Key &key, const cpputils::Data &data); private: std::unordered_map _blocks; //This vector keeps a handle of the data regions for all created FakeBlock objects. //This way, it is ensured that no two created FakeBlock objects will work on the //same data region. Without this, it could happen that a test case creates a FakeBlock, //destructs it, creates another one, and the new one gets the same memory region. //We want to avoid this for the reasons mentioned above (overflow data). std::vector> _used_dataregions_for_blocks; mutable std::mutex _mutex; cpputils::unique_ref makeFakeBlockFromData(const Key &key, const cpputils::Data &data, bool dirty); boost::optional> _load(const Key &key); DISALLOW_COPY_AND_ASSIGN(FakeBlockStore); }; } } #endif src/blockstore/interface/000077500000000000000000000000001300002025200157345ustar00rootroot00000000000000src/blockstore/interface/Block.h000066400000000000000000000016421300002025200171420ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_INTERFACE_BLOCK_H_ #define MESSMER_BLOCKSTORE_INTERFACE_BLOCK_H_ #include "../utils/Key.h" #include namespace blockstore { //TODO Make Block non-virtual class that stores ptr to its blockstore and writes itself back to the blockstore who is offering a corresponding function. // Then ondisk blockstore can be actually create the file on disk in blockstore::create() and cachingblockstore will delay that call to its base block store. class Block { public: virtual ~Block() {} virtual const void *data() const = 0; virtual void write(const void *source, uint64_t offset, uint64_t size) = 0; virtual void flush() = 0; virtual size_t size() const = 0; //TODO Test resize() virtual void resize(size_t newSize) = 0; const Key &key() const { return _key; } protected: Block(const Key &key) : _key(key) {} private: const Key _key; }; } #endif src/blockstore/interface/BlockStore.h000066400000000000000000000027561300002025200201660ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_INTERFACE_BLOCKSTORE_H_ #define MESSMER_BLOCKSTORE_INTERFACE_BLOCKSTORE_H_ #include "Block.h" #include #include #include #include namespace blockstore { class BlockStore { public: virtual ~BlockStore() {} virtual Key createKey() = 0; //Returns boost::none if key already exists virtual boost::optional> tryCreate(const Key &key, cpputils::Data data) = 0; //TODO Use boost::optional (if key doesn't exist) // Return nullptr if block with this key doesn't exists virtual boost::optional> load(const Key &key) = 0; virtual void remove(cpputils::unique_ref block) = 0; virtual uint64_t numBlocks() const = 0; //TODO Test estimateNumFreeBytes in all block stores virtual uint64_t estimateNumFreeBytes() const = 0; // Returns, how much space a block has if we allow it to take the given physical block size (i.e. after removing headers, checksums, whatever else). // This can be used to create blocks with a certain physical block size. virtual uint64_t blockSizeFromPhysicalBlockSize(uint64_t blockSize) const = 0; cpputils::unique_ref create(const cpputils::Data &data) { while(true) { //TODO Copy (data.copy()) necessary? auto block = tryCreate(createKey(), data.copy()); if (block != boost::none) { return std::move(*block); } } } }; } #endif src/blockstore/interface/helpers/000077500000000000000000000000001300002025200173765ustar00rootroot00000000000000src/blockstore/interface/helpers/BlockStoreWithRandomKeys.cpp000066400000000000000000000000461300002025200250020ustar00rootroot00000000000000#include "BlockStoreWithRandomKeys.h" src/blockstore/interface/helpers/BlockStoreWithRandomKeys.h000066400000000000000000000012311300002025200244440ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_INTERFACE_HELPERS_BLOCKSTOREWITHRANDOMKEYS_H_ #define MESSMER_BLOCKSTORE_INTERFACE_HELPERS_BLOCKSTOREWITHRANDOMKEYS_H_ #include "../BlockStore.h" #include "../Block.h" #include namespace blockstore { // This is an implementation helpers for BlockStores that use random block keys. // You should never give this static type to the client. The client should always // work with the BlockStore interface instead. class BlockStoreWithRandomKeys: public BlockStore { public: Key createKey() final { return cpputils::Random::PseudoRandom().getFixedSize(); } }; } #endif src/blockstore/utils/000077500000000000000000000000001300002025200151345ustar00rootroot00000000000000src/blockstore/utils/BlockStoreUtils.cpp000066400000000000000000000014461300002025200207350ustar00rootroot00000000000000#include "../interface/BlockStore.h" #include "BlockStoreUtils.h" #include #include #include using cpputils::Data; using cpputils::unique_ref; namespace blockstore { namespace utils { unique_ref copyToNewBlock(BlockStore *blockStore, const Block &block) { Data data(block.size()); std::memcpy(data.data(), block.data(), block.size()); return blockStore->create(data); } void copyTo(Block *target, const Block &source) { ASSERT(target->size() == source.size(), "Can't copy block data when blocks have different sizes"); target->write(source.data(), 0, source.size()); } void fillWithZeroes(Block *target) { Data zeroes(target->size()); zeroes.FillWithZeroes(); target->write(zeroes.data(), 0, target->size()); } } } src/blockstore/utils/BlockStoreUtils.h000066400000000000000000000006441300002025200204010ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_UTILS_BLOCKSTOREUTILS_H_ #define MESSMER_BLOCKSTORE_UTILS_BLOCKSTOREUTILS_H_ #include namespace blockstore { class BlockStore; class Block; namespace utils { cpputils::unique_ref copyToNewBlock(BlockStore *blockStore, const Block &block); void copyTo(Block *target, const Block &source); void fillWithZeroes(Block *target); } } #endif src/blockstore/utils/FileDoesntExistException.cpp000066400000000000000000000005461300002025200225750ustar00rootroot00000000000000#include "FileDoesntExistException.h" namespace bf = boost::filesystem; using std::runtime_error; using std::string; namespace blockstore { FileDoesntExistException::FileDoesntExistException(const bf::path &filepath) : runtime_error(string("The file ")+filepath.c_str()+" doesn't exist") { } FileDoesntExistException::~FileDoesntExistException() { } } src/blockstore/utils/FileDoesntExistException.h000066400000000000000000000006411300002025200222360ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_UTILS_FILEDOESNTEXISTEXCEPTION_H_ #define MESSMER_BLOCKSTORE_UTILS_FILEDOESNTEXISTEXCEPTION_H_ #include #include namespace blockstore { class FileDoesntExistException final: public std::runtime_error { public: explicit FileDoesntExistException(const boost::filesystem::path &filepath); ~FileDoesntExistException(); }; } #endif src/blockstore/utils/Key.cpp000066400000000000000000000000211300002025200163610ustar00rootroot00000000000000#include "Key.h" src/blockstore/utils/Key.h000066400000000000000000000020241300002025200160330ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_UTILS_KEY_H_ #define MESSMER_BLOCKSTORE_UTILS_KEY_H_ #include #include namespace blockstore { // A key here is NOT a key for encryption, but a key as used in key->value mappings ("access handle for a block"). //TODO Rename to BlockId/BlobId and make it a class containing a FixedSizeData<> member using Key = cpputils::FixedSizeData<16>; } namespace std { //Allow using blockstore::Key in std::unordered_map / std::unordered_set template <> struct hash { size_t operator()(const blockstore::Key &key) const { //Keys are random, so it is enough to use the first few bytes as a hash return *(size_t*)(key.data()); } }; //Allow using blockstore::Key in std::map / std::set template <> struct less { bool operator()(const blockstore::Key &lhs, const blockstore::Key &rhs) const { return 0 > std::memcmp(lhs.data(), rhs.data(), blockstore::Key::BINARY_LENGTH); } }; } #endif src/cpp-utils/000077500000000000000000000000001300002025200135455ustar00rootroot00000000000000src/cpp-utils/CMakeLists.txt000066400000000000000000000031141300002025200163040ustar00rootroot00000000000000project (cpp-utils) set(SOURCES crypto/symmetric/ciphers.cpp crypto/kdf/Scrypt.cpp crypto/kdf/SCryptParameters.cpp crypto/kdf/PasswordBasedKDF.cpp crypto/RandomPadding.cpp process/daemonize.cpp process/subprocess.cpp tempfile/TempFile.cpp tempfile/TempDir.cpp network/HttpClient.cpp network/CurlHttpClient.cpp network/FakeHttpClient.cpp io/Console.cpp io/DontEchoStdinToStdoutRAII.cpp io/IOStreamConsole.cpp io/NoninteractiveConsole.cpp io/pipestream.cpp thread/LoopThread.cpp thread/ThreadSystem.cpp random/Random.cpp random/RandomGeneratorThread.cpp random/OSRandomGenerator.cpp random/PseudoRandomPool.cpp random/RandomDataBuffer.cpp random/RandomGenerator.cpp lock/LockPool.cpp data/Serializer.cpp data/Deserializer.cpp data/DataFixture.cpp data/DataUtils.cpp data/Data.cpp assert/backtrace.cpp assert/AssertFailed.cpp system/get_total_memory.cpp ) add_library(${PROJECT_NAME} STATIC ${SOURCES}) target_link_libraries(${PROJECT_NAME} PUBLIC pthread curl) # TODO From Crypto++ 5.7 on, it should support cmake with find_package() instead of find_library(). find_library_with_path(CryptoPP cryptopp CRYPTOPP_LIB_PATH) target_link_libraries(${PROJECT_NAME} PUBLIC ${CryptoPP} scrypt spdlog) target_add_boost(${PROJECT_NAME} filesystem system thread) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) src/cpp-utils/assert/000077500000000000000000000000001300002025200150465ustar00rootroot00000000000000src/cpp-utils/assert/AssertFailed.cpp000066400000000000000000000000321300002025200201130ustar00rootroot00000000000000#include "AssertFailed.h" src/cpp-utils/assert/AssertFailed.h000066400000000000000000000007561300002025200175750ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_ASSERT_ASSERTFAILED_H #define MESSMER_CPPUTILS_ASSERT_ASSERTFAILED_H #include #include #include "../macros.h" namespace cpputils { class AssertFailed final: public std::exception { public: AssertFailed(const std::string &message) : _message(message) { } const char *what() const throw() override { return _message.c_str(); } private: std::string _message; }; } #endif src/cpp-utils/assert/assert.h000066400000000000000000000032151300002025200165210ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_ASSERT_ASSERT_H #define MESSMER_CPPUTILS_ASSERT_ASSERT_H /** * This implements an ASSERT(expr, msg) macro. * In a debug build, it will crash and halt the program on an assert failure. * In a release build, it will throw an AssertFailed exception instead, which can then be caught. */ #include "AssertFailed.h" #include #include "backtrace.h" #include "../logging/logging.h" namespace cpputils { namespace _assert { inline std::string format(const char *expr, const std::string &message, const char *file, int line) { std::string result = std::string()+"Assertion ["+expr+"] failed in "+file+":"+std::to_string(line)+": "+message+"\n\n" + backtrace(); return result; } inline void assert_fail_release [[noreturn]] (const char *expr, const std::string &message, const char *file, int line) { auto msg = format(expr, message, file, line); using namespace logging; LOG(ERROR) << msg; throw AssertFailed(msg); } inline void assert_fail_debug [[noreturn]] (const char *expr, const std::string &message, const char *file, int line) { using namespace logging; LOG(ERROR) << format(expr, message, file, line); abort(); } } } #ifdef NDEBUG //TODO Check whether disabling assertions in prod affects speed. # define ASSERT(expr, msg) (void)((expr) || (cpputils::_assert::assert_fail_release(#expr, msg, __FILE__, __LINE__),0)) #else # define ASSERT(expr, msg) (void)((expr) || (cpputils::_assert::assert_fail_debug(#expr, msg, __FILE__, __LINE__),0)) #endif #endif src/cpp-utils/assert/backtrace.cpp000066400000000000000000000037551300002025200175030ustar00rootroot00000000000000#include "backtrace.h" #include #include #include #include #include #include #include #include "../logging/logging.h" using std::string; using std::ostringstream; using namespace cpputils::logging; //TODO Use the following? https://github.com/bombela/backward-cpp namespace cpputils { //TODO Refactor (for example: RAII or at least try{}finally{} instead of free()) std::string demangle(const string &mangledName) { string result; int status = -10; char *demangledName = abi::__cxa_demangle(mangledName.c_str(), NULL, NULL, &status); if (status == 0) { result = demangledName; } else { result = mangledName; } free(demangledName); return result; } std::string pretty(const string &backtraceLine) { size_t startMangledName = backtraceLine.find('('); size_t endMangledName = backtraceLine.find('+'); if (startMangledName == string::npos || endMangledName == string::npos) { return backtraceLine; } return demangle(backtraceLine.substr(startMangledName+1, endMangledName-startMangledName-1)) + ": (" + backtraceLine.substr(0, startMangledName) + backtraceLine.substr(endMangledName); } string backtrace_to_string(void *array[], size_t size) { ostringstream result; char **ptr = backtrace_symbols(array, size); for (size_t i = 0; i < size; ++i) { result << pretty(ptr[i]) << "\n"; } free(ptr); return result.str(); } string backtrace() { constexpr unsigned int MAX_SIZE = 100; void *array[MAX_SIZE]; size_t size = ::backtrace(array, MAX_SIZE); return backtrace_to_string(array, size); } void sigsegv_handler(int) { LOG(ERROR) << "SIGSEGV\n" << backtrace(); exit(1); } void showBacktraceOnSigSegv() { signal(SIGSEGV, sigsegv_handler); } } src/cpp-utils/assert/backtrace.h000066400000000000000000000003301300002025200171320ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_ASSERT_BACKTRACE_H #define MESSMER_CPPUTILS_ASSERT_BACKTRACE_H #include namespace cpputils { std::string backtrace(); void showBacktraceOnSigSegv(); } #endif src/cpp-utils/crypto/000077500000000000000000000000001300002025200150655ustar00rootroot00000000000000src/cpp-utils/crypto/RandomPadding.cpp000066400000000000000000000030631300002025200203020ustar00rootroot00000000000000#include "RandomPadding.h" #include "../logging/logging.h" #include "../random/Random.h" using boost::optional; using namespace cpputils::logging; namespace cpputils { Data RandomPadding::add(const Data &data, size_t targetSize) { uint32_t size = data.size(); if (size >= targetSize - sizeof(size)) { throw std::runtime_error("Data too large. We should increase padding target size."); } Data randomData = Random::PseudoRandom().get(targetSize-sizeof(size)-size); ASSERT(sizeof(size) + size + randomData.size() == targetSize, "Calculated size of randomData incorrectly"); Data result(targetSize); std::memcpy(reinterpret_cast(result.data()), &size, sizeof(size)); std::memcpy(reinterpret_cast(result.dataOffset(sizeof(size))), reinterpret_cast(data.data()), size); std::memcpy(reinterpret_cast(result.dataOffset(sizeof(size)+size)), reinterpret_cast(randomData.data()), randomData.size()); return result; } optional RandomPadding::remove(const Data &data) { uint32_t size; std::memcpy(&size, reinterpret_cast(data.data()), sizeof(size)); if(sizeof(size) + size >= data.size()) { LOG(ERROR) << "Config file is invalid: Invalid padding."; return boost::none; }; Data result(size); std::memcpy(reinterpret_cast(result.data()), reinterpret_cast(data.dataOffset(sizeof(size))), size); return std::move(result); } } src/cpp-utils/crypto/RandomPadding.h000066400000000000000000000006061300002025200177470ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_CRYPTO_RANDOMPADDING_H #define MESSMER_CPPUTILS_CRYPTO_RANDOMPADDING_H #include "../data/Data.h" #include namespace cpputils { //TODO Test class RandomPadding final { public: static Data add(const Data &data, size_t targetSize); static boost::optional remove(const Data &data); }; } #endif src/cpp-utils/crypto/kdf/000077500000000000000000000000001300002025200156315ustar00rootroot00000000000000src/cpp-utils/crypto/kdf/PasswordBasedKDF.cpp000066400000000000000000000000361300002025200214220ustar00rootroot00000000000000#include "PasswordBasedKDF.h" src/cpp-utils/crypto/kdf/PasswordBasedKDF.h000066400000000000000000000015141300002025200210710ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_CRYPTO_KDF_PASSWORDBASEDKDF_H #define MESSMER_CPPUTILS_CRYPTO_KDF_PASSWORDBASEDKDF_H #include "../../data/FixedSizeData.h" #include "../../data/Data.h" namespace cpputils { class PasswordBasedKDF { public: virtual ~PasswordBasedKDF() {} template FixedSizeData deriveKey(const std::string &password); virtual const Data &kdfParameters() const = 0; protected: virtual void derive(void *destination, size_t size, const std::string &password) = 0; }; template FixedSizeData inline PasswordBasedKDF::deriveKey(const std::string &password) { auto result = FixedSizeData::Null(); derive(result.data(), result.BINARY_LENGTH, password); return result; } } #endif src/cpp-utils/crypto/kdf/SCryptParameters.cpp000066400000000000000000000025311300002025200216060ustar00rootroot00000000000000#include "SCryptParameters.h" using std::istream; using std::ostream; using boost::optional; using boost::none; using cpputils::Data; namespace cpputils { Data SCryptParameters::serialize() const { Serializer serializer(_serializedSize()); serializer.writeUint64(_N); serializer.writeUint32(_r); serializer.writeUint32(_p); serializer.writeTailData(_salt); return serializer.finished(); } size_t SCryptParameters::_serializedSize() const { return _salt.size() + sizeof(uint64_t) + sizeof(uint32_t) + sizeof(uint32_t); } SCryptParameters SCryptParameters::deserialize(const cpputils::Data &data) { Deserializer deserializer(&data); uint64_t N = deserializer.readUint64(); uint32_t r = deserializer.readUint32(); uint32_t p = deserializer.readUint32(); Data salt = deserializer.readTailData(); deserializer.finished(); return SCryptParameters(std::move(salt), N, r, p); } #ifndef CRYFS_NO_COMPATIBILITY SCryptParameters SCryptParameters::deserializeOldFormat(Deserializer *source) { uint64_t N = source->readUint64(); uint32_t r = source->readUint32(); uint32_t p = source->readUint32(); Data salt = source->readData(); return SCryptParameters(std::move(salt), N, r, p); } #endif } src/cpp-utils/crypto/kdf/SCryptParameters.h000066400000000000000000000042321300002025200212530ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_CRYPTO_KDF_KEYCONFIG_H #define MESSMER_CPPUTILS_CRYPTO_KDF_KEYCONFIG_H #include "../../data/Data.h" #include "../../data/Serializer.h" #include "../../data/Deserializer.h" #include namespace cpputils { //TODO Test Copy/move constructor and assignment //TODO Test operator==/!= //TODO Use SCryptSettings as a member here instead of storing _N, _r, _p. class SCryptParameters final { public: SCryptParameters(Data salt, uint64_t N, uint32_t r, uint32_t p) : _salt(std::move(salt)), _N(N), _r(r), _p(p) { } SCryptParameters(const SCryptParameters &rhs) :_salt(rhs._salt.copy()), _N(rhs._N), _r(rhs._r), _p(rhs._p) { } SCryptParameters(SCryptParameters &&rhs) = default; SCryptParameters &operator=(const SCryptParameters &rhs) { _salt = rhs._salt.copy(); _N = rhs._N; _r = rhs._r; _p = rhs._p; return *this; } SCryptParameters &operator=(SCryptParameters &&rhs) = default; const Data &salt() const { return _salt; } size_t N() const { return _N; } size_t r() const { return _r; } size_t p() const { return _p; } cpputils::Data serialize() const; static SCryptParameters deserialize(const cpputils::Data &data); #ifndef CRYFS_NO_COMPATIBILITY static SCryptParameters deserializeOldFormat(cpputils::Deserializer *deserializer); size_t serializedSize() const { return _serializedSize(); } #endif private: size_t _serializedSize() const; Data _salt; uint64_t _N; uint32_t _r; uint32_t _p; }; inline bool operator==(const SCryptParameters &lhs, const SCryptParameters &rhs) { return lhs.salt() == rhs.salt() && lhs.N() == rhs.N() && lhs.r() == rhs.r() && lhs.p() == rhs.p(); } inline bool operator!=(const SCryptParameters &lhs, const SCryptParameters &rhs) { return !operator==(lhs, rhs); } } #endif src/cpp-utils/crypto/kdf/Scrypt.cpp000066400000000000000000000035141300002025200176240ustar00rootroot00000000000000#include "Scrypt.h" using std::string; namespace cpputils { constexpr SCryptSettings SCrypt::ParanoidSettings; constexpr SCryptSettings SCrypt::DefaultSettings; constexpr SCryptSettings SCrypt::TestSettings; unique_ref SCrypt::forNewKey(const SCryptSettings &settings) { SCryptParameters kdfParameters(Random::PseudoRandom().get(settings.SALT_LEN), settings.N, settings.r, settings.p); return make_unique_ref(std::move(kdfParameters)); } unique_ref SCrypt::forExistingKey(const Data ¶meters) { return make_unique_ref(SCryptParameters::deserialize(parameters)); } SCrypt::SCrypt(SCryptParameters config) :_config(std::move(config)), _serializedConfig(_config.serialize()), _wasGeneratedBefore(false) { } void SCrypt::derive(void *destination, size_t size, const string &password) { _checkCallOnlyOnce(); int errorcode = crypto_scrypt(reinterpret_cast(password.c_str()), password.size(), reinterpret_cast(_config.salt().data()), _config.salt().size(), _config.N(), _config.r(), _config.p(), static_cast(destination), size); if (errorcode != 0) { throw std::runtime_error("Error running scrypt key derivation. Error code: "+std::to_string(errorcode)); } } const Data &SCrypt::kdfParameters() const { return _serializedConfig; } void SCrypt::_checkCallOnlyOnce() { if (_wasGeneratedBefore) { throw std::runtime_error("An SCrypt instance can only generate exactly one key. Generating multiple keys would be insecure because we would use the same salt."); } _wasGeneratedBefore = true; } }src/cpp-utils/crypto/kdf/Scrypt.h000066400000000000000000000025641300002025200172750ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_CRYPTO_KDF_SCRYPT_H #define MESSMER_CPPUTILS_CRYPTO_KDF_SCRYPT_H #include "../../macros.h" #include "../../random/Random.h" #include "../../pointer/unique_ref.h" #include "PasswordBasedKDF.h" extern "C" { #include } #include #include "SCryptParameters.h" namespace cpputils { struct SCryptSettings { size_t SALT_LEN; uint64_t N; uint32_t r; uint32_t p; }; class SCrypt final : public PasswordBasedKDF { public: static constexpr SCryptSettings ParanoidSettings = SCryptSettings {32, 1048576, 8, 16}; static constexpr SCryptSettings DefaultSettings = SCryptSettings {32, 1048576, 4, 1}; static constexpr SCryptSettings TestSettings = SCryptSettings {32, 1024, 1, 1}; static unique_ref forNewKey(const SCryptSettings &settings); static unique_ref forExistingKey(const Data ¶meters); const Data &kdfParameters() const override; SCrypt(SCryptParameters config); protected: void derive(void *destination, size_t size, const std::string &password) override; private: void _checkCallOnlyOnce(); SCryptParameters _config; Data _serializedConfig; bool _wasGeneratedBefore; DISALLOW_COPY_AND_ASSIGN(SCrypt); }; } #endif src/cpp-utils/crypto/symmetric/000077500000000000000000000000001300002025200171015ustar00rootroot00000000000000src/cpp-utils/crypto/symmetric/CFB_Cipher.h000066400000000000000000000045751300002025200211510ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_CRYPTO_SYMMETRIC_CFBCIPHER_H_ #define MESSMER_CPPUTILS_CRYPTO_SYMMETRIC_CFBCIPHER_H_ #include "../../data/FixedSizeData.h" #include "../../data/Data.h" #include "../../random/Random.h" #include #include #include "Cipher.h" namespace cpputils { template class CFB_Cipher { public: using EncryptionKey = FixedSizeData; static EncryptionKey CreateKey(RandomGenerator &randomGenerator) { return randomGenerator.getFixedSize(); } static constexpr unsigned int ciphertextSize(unsigned int plaintextBlockSize) { return plaintextBlockSize + IV_SIZE; } static constexpr unsigned int plaintextSize(unsigned int ciphertextBlockSize) { return ciphertextBlockSize - IV_SIZE; } static Data encrypt(const byte *plaintext, unsigned int plaintextSize, const EncryptionKey &encKey); static boost::optional decrypt(const byte *ciphertext, unsigned int ciphertextSize, const EncryptionKey &encKey); private: static constexpr unsigned int IV_SIZE = BlockCipher::BLOCKSIZE; }; template Data CFB_Cipher::encrypt(const byte *plaintext, unsigned int plaintextSize, const EncryptionKey &encKey) { FixedSizeData iv = Random::PseudoRandom().getFixedSize(); auto encryption = typename CryptoPP::CFB_Mode::Encryption(encKey.data(), encKey.BINARY_LENGTH, iv.data()); Data ciphertext(ciphertextSize(plaintextSize)); std::memcpy(ciphertext.data(), iv.data(), IV_SIZE); encryption.ProcessData((byte*)ciphertext.data() + IV_SIZE, plaintext, plaintextSize); return ciphertext; } template boost::optional CFB_Cipher::decrypt(const byte *ciphertext, unsigned int ciphertextSize, const EncryptionKey &encKey) { if (ciphertextSize < IV_SIZE) { return boost::none; } const byte *ciphertextIV = ciphertext; const byte *ciphertextData = ciphertext + IV_SIZE; auto decryption = typename CryptoPP::CFB_Mode::Decryption((byte*)encKey.data(), encKey.BINARY_LENGTH, ciphertextIV); Data plaintext(plaintextSize(ciphertextSize)); decryption.ProcessData((byte*)plaintext.data(), ciphertextData, plaintext.size()); return std::move(plaintext); } } #endif src/cpp-utils/crypto/symmetric/Cipher.h000066400000000000000000000016151300002025200204670ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_CRYPTO_SYMMETRIC_CIPHER_H_ #define MESSMER_CPPUTILS_CRYPTO_SYMMETRIC_CIPHER_H_ #include #include #include "../../data/Data.h" #include "../../random/Random.h" using std::string; namespace cpputils { template struct CipherConcept { public: BOOST_CONCEPT_USAGE(CipherConcept) { same_type(UINT32_C(0), X::ciphertextSize(UINT32_C(5))); same_type(UINT32_C(0), X::plaintextSize(UINT32_C(5))); typename X::EncryptionKey key = X::CreateKey(Random::OSRandom()); same_type(Data(0), X::encrypt((uint8_t*)nullptr, UINT32_C(0), key)); same_type(boost::optional(Data(0)), X::decrypt((uint8_t*)nullptr, UINT32_C(0), key)); string name = X::NAME; } private: // Type deduction will fail unless the arguments have the same type. template void same_type(T const&, T const&); }; } #endif src/cpp-utils/crypto/symmetric/GCM_Cipher.h000066400000000000000000000061521300002025200211560ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_CRYPTO_SYMMETRIC_GCMCIPHER_H_ #define MESSMER_CPPUTILS_CRYPTO_SYMMETRIC_GCMCIPHER_H_ #include "../../data/FixedSizeData.h" #include "../../data/Data.h" #include "../../random/Random.h" #include #include "Cipher.h" namespace cpputils { template class GCM_Cipher { public: using EncryptionKey = FixedSizeData; static EncryptionKey CreateKey(RandomGenerator &randomGenerator) { return randomGenerator.getFixedSize(); } static constexpr unsigned int ciphertextSize(unsigned int plaintextBlockSize) { return plaintextBlockSize + IV_SIZE + TAG_SIZE; } static constexpr unsigned int plaintextSize(unsigned int ciphertextBlockSize) { return ciphertextBlockSize - IV_SIZE - TAG_SIZE; } static Data encrypt(const byte *plaintext, unsigned int plaintextSize, const EncryptionKey &encKey); static boost::optional decrypt(const byte *ciphertext, unsigned int ciphertextSize, const EncryptionKey &encKey); private: static constexpr unsigned int IV_SIZE = BlockCipher::BLOCKSIZE; static constexpr unsigned int TAG_SIZE = 16; }; template Data GCM_Cipher::encrypt(const byte *plaintext, unsigned int plaintextSize, const EncryptionKey &encKey) { FixedSizeData iv = Random::PseudoRandom().getFixedSize(); typename CryptoPP::GCM::Encryption encryption; encryption.SetKeyWithIV(encKey.data(), encKey.BINARY_LENGTH, iv.data(), IV_SIZE); Data ciphertext(ciphertextSize(plaintextSize)); std::memcpy(ciphertext.data(), iv.data(), IV_SIZE); CryptoPP::ArraySource(plaintext, plaintextSize, true, new CryptoPP::AuthenticatedEncryptionFilter(encryption, new CryptoPP::ArraySink((byte*)ciphertext.data() + IV_SIZE, ciphertext.size() - IV_SIZE), false, TAG_SIZE ) ); return ciphertext; } template boost::optional GCM_Cipher::decrypt(const byte *ciphertext, unsigned int ciphertextSize, const EncryptionKey &encKey) { if (ciphertextSize < IV_SIZE + TAG_SIZE) { return boost::none; } const byte *ciphertextIV = ciphertext; const byte *ciphertextData = ciphertext + IV_SIZE; typename CryptoPP::GCM::Decryption decryption; decryption.SetKeyWithIV((byte*)encKey.data(), encKey.BINARY_LENGTH, ciphertextIV, IV_SIZE); Data plaintext(plaintextSize(ciphertextSize)); try { CryptoPP::ArraySource((byte*)ciphertextData, ciphertextSize - IV_SIZE, true, new CryptoPP::AuthenticatedDecryptionFilter(decryption, new CryptoPP::ArraySink((byte*)plaintext.data(), plaintext.size()), CryptoPP::AuthenticatedDecryptionFilter::DEFAULT_FLAGS, TAG_SIZE ) ); return std::move(plaintext); } catch (const CryptoPP::HashVerificationFilter::HashVerificationFailed &e) { return boost::none; } } } #endif src/cpp-utils/crypto/symmetric/ciphers.cpp000066400000000000000000000021351300002025200212430ustar00rootroot00000000000000#include "ciphers.h" #define DEFINE_CIPHER(InstanceName) \ constexpr const char *InstanceName::NAME; \ namespace cpputils { DEFINE_CIPHER(AES256_GCM); DEFINE_CIPHER(AES256_CFB); DEFINE_CIPHER(AES128_GCM); DEFINE_CIPHER(AES128_CFB); DEFINE_CIPHER(Twofish256_GCM); DEFINE_CIPHER(Twofish256_CFB); DEFINE_CIPHER(Twofish128_GCM); DEFINE_CIPHER(Twofish128_CFB); DEFINE_CIPHER(Serpent256_GCM); DEFINE_CIPHER(Serpent256_CFB); DEFINE_CIPHER(Serpent128_GCM); DEFINE_CIPHER(Serpent128_CFB); DEFINE_CIPHER(Cast256_GCM); DEFINE_CIPHER(Cast256_CFB); #if CRYPTOPP_VERSION != 564 DEFINE_CIPHER(Mars448_GCM); DEFINE_CIPHER(Mars448_CFB); #else # warning "You're using Crypto++ 5.6.4. In this version, the MARS-448 cipher is not available. Your CryFS executable will not be able to load file systems using this cipher. Please use Crypto++ 5.6.3 or 5.6.5+ instead." #endif DEFINE_CIPHER(Mars256_GCM); DEFINE_CIPHER(Mars256_CFB); DEFINE_CIPHER(Mars128_GCM); DEFINE_CIPHER(Mars128_CFB); } src/cpp-utils/crypto/symmetric/ciphers.h000066400000000000000000000057171300002025200207210ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_CRYPTO_SYMMETRIC_CIPHERS_H_ #define MESSMER_CPPUTILS_CRYPTO_SYMMETRIC_CIPHERS_H_ #include #include #include #include #include #include "GCM_Cipher.h" #include "CFB_Cipher.h" #define DECLARE_CIPHER(InstanceName, StringName, Mode, Base, Keysize) \ class InstanceName final: public Mode { \ public: \ BOOST_CONCEPT_ASSERT((CipherConcept)); \ static constexpr const char *NAME = StringName; \ } \ namespace cpputils { static_assert(32 == CryptoPP::AES::MAX_KEYLENGTH, "If AES offered larger keys, we should offer a variant with it"); DECLARE_CIPHER(AES256_GCM, "aes-256-gcm", GCM_Cipher, CryptoPP::AES, 32); DECLARE_CIPHER(AES256_CFB, "aes-256-cfb", CFB_Cipher, CryptoPP::AES, 32); DECLARE_CIPHER(AES128_GCM, "aes-128-gcm", GCM_Cipher, CryptoPP::AES, 16); DECLARE_CIPHER(AES128_CFB, "aes-128-cfb", CFB_Cipher, CryptoPP::AES, 16); static_assert(32 == CryptoPP::Twofish::MAX_KEYLENGTH, "If Twofish offered larger keys, we should offer a variant with it"); DECLARE_CIPHER(Twofish256_GCM, "twofish-256-gcm", GCM_Cipher, CryptoPP::Twofish, 32); DECLARE_CIPHER(Twofish256_CFB, "twofish-256-cfb", CFB_Cipher, CryptoPP::Twofish, 32); DECLARE_CIPHER(Twofish128_GCM, "twofish-128-gcm", GCM_Cipher, CryptoPP::Twofish, 16); DECLARE_CIPHER(Twofish128_CFB, "twofish-128-cfb", CFB_Cipher, CryptoPP::Twofish, 16); static_assert(32 == CryptoPP::Serpent::MAX_KEYLENGTH, "If Serpent offered larger keys, we should offer a variant with it"); DECLARE_CIPHER(Serpent256_GCM, "serpent-256-gcm", GCM_Cipher, CryptoPP::Serpent, 32); DECLARE_CIPHER(Serpent256_CFB, "serpent-256-cfb", CFB_Cipher, CryptoPP::Serpent, 32); DECLARE_CIPHER(Serpent128_GCM, "serpent-128-gcm", GCM_Cipher, CryptoPP::Serpent, 16); DECLARE_CIPHER(Serpent128_CFB, "serpent-128-cfb", CFB_Cipher, CryptoPP::Serpent, 16); static_assert(32 == CryptoPP::CAST256::MAX_KEYLENGTH, "If Cast offered larger keys, we should offer a variant with it"); DECLARE_CIPHER(Cast256_GCM, "cast-256-gcm", GCM_Cipher, CryptoPP::CAST256, 32); DECLARE_CIPHER(Cast256_CFB, "cast-256-cfb", CFB_Cipher, CryptoPP::CAST256, 32); #if CRYPTOPP_VERSION != 564 static_assert(56 == CryptoPP::MARS::MAX_KEYLENGTH, "If Mars offered larger keys, we should offer a variant with it"); DECLARE_CIPHER(Mars448_GCM, "mars-448-gcm", GCM_Cipher, CryptoPP::MARS, 56); DECLARE_CIPHER(Mars448_CFB, "mars-448-cfb", CFB_Cipher, CryptoPP::MARS, 56); #endif DECLARE_CIPHER(Mars256_GCM, "mars-256-gcm", GCM_Cipher, CryptoPP::MARS, 32); DECLARE_CIPHER(Mars256_CFB, "mars-256-cfb", CFB_Cipher, CryptoPP::MARS, 32); DECLARE_CIPHER(Mars128_GCM, "mars-128-gcm", GCM_Cipher, CryptoPP::MARS, 16); DECLARE_CIPHER(Mars128_CFB, "mars-128-cfb", CFB_Cipher, CryptoPP::MARS, 16); } #endif src/cpp-utils/data/000077500000000000000000000000001300002025200144565ustar00rootroot00000000000000src/cpp-utils/data/Data.cpp000066400000000000000000000015001300002025200160270ustar00rootroot00000000000000#include "Data.h" #include using std::istream; using std::ofstream; using std::ifstream; using std::ios; namespace bf = boost::filesystem; namespace cpputils { boost::optional Data::LoadFromFile(const bf::path &filepath) { ifstream file(filepath.c_str(), ios::binary); if (!file.good()) { return boost::none; } return LoadFromStream(file); } std::streampos Data::_getStreamSize(istream &stream) { auto current_pos = stream.tellg(); //Retrieve length stream.seekg(0, stream.end); auto endpos = stream.tellg(); //Restore old position stream.seekg(current_pos, stream.beg); return endpos - current_pos; } Data Data::LoadFromStream(istream &stream, size_t size) { Data result(size); stream.read(static_cast(result.data()), result.size()); return std::move(result); } } src/cpp-utils/data/Data.h000066400000000000000000000064661300002025200155140ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_DATA_DATA_H_ #define MESSMER_CPPUTILS_DATA_DATA_H_ #include #include #include #include "../macros.h" #include #include namespace cpputils { class Data final { public: explicit Data(size_t size); ~Data(); Data(Data &&rhs); // move constructor Data &operator=(Data &&rhs); // move assignment Data copy() const; void *data(); const void *data() const; //TODO Test dataOffset void *dataOffset(size_t offset); const void *dataOffset(size_t offset) const; size_t size() const; Data &FillWithZeroes(); void StoreToFile(const boost::filesystem::path &filepath) const; static boost::optional LoadFromFile(const boost::filesystem::path &filepath); //TODO Test LoadFromStream/StoreToStream static Data LoadFromStream(std::istream &stream); static Data LoadFromStream(std::istream &stream, size_t size); void StoreToStream(std::ostream &stream) const; private: size_t _size; void *_data; static std::streampos _getStreamSize(std::istream &stream); void _readFromStream(std::istream &stream); DISALLOW_COPY_AND_ASSIGN(Data); }; bool operator==(const Data &lhs, const Data &rhs); bool operator!=(const Data &lhs, const Data &rhs); // --------------------------- // Inline function definitions // --------------------------- inline Data::Data(size_t size) : _size(size), _data(std::malloc(size)) { if (nullptr == _data) { throw std::bad_alloc(); } } inline Data::Data(Data &&rhs) : _size(rhs._size), _data(rhs._data) { // Make rhs invalid, so the memory doesn't get freed in its destructor. rhs._data = nullptr; rhs._size = 0; } inline Data &Data::operator=(Data &&rhs) { std::free(_data); _data = rhs._data; _size = rhs._size; rhs._data = nullptr; rhs._size = 0; return *this; } inline Data::~Data() { std::free(_data); _data = nullptr; } inline Data Data::copy() const { Data copy(_size); std::memcpy(copy._data, _data, _size); return copy; } inline void *Data::data() { return const_cast(const_cast(this)->data()); } inline const void *Data::data() const { return _data; } inline void *Data::dataOffset(size_t offset) { return const_cast(const_cast(this)->dataOffset(offset)); } inline const void *Data::dataOffset(size_t offset) const { return static_cast(data()) + offset; } inline size_t Data::size() const { return _size; } inline Data &Data::FillWithZeroes() { std::memset(_data, 0, _size); return *this; } inline void Data::StoreToFile(const boost::filesystem::path &filepath) const { std::ofstream file(filepath.c_str(), std::ios::binary | std::ios::trunc); if (!file.good()) { throw std::runtime_error("Could not open file for writing"); } StoreToStream(file); } inline void Data::StoreToStream(std::ostream &stream) const { stream.write(static_cast(_data), _size); } inline Data Data::LoadFromStream(std::istream &stream) { return LoadFromStream(stream, _getStreamSize(stream)); } inline bool operator==(const Data &lhs, const Data &rhs) { return lhs.size() == rhs.size() && 0 == memcmp(lhs.data(), rhs.data(), lhs.size()); } inline bool operator!=(const Data &lhs, const Data &rhs) { return !operator==(lhs, rhs); } } #endif src/cpp-utils/data/DataFixture.cpp000066400000000000000000000014421300002025200174030ustar00rootroot00000000000000#include "DataFixture.h" namespace cpputils { Data DataFixture::generate(size_t size, long long int seed) { Data result(size); long long int val = seed; for(size_t i=0; i(result.data())[i] = val; } uint64_t alreadyWritten = (size/sizeof(long long int))*sizeof(long long int); val *= 6364136223846793005L; val += 1442695040888963407; char *remainingBytes = reinterpret_cast(&val); //Fill remaining bytes for(size_t i=0; i(result.data())[alreadyWritten + i] = remainingBytes[i]; } return result; } } src/cpp-utils/data/DataFixture.h000066400000000000000000000011731300002025200170510ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_DATA_DATAFIXTURE_H_ #define MESSMER_CPPUTILS_DATA_DATAFIXTURE_H_ #include "Data.h" #include "FixedSizeData.h" namespace cpputils { class DataFixture final { public: static Data generate(size_t size, long long int seed = 1); //TODO Test template static FixedSizeData generateFixedSize(long long int seed = 1); }; template FixedSizeData DataFixture::generateFixedSize(long long int seed) { Data data = generate(SIZE, seed); auto result = FixedSizeData::Null(); std::memcpy(result.data(), data.data(), SIZE); return result; } } #endif src/cpp-utils/data/DataUtils.cpp000066400000000000000000000006061300002025200170560ustar00rootroot00000000000000#include "DataUtils.h" namespace cpputils { namespace DataUtils { Data resize(Data data, size_t newSize) { Data newData(newSize); newData.FillWithZeroes(); // TODO Only fill region after copied old data with zeroes std::memcpy(newData.data(), data.data(), std::min(newData.size(), data.size())); return newData; } } }src/cpp-utils/data/DataUtils.h000066400000000000000000000007101300002025200165170ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_DATA_DATAUTILS_H #define MESSMER_CPPUTILS_DATA_DATAUTILS_H #include "Data.h" namespace cpputils { namespace DataUtils { //TODO Test //Return a new data object with the given size and initialize as much as possible with the given input data. //If the new data object is larger, then the remaining bytes will be zero filled. Data resize(Data data, size_t newSize); } } #endif src/cpp-utils/data/Deserializer.cpp000066400000000000000000000000321300002025200175770ustar00rootroot00000000000000#include "Deserializer.h" src/cpp-utils/data/Deserializer.h000066400000000000000000000070501300002025200172530ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_DATA_DESERIALIZER_H #define MESSMER_CPPUTILS_DATA_DESERIALIZER_H #include "Data.h" #include "../macros.h" #include "../assert/assert.h" namespace cpputils { class Deserializer final { public: Deserializer(const Data *source); uint8_t readUint8(); int8_t readInt8(); uint16_t readUint16(); int16_t readInt16(); uint32_t readUint32(); int32_t readInt32(); uint64_t readUint64(); int64_t readInt64(); std::string readString(); Data readData(); Data readTailData(); void finished(); private: template DataType _read(); Data _readData(size_t size); size_t _pos; const Data *_source; DISALLOW_COPY_AND_ASSIGN(Deserializer); }; inline Deserializer::Deserializer(const Data *source): _pos(0), _source(source) { } inline uint8_t Deserializer::readUint8() { return _read(); } inline int8_t Deserializer::readInt8() { return _read(); } inline uint16_t Deserializer::readUint16() { return _read(); } inline int16_t Deserializer::readInt16() { return _read(); } inline uint32_t Deserializer::readUint32() { return _read(); } inline int32_t Deserializer::readInt32() { return _read(); } inline uint64_t Deserializer::readUint64() { return _read(); } inline int64_t Deserializer::readInt64() { return _read(); } template inline DataType Deserializer::_read() { static_assert(std::is_pod::value, "Can only deserialize PODs"); if (_pos + sizeof(DataType) > _source->size()) { throw std::runtime_error("Deserialization failed - size overflow"); } DataType result = *reinterpret_cast(_source->dataOffset(_pos)); _pos += sizeof(DataType); return result; } inline Data Deserializer::readData() { uint64_t size = readUint64(); if (_pos + size > _source->size()) { throw std::runtime_error("Deserialization failed - size overflow"); } return _readData(size); } inline Data Deserializer::readTailData() { uint64_t size = _source->size() - _pos; return _readData(size); } inline Data Deserializer::_readData(size_t size) { Data result(size); std::memcpy(static_cast(result.data()), static_cast(_source->dataOffset(_pos)), size); _pos += size; return result; } inline std::string Deserializer::readString() { //TODO Test whether that works when string ends (a) at beginning (b) in middle (c) at end of data region const void *nullbytepos = std::memchr(_source->dataOffset(_pos), '\0', _source->size()-_pos); if (nullbytepos == nullptr) { throw std::runtime_error("Deserialization failed - missing nullbyte for string termination"); } uint64_t size = static_cast(nullbytepos) - static_cast(_source->dataOffset(_pos)); std::string result(reinterpret_cast(_source->dataOffset(_pos)), size); _pos += size + 1; return result; } inline void Deserializer::finished() { if (_pos != _source->size()) { throw std::runtime_error("Deserialization failed - size not fully used."); } } } #endif src/cpp-utils/data/FixedSizeData.h000066400000000000000000000072401300002025200173160ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_DATA_FIXEDSIZEDATA_H_ #define MESSMER_CPPUTILS_DATA_FIXEDSIZEDATA_H_ #include #include #include #include "../assert/assert.h" namespace cpputils { template class FixedSizeData final { public: //Non-virtual destructor because we want objects to be small ~FixedSizeData() {} static constexpr size_t BINARY_LENGTH = SIZE; static constexpr size_t STRING_LENGTH = 2 * BINARY_LENGTH; // Hex encoding //TODO Test Null() static FixedSizeData Null(); static FixedSizeData FromString(const std::string &data); std::string ToString() const; static FixedSizeData FromBinary(const void *source); void ToBinary(void *target) const; const unsigned char *data() const; unsigned char *data(); template FixedSizeData take() const; template FixedSizeData drop() const; private: FixedSizeData() {} template friend class FixedSizeData; unsigned char _data[BINARY_LENGTH]; }; template bool operator==(const FixedSizeData &lhs, const FixedSizeData &rhs); template bool operator!=(const FixedSizeData &lhs, const FixedSizeData &rhs); // ----- Implementation ----- template constexpr size_t FixedSizeData::BINARY_LENGTH; template constexpr size_t FixedSizeData::STRING_LENGTH; template FixedSizeData FixedSizeData::Null() { FixedSizeData result; std::memset(result._data, 0, BINARY_LENGTH); return result; } template FixedSizeData FixedSizeData::FromString(const std::string &data) { ASSERT(data.size() == STRING_LENGTH, "Wrong string size for parsing FixedSizeData"); FixedSizeData result; CryptoPP::StringSource(data, true, new CryptoPP::HexDecoder( new CryptoPP::ArraySink(result._data, BINARY_LENGTH) ) ); return result; } template std::string FixedSizeData::ToString() const { std::string result; CryptoPP::ArraySource(_data, BINARY_LENGTH, true, new CryptoPP::HexEncoder( new CryptoPP::StringSink(result) ) ); ASSERT(result.size() == STRING_LENGTH, "Created wrongly sized string"); return result; } template const unsigned char *FixedSizeData::data() const { return _data; } template unsigned char *FixedSizeData::data() { return const_cast(const_cast*>(this)->data()); } template void FixedSizeData::ToBinary(void *target) const { std::memcpy(target, _data, BINARY_LENGTH); } template FixedSizeData FixedSizeData::FromBinary(const void *source) { FixedSizeData result; std::memcpy(result._data, source, BINARY_LENGTH); return result; } template template FixedSizeData FixedSizeData::take() const { static_assert(size <= SIZE, "Out of bounds"); FixedSizeData result; std::memcpy(result._data, _data, size); return result; } template template FixedSizeData FixedSizeData::drop() const { static_assert(size <= SIZE, "Out of bounds"); FixedSizeData result; std::memcpy(result._data, _data+size, SIZE-size); return result; } template bool operator==(const FixedSizeData &lhs, const FixedSizeData &rhs) { return 0 == std::memcmp(lhs.data(), rhs.data(), FixedSizeData::BINARY_LENGTH); } template bool operator!=(const FixedSizeData &lhs, const FixedSizeData &rhs) { return !operator==(lhs, rhs); } } #endif src/cpp-utils/data/Serializer.cpp000066400000000000000000000000301300002025200172640ustar00rootroot00000000000000#include "Serializer.h" src/cpp-utils/data/Serializer.h000066400000000000000000000102571300002025200167450ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_DATA_SERIALIZER_H #define MESSMER_CPPUTILS_DATA_SERIALIZER_H #include "Data.h" #include "../macros.h" #include "../assert/assert.h" #include namespace cpputils { //TODO Test Serializer/Deserializer //TODO Also test system (big endian/little endian) by adding a serialized data file to the repository and (a) reading it and (b) rewriting and comparing it class Serializer final { public: Serializer(size_t size); void writeUint8(uint8_t value); void writeInt8(int8_t value); void writeUint16(uint16_t value); void writeInt16(int16_t value); void writeUint32(uint32_t value); void writeInt32(int32_t value); void writeUint64(uint64_t value); void writeInt64(int64_t value); void writeString(const std::string &value); void writeData(const Data &value); // Write the data as last element when serializing. // It does not store a data size but limits the size by the size of the serialization result void writeTailData(const Data &value); static size_t DataSize(const Data &value); static size_t StringSize(const std::string &value); Data finished(); private: template void _write(DataType obj); void _writeData(const Data &value); size_t _pos; Data _result; DISALLOW_COPY_AND_ASSIGN(Serializer); }; inline Serializer::Serializer(size_t size): _pos(0), _result(size) { } inline void Serializer::writeUint8(uint8_t value) { _write(value); } inline void Serializer::writeInt8(int8_t value) { _write(value); } inline void Serializer::writeUint16(uint16_t value) { _write(value); } inline void Serializer::writeInt16(int16_t value) { _write(value); } inline void Serializer::writeUint32(uint32_t value) { _write(value); } inline void Serializer::writeInt32(int32_t value) { _write(value); } inline void Serializer::writeUint64(uint64_t value) { _write(value); } inline void Serializer::writeInt64(int64_t value) { _write(value); } template inline void Serializer::_write(DataType obj) { static_assert(std::is_pod::value, "Can only serialize PODs"); if (_pos + sizeof(DataType) > _result.size()) { throw std::runtime_error("Serialization failed - size overflow"); } *reinterpret_cast(_result.dataOffset(_pos)) = obj; _pos += sizeof(DataType); } inline void Serializer::writeData(const Data &data) { writeUint64(data.size()); _writeData(data); } inline size_t Serializer::DataSize(const Data &data) { return sizeof(uint64_t) + data.size(); } inline void Serializer::writeTailData(const Data &data) { ASSERT(_pos + data.size() == _result.size(), "Not enough data given to write until the end of the stream"); _writeData(data); } inline void Serializer::_writeData(const Data &data) { if (_pos + data.size() > _result.size()) { throw std::runtime_error("Serialization failed - size overflow"); } std::memcpy(static_cast(_result.dataOffset(_pos)), static_cast(data.data()), data.size()); _pos += data.size(); } inline void Serializer::writeString(const std::string &value) { size_t size = value.size() + 1; // +1 for the nullbyte if (_pos + size > _result.size()) { throw std::runtime_error("Serialization failed - size overflow"); } std::memcpy(static_cast(_result.dataOffset(_pos)), value.c_str(), size); _pos += size; } inline size_t Serializer::StringSize(const std::string &value) { return value.size() + 1; // +1 for nullbyte } inline Data Serializer::finished() { if (_pos != _result.size()) { throw std::runtime_error("Serialization failed - size not fully used."); } return std::move(_result); } } #endif src/cpp-utils/either.h000066400000000000000000000147131300002025200152040ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_EITHER_H #define MESSMER_CPPUTILS_EITHER_H #include #include namespace cpputils { template class either final { public: //TODO Try allowing construction with any type that std::is_convertible to Left or Right. either(const Left &left): _side(Side::left) { _construct_left(left); } either(Left &&left): _side(Side::left) { _construct_left(std::move(left)); } either(const Right &right): _side(Side::right) { _construct_right(right); } either(Right &&right): _side(Side::right) { _construct_right(std::move(right)); } //TODO Try allowing copy-construction when Left/Right types are std::is_convertible either(const either &rhs): _side(rhs._side) { if(_side == Side::left) { _construct_left(rhs._left); } else { _construct_right(rhs._right); } } either(either &&rhs): _side(rhs._side) { if(_side == Side::left) { _construct_left(std::move(rhs._left)); } else { _construct_right(std::move(rhs._right)); } } ~either() { _destruct(); } //TODO Try allowing copy-assignment when Left/Right types are std::is_convertible either &operator=(const either &rhs) { _destruct(); _side = rhs._side; if (_side == Side::left) { _construct_left(rhs._left); } else { _construct_right(rhs._right); } return *this; } either &operator=(either &&rhs) { _destruct(); _side = rhs._side; if (_side == Side::left) { _construct_left(std::move(rhs._left)); } else { _construct_right(std::move(rhs._right)); } return *this; } //TODO fold, map_left, map_right, left_or_else(val), right_or_else(val), left_or_else(func), right_or_else(func) bool is_left() const { return _side == Side::left; } bool is_right() const { return _side == Side::right; } const Left &left() const& { return _left; } Left &left() & { return const_cast(const_cast*>(this)->left()); } Left &&left() && { return std::move(left()); } const Right &right() const& { return _right; } Right &right() & { return const_cast(const_cast*>(this)->right()); } Right &&right() && { return std::move(right()); } boost::optional left_opt() const& { if (_side == Side::left) { return _left; } else { return boost::none; } } boost::optional left_opt() & { if (_side == Side::left) { return _left; } else { return boost::none; } } boost::optional left_opt() && { if (_side == Side::left) { return std::move(_left); } else { return boost::none; } } boost::optional right_opt() const& { if (_side == Side::right) { return _right; } else { return boost::none; } } boost::optional right_opt() & { if (_side == Side::right) { return _right; } else { return boost::none; } } boost::optional right_opt() && { if (_side == Side::right) { return std::move(_right); } else { return boost::none; } } private: union { Left _left; Right _right; }; enum class Side : unsigned char {left, right} _side; either(Side side): _side(side) {} template void _construct_left(Args&&... args) { new(&_left)Left(std::forward(args)...); } template void _construct_right(Args&&... args) { new(&_right)Right(std::forward(args)...); } void _destruct() { if (_side == Side::left) { _left.~Left(); } else { _right.~Right(); } } template friend either make_left(Args&&... args); template friend either make_right(Args&&... args); }; template bool operator==(const either &lhs, const either &rhs) { if (lhs.is_left() != rhs.is_left()) { return false; } if (lhs.is_left()) { return lhs.left() == rhs.left(); } else { return lhs.right() == rhs.right(); } } template bool operator!=(const either &lhs, const either &rhs) { return !operator==(lhs, rhs); } template std::ostream &operator<<(std::ostream &stream, const either &value) { if (value.is_left()) { stream << "Left(" << value.left() << ")"; } else { stream << "Right(" << value.right() << ")"; } return stream; } template either make_left(Args&&... args) { either result(either::Side::left); result._construct_left(std::forward(args)...); return result; } template either make_right(Args&&... args) { either result(either::Side::right); result._construct_right(std::forward(args)...); return result; } } #endif src/cpp-utils/io/000077500000000000000000000000001300002025200141545ustar00rootroot00000000000000src/cpp-utils/io/Console.cpp000066400000000000000000000000261300002025200162600ustar00rootroot00000000000000#include "Console.h" src/cpp-utils/io/Console.h000066400000000000000000000012051300002025200157250ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_IO_CONSOLE_H #define MESSMER_CPPUTILS_IO_CONSOLE_H #include #include #include #include #include "../macros.h" #include "../pointer/unique_ref.h" namespace cpputils { class Console { public: virtual ~Console() {} virtual unsigned int ask(const std::string &question, const std::vector &options) = 0; virtual bool askYesNo(const std::string &question, bool defaultValue) = 0; // NoninteractiveConsole will just return the default value without asking the user. virtual void print(const std::string &output) = 0; }; } #endif src/cpp-utils/io/DontEchoStdinToStdoutRAII.cpp000066400000000000000000000000471300002025200215410ustar00rootroot00000000000000#include "DontEchoStdinToStdoutRAII.h" src/cpp-utils/io/DontEchoStdinToStdoutRAII.h000066400000000000000000000017371300002025200212150ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_IO_DONTECHOSTDINTOSTDOUTRAII_H #define MESSMER_CPPUTILS_IO_DONTECHOSTDINTOSTDOUTRAII_H #include #include #include #include #include "../macros.h" namespace cpputils { /** * If you create an instance of this class in your scope, then any user input from stdin * won't be echoed back to stdout until the instance leaves the scope. * This can be very handy for password inputs where you don't want the password to be visible on screen. */ class DontEchoStdinToStdoutRAII final { public: DontEchoStdinToStdoutRAII() { tcgetattr(STDIN_FILENO, &_old_state); termios new_state = _old_state; new_state.c_lflag &= ~ECHO; tcsetattr(STDIN_FILENO, TCSANOW, &new_state); } ~DontEchoStdinToStdoutRAII() { tcsetattr(STDIN_FILENO, TCSANOW, &_old_state); } private: termios _old_state; DISALLOW_COPY_AND_ASSIGN(DontEchoStdinToStdoutRAII); }; } #endif src/cpp-utils/io/IOStreamConsole.cpp000066400000000000000000000060401300002025200176660ustar00rootroot00000000000000#include "IOStreamConsole.h" #include using std::ostream; using std::istream; using std::string; using std::vector; using std::flush; using std::function; using boost::optional; using boost::none; namespace cpputils { IOStreamConsole::IOStreamConsole(): IOStreamConsole(std::cout, std::cin) { } IOStreamConsole::IOStreamConsole(ostream &output, istream &input): _output(output), _input(input) { } optional IOStreamConsole::_parseInt(const string &str) { try { string trimmed = str; boost::algorithm::trim(trimmed); int parsed = std::stoi(str); if (std::to_string(parsed) != trimmed) { return none; } return parsed; } catch (const std::invalid_argument &e) { return none; } catch (const std::out_of_range &e) { return none; } } function(const string &input)> IOStreamConsole::_parseUIntWithMinMax(unsigned int min, unsigned int max) { return [min, max] (const string &input) { optional parsed = _parseInt(input); if (parsed == none) { return optional(none); } unsigned int value = static_cast(*parsed); if (value < min || value > max) { return optional(none); } return optional(value); }; } template Return IOStreamConsole::_askForChoice(const string &question, function (const string&)> parse) { optional choice = none; do { _output << question << flush; string choiceStr; getline(_input, choiceStr); choice = parse(choiceStr); } while(choice == none); return *choice; } unsigned int IOStreamConsole::ask(const string &question, const vector &options) { if(options.size() == 0) { throw std::invalid_argument("options should have at least one entry"); } _output << question << "\n"; for (unsigned int i = 0; i < options.size(); ++i) { _output << " [" << (i+1) << "] " << options[i] << "\n"; } int choice = _askForChoice("Your choice [1-" + std::to_string(options.size()) + "]: ", _parseUIntWithMinMax(1, options.size())); return choice-1; } function(const string &input)> IOStreamConsole::_parseYesNo() { return [] (const string &input) { string trimmed = input; boost::algorithm::trim(trimmed); if(trimmed == "Y" || trimmed == "y" || trimmed == "Yes" || trimmed == "yes") { return optional(true); } else if (trimmed == "N" || trimmed == "n" || trimmed == "No" || trimmed == "no") { return optional(false); } else { return optional(none); } }; } bool IOStreamConsole::askYesNo(const string &question, bool /*defaultValue*/) { _output << question << "\n"; return _askForChoice("Your choice [y/n]: ", _parseYesNo()); } void IOStreamConsole::print(const std::string &output) { _output << output << std::flush; } } src/cpp-utils/io/IOStreamConsole.h000066400000000000000000000022101300002025200173260ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_IO_IOSTREAMCONSOLE_H #define MESSMER_CPPUTILS_IO_IOSTREAMCONSOLE_H #include "Console.h" namespace cpputils { class IOStreamConsole final: public Console { public: IOStreamConsole(); IOStreamConsole(std::ostream &output, std::istream &input); unsigned int ask(const std::string &question, const std::vector &options) override; bool askYesNo(const std::string &question, bool defaultValue) override; void print(const std::string &output) override; private: template Return _askForChoice(const std::string &question, std::function (const std::string&)> parse); static std::function(const std::string &input)> _parseYesNo(); static std::function(const std::string &input)> _parseUIntWithMinMax(unsigned int min, unsigned int max); static boost::optional _parseInt(const std::string &str); std::ostream &_output; std::istream &_input; DISALLOW_COPY_AND_ASSIGN(IOStreamConsole); }; } #endif src/cpp-utils/io/NoninteractiveConsole.cpp000066400000000000000000000012221300002025200211700ustar00rootroot00000000000000#include "NoninteractiveConsole.h" using std::string; using std::vector; using std::shared_ptr; namespace cpputils { NoninteractiveConsole::NoninteractiveConsole(shared_ptr baseConsole): _baseConsole(std::move(baseConsole)) { } bool NoninteractiveConsole::askYesNo(const string &/*question*/, bool defaultValue) { return defaultValue; } void NoninteractiveConsole::print(const std::string &output) { _baseConsole->print(output); } unsigned int NoninteractiveConsole::ask(const string &/*question*/, const vector &/*options*/) { throw std::logic_error("Tried to ask a multiple choice question in noninteractive mode"); } } src/cpp-utils/io/NoninteractiveConsole.h000066400000000000000000000013311300002025200206360ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_IO_NONINTERACTIVECONSOLE_H #define MESSMER_CPPUTILS_IO_NONINTERACTIVECONSOLE_H #include "Console.h" namespace cpputils { //TODO Add test cases for NoninteractiveConsole class NoninteractiveConsole final: public Console { public: NoninteractiveConsole(std::shared_ptr baseConsole); unsigned int ask(const std::string &question, const std::vector &options) override; bool askYesNo(const std::string &question, bool defaultValue) override; void print(const std::string &output) override; private: std::shared_ptr _baseConsole; DISALLOW_COPY_AND_ASSIGN(NoninteractiveConsole); }; } #endif src/cpp-utils/io/pipestream.cpp000066400000000000000000000000301300002025200170220ustar00rootroot00000000000000#include "pipestream.h" src/cpp-utils/io/pipestream.h000066400000000000000000000135001300002025200164750ustar00rootroot00000000000000// Original version taken under MIT licence from http://stackoverflow.com/a/12413298/829568 and modified. // ---------------------------------------------------------------------------- // Copyright (C) 2013 Dietmar Kuehl http://www.dietmar-kuehl.de // // Permission is hereby granted, free of charge, to any person // obtaining a copy of this software and associated documentation // files (the "Software"), to deal in the Software without restriction, // including without limitation the rights to use, copy, modify, // merge, publish, distribute, sublicense, and/or sell copies of // the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be // included in all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES // OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, // WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR // OTHER DEALINGS IN THE SOFTWARE. // ---------------------------------------------------------------------------- #pragma once #ifndef MESSMER_CPPUTILS_PIPESTREAM_H #define MESSMER_CPPUTILS_PIPESTREAM_H /** * This is a class that implements a pipe for std::ostream/std::istream. * You can in one thread write to std::ostream and read that data (blocking) from an std::istream. * Reading and writing can happen in different threads. * * Use as follows: * pipestream pipe; * std::istream istream(&pipe); * std::ostream ostream(&pipe); * istream << "Data"; * ostream >> ... */ #include #include #include #include #include #include #include #include #include "../macros.h" //TODO Add test cases namespace cpputils { class pipestream final : public std::streambuf { private: typedef std::streambuf::traits_type traits_type; typedef std::string::size_type string_size_t; std::mutex d_mutex; std::condition_variable d_condition; std::string d_out; std::string d_in; std::string d_tmp; char *d_current; bool d_closed; public: pipestream(string_size_t out_size = 16, string_size_t in_size = 64) : d_mutex() , d_condition() , d_out(std::max(string_size_t(1), out_size), ' ') , d_in(std::max(string_size_t(1), in_size), ' ') , d_tmp(std::max(string_size_t(1), in_size), ' ') , d_current(&this->d_tmp[0]) , d_closed(false) { this->setp(&this->d_out[0], &this->d_out[0] + this->d_out.size() - 1); this->setg(&this->d_in[0], &this->d_in[0], &this->d_in[0]); } void close() { { std::unique_lock lock(this->d_mutex); this->d_closed = true; while (this->pbase() != this->pptr()) { this->internal_sync(lock); } } this->d_condition.notify_all(); } private: int_type underflow() override { if (this->gptr() == this->egptr()) { std::unique_lock lock(this->d_mutex); while (&this->d_tmp[0] == this->d_current && !this->d_closed) { this->d_condition.wait(lock); } if (&this->d_tmp[0] != this->d_current) { std::streamsize size(this->d_current - &this->d_tmp[0]); traits_type::copy(this->eback(), &this->d_tmp[0], this->d_current - &this->d_tmp[0]); this->setg(this->eback(), this->eback(), this->eback() + size); this->d_current = &this->d_tmp[0]; this->d_condition.notify_one(); } } return this->gptr() == this->egptr() ? traits_type::eof() : traits_type::to_int_type(*this->gptr()); } int_type overflow(int_type c) override { std::unique_lock lock(this->d_mutex); if (!traits_type::eq_int_type(c, traits_type::eof())) { *this->pptr() = traits_type::to_char_type(c); this->pbump(1); } return this->internal_sync(lock) ? traits_type::eof() : traits_type::not_eof(c); } int sync() override { std::unique_lock lock(this->d_mutex); return this->internal_sync(lock); } int internal_sync(std::unique_lock &lock) { char *end(&this->d_tmp[0] + this->d_tmp.size()); while (this->d_current == end && !this->d_closed) { this->d_condition.wait(lock); } if (this->d_current != end) { std::streamsize size(std::min(end - d_current, this->pptr() - this->pbase())); traits_type::copy(d_current, this->pbase(), size); this->d_current += size; std::streamsize remain((this->pptr() - this->pbase()) - size); traits_type::move(this->pbase(), this->pptr(), remain); this->setp(this->pbase(), this->epptr()); this->pbump(remain); this->d_condition.notify_one(); return 0; } return traits_type::eof(); } DISALLOW_COPY_AND_ASSIGN(pipestream); }; } #endif src/cpp-utils/lock/000077500000000000000000000000001300002025200144755ustar00rootroot00000000000000src/cpp-utils/lock/CombinedLock.h000066400000000000000000000015411300002025200172000ustar00rootroot00000000000000#ifndef MESSMER_CPPUTILS_LOCK_COMBINEDLOCK_H #define MESSMER_CPPUTILS_LOCK_COMBINEDLOCK_H #include "../macros.h" namespace cpputils { /** * This class is used to combine multiple locks into one, taking care that they are locked/unlocked * in the order they were given to the constructor. */ class CombinedLock final { public: CombinedLock(std::unique_lock *outer, std::unique_lock *inner) : _outer(outer), _inner(inner) { } void lock() { _outer->lock(); _inner->lock(); } void unlock() { _inner->unlock(); _outer->unlock(); } private: std::unique_lock *_outer; std::unique_lock *_inner; DISALLOW_COPY_AND_ASSIGN(CombinedLock); }; } #endifsrc/cpp-utils/lock/ConditionBarrier.h000066400000000000000000000021071300002025200201030ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_LOCK_CONDITIONBARRIER_H #define MESSMER_CPPUTILS_LOCK_CONDITIONBARRIER_H #include #include #include "../macros.h" //TODO Test //TODO Merge lock folder with thread folder namespace cpputils { // Like a condition variable, but without spurious wakeups. // The waiting threads are only woken, when notify() is called. // After a call to release(), future calls to wait() will not block anymore. class ConditionBarrier final { public: ConditionBarrier() :_mutex(), _cv(), _triggered(false) { } void wait() { std::unique_lock lock(_mutex); _cv.wait(lock, [this] { return _triggered; }); } void release() { std::unique_lock lock(_mutex); _triggered = true; _cv.notify_all(); } private: std::mutex _mutex; std::condition_variable _cv; bool _triggered; DISALLOW_COPY_AND_ASSIGN(ConditionBarrier); }; } #endif src/cpp-utils/lock/LockPool.cpp000066400000000000000000000000261300002025200167210ustar00rootroot00000000000000#include "LockPool.h" src/cpp-utils/lock/LockPool.h000066400000000000000000000065731300002025200164030ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_LOCK_LOCKPOOL_H #define MESSMER_CPPUTILS_LOCK_LOCKPOOL_H #include #include #include #include #include "../assert/assert.h" #include "../macros.h" #include "CombinedLock.h" //TODO Test //TODO Rename package to synchronization //TODO Rename to MutexPool namespace cpputils { template class LockPool final { public: LockPool(); ~LockPool(); void lock(const LockName &lockName); void lock(const LockName &lockName, std::unique_lock *lockToFreeWhileWaiting); void release(const LockName &lockName); private: bool _isLocked(const LockName &lockName) const; template void _lock(const LockName &lockName, OuterLock *lockToFreeWhileWaiting); std::vector _lockedLocks; std::mutex _mutex; std::condition_variable_any _cv; DISALLOW_COPY_AND_ASSIGN(LockPool); }; template inline LockPool::LockPool(): _lockedLocks(), _mutex(), _cv() {} template inline LockPool::~LockPool() { ASSERT(_lockedLocks.size() == 0, "Still locks open"); } template inline void LockPool::lock(const LockName &lockName, std::unique_lock *lockToFreeWhileWaiting) { ASSERT(lockToFreeWhileWaiting->owns_lock(), "Given lock must be locked"); std::unique_lock mutexLock(_mutex); // TODO Is shared_lock enough here? // Order of locking/unlocking is important and should be the same order as everywhere else to prevent deadlocks. // Since when entering the function, lockToFreeWhileWaiting is already locked and mutexLock is locked afterwards, // the condition variable should do it in the same order. We use combinedLock for this. CombinedLock combinedLock(lockToFreeWhileWaiting, &mutexLock); _lock(lockName, &combinedLock); ASSERT(mutexLock.owns_lock() && lockToFreeWhileWaiting->owns_lock(), "Locks haven't been correctly relocked"); } template inline void LockPool::lock(const LockName &lockName) { std::unique_lock mutexLock(_mutex); // TODO Is shared_lock enough here? _lock(lockName, &mutexLock); ASSERT(mutexLock.owns_lock(), "Lock hasn't been correctly relocked"); } template template inline void LockPool::_lock(const LockName &lockName, OuterLock *mutexLock) { if (_isLocked(lockName)) { _cv.wait(*mutexLock, [this, &lockName]{ return !_isLocked(lockName); }); } _lockedLocks.push_back(lockName); } template inline bool LockPool::_isLocked(const LockName &lockName) const { return std::find(_lockedLocks.begin(), _lockedLocks.end(), lockName) != _lockedLocks.end(); } template inline void LockPool::release(const LockName &lockName) { std::unique_lock mutexLock(_mutex); auto found = std::find(_lockedLocks.begin(), _lockedLocks.end(), lockName); ASSERT(found != _lockedLocks.end(), "Lock given to release() was not locked"); _lockedLocks.erase(found); _cv.notify_all(); } } #endif src/cpp-utils/lock/MutexPoolLock.h000066400000000000000000000022721300002025200174160ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_LOCK_MUTEXPOOLLOCK_H #define MESSMER_CPPUTILS_LOCK_MUTEXPOOLLOCK_H #include "LockPool.h" namespace cpputils { template class MutexPoolLock final { public: MutexPoolLock(LockPool *pool, const LockName &lockName): _pool(pool), _lockName(lockName) { _pool->lock(_lockName); } MutexPoolLock(LockPool *pool, const LockName &lockName, std::unique_lock *lockToFreeWhileWaiting) : _pool(pool), _lockName(lockName) { _pool->lock(_lockName, lockToFreeWhileWaiting); } MutexPoolLock(MutexPoolLock &&rhs): _pool(rhs._pool), _lockName(rhs._lockName) { rhs._pool = nullptr; } ~MutexPoolLock() { if (_pool != nullptr) { unlock(); } } void unlock() { ASSERT(_pool != nullptr, "MutexPoolLock is not locked"); _pool->release(_lockName); _pool = nullptr; } private: LockPool *_pool; LockName _lockName; DISALLOW_COPY_AND_ASSIGN(MutexPoolLock); }; } #endif src/cpp-utils/logging/000077500000000000000000000000001300002025200151735ustar00rootroot00000000000000src/cpp-utils/logging/Logger.h000066400000000000000000000023471300002025200165710ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_LOGGING_LOGGER_H #define MESSMER_CPPUTILS_LOGGING_LOGGER_H #include #include "../macros.h" namespace cpputils { namespace logging { class Logger final { public: void setLogger(std::shared_ptr logger) { _logger = logger; _logger->set_level(_level); } void reset() { _level = spdlog::level::info; setLogger(_defaultLogger()); } void setLevel(spdlog::level::level_enum level) { _level = level; _logger->set_level(_level); } spdlog::logger *operator->() { return _logger.get(); } private: static std::shared_ptr _defaultLogger() { static auto singleton = spdlog::stderr_logger_mt("Log"); return singleton; } Logger() : _logger(), _level() { reset(); } friend Logger &logger(); std::shared_ptr _logger; spdlog::level::level_enum _level; DISALLOW_COPY_AND_ASSIGN(Logger); }; inline Logger &logger() { static Logger singleton; return singleton; } } } #endif src/cpp-utils/logging/logging.h000066400000000000000000000026321300002025200167750ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_LOGGING_LOGGING_H #define MESSMER_CPPUTILS_LOGGING_LOGGING_H #include "Logger.h" #include namespace cpputils { namespace logging { extern struct ERROR_TYPE {} ERROR; extern struct WARN_TYPE {} WARN; extern struct INFO_TYPE {} INFO; extern struct DEBUG_TYPE {} DEBUG; inline void setLogger(std::shared_ptr newLogger) { logger().setLogger(newLogger); } inline void reset() { logger().reset(); } inline void setLevel(ERROR_TYPE) { logger().setLevel(spdlog::level::err); } inline void setLevel(WARN_TYPE) { logger().setLevel(spdlog::level::warn); } inline void setLevel(INFO_TYPE) { logger().setLevel(spdlog::level::info); } inline void setLevel(DEBUG_TYPE) { logger().setLevel(spdlog::level::debug); } inline spdlog::details::line_logger LOG(ERROR_TYPE) { return logger()->error(); } inline spdlog::details::line_logger LOG(WARN_TYPE) { return logger()->warn(); } inline spdlog::details::line_logger LOG(INFO_TYPE) { return logger()->info(); } inline spdlog::details::line_logger LOG(DEBUG_TYPE) { return logger()->debug(); } } } #endif src/cpp-utils/macros.h000066400000000000000000000011041300002025200151760ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_MACROS_H_ #define MESSMER_CPPUTILS_MACROS_H_ //TODO If possible, make classes final and destructors non-virtual or delete destructors //TODO Use DISALLOW_COPY_AND_ASSIGN where possible /** * Disallow the copy and assignment constructors of a class */ #define DISALLOW_COPY_AND_ASSIGN(Class) \ Class(const Class &rhs) = delete; \ Class &operator=(const Class &rhs) = delete; /** * Declare a function parameter as intentionally unused to get rid of the compiler warning */ #define UNUSED(expr) (void)(expr) #endif src/cpp-utils/network/000077500000000000000000000000001300002025200152365ustar00rootroot00000000000000src/cpp-utils/network/CurlHttpClient.cpp000066400000000000000000000031621300002025200206500ustar00rootroot00000000000000// Base version taken from https://techoverflow.net/blog/2013/03/15/c-simple-http-download-using-libcurl-easy-api/ #include "CurlHttpClient.h" #include #include #include using boost::none; using boost::optional; using std::string; using std::ostringstream; namespace cpputils { size_t CurlHttpClient::write_data(void *ptr, size_t size, size_t nmemb, ostringstream *stream) { stream->write((const char *) ptr, size * nmemb); return size * nmemb; } CurlHttpClient::CurlHttpClient() { curl = curl_easy_init(); } CurlHttpClient::~CurlHttpClient() { curl_easy_cleanup(curl); } optional CurlHttpClient::get(const string &url, optional timeoutMsec) { curl_easy_setopt(curl, CURLOPT_URL, url.c_str()); // example.com is redirected, so we tell libcurl to follow redirection curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L); curl_easy_setopt(curl, CURLOPT_NOSIGNAL, 1); //Prevent "longjmp causes uninitialized stack frame" bug curl_easy_setopt(curl, CURLOPT_ENCODING, "deflate"); ostringstream out; curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, &CurlHttpClient::write_data); curl_easy_setopt(curl, CURLOPT_WRITEDATA, &out); if (timeoutMsec != none) { curl_easy_setopt(curl, CURLOPT_TIMEOUT_MS, *timeoutMsec); } // Perform the request, res will get the return code CURLcode res = curl_easy_perform(curl); // Check for errors if (res != CURLE_OK) { return none; } return out.str(); } } src/cpp-utils/network/CurlHttpClient.h000066400000000000000000000012141300002025200203110ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_NETWORK_HTTPCLIENT_HPP #define MESSMER_CPPUTILS_NETWORK_HTTPCLIENT_HPP #include "HttpClient.h" #include "../macros.h" #include namespace cpputils { class CurlHttpClient final : public HttpClient { public: CurlHttpClient(); ~CurlHttpClient(); boost::optional get(const std::string &url, boost::optional timeoutMsec = boost::none) override; private: CURL *curl; static size_t write_data(void *ptr, size_t size, size_t nmemb, std::ostringstream *stream); DISALLOW_COPY_AND_ASSIGN(CurlHttpClient); }; } #endif src/cpp-utils/network/FakeHttpClient.cpp000066400000000000000000000010521300002025200206050ustar00rootroot00000000000000#include "FakeHttpClient.h" using std::string; using boost::optional; using boost::none; namespace cpputils { FakeHttpClient::FakeHttpClient(): _sites() { } void FakeHttpClient::addWebsite(const string &url, const string &content) { _sites[url] = content; } optional FakeHttpClient::get(const string &url, optional timeoutMsec) { UNUSED(timeoutMsec); auto found = _sites.find(url); if (found == _sites.end()) { return none; } return found->second; } } src/cpp-utils/network/FakeHttpClient.h000066400000000000000000000011461300002025200202560ustar00rootroot00000000000000#ifndef MESSMER_CPPUTILS_NETWORK_FAKEHTTPCLIENT_H #define MESSMER_CPPUTILS_NETWORK_FAKEHTTPCLIENT_H #include "HttpClient.h" #include "../macros.h" #include namespace cpputils { class FakeHttpClient final : public HttpClient { public: FakeHttpClient(); void addWebsite(const std::string &url, const std::string &content); boost::optional get(const std::string &url, boost::optional timeoutMsec = boost::none) override; private: std::map _sites; DISALLOW_COPY_AND_ASSIGN(FakeHttpClient); }; } #endif src/cpp-utils/network/HttpClient.cpp000066400000000000000000000000301300002025200200110ustar00rootroot00000000000000#include "HttpClient.h" src/cpp-utils/network/HttpClient.h000066400000000000000000000005711300002025200174700ustar00rootroot00000000000000#ifndef MESSMER_CPPUTILS_NETWORK_HTTPCLIENT_H #define MESSMER_CPPUTILS_NETWORK_HTTPCLIENT_H #include #include namespace cpputils { class HttpClient { public: virtual ~HttpClient() {} virtual boost::optional get(const std::string& url, boost::optional timeoutMsec = boost::none) = 0; }; }; #endif src/cpp-utils/pointer/000077500000000000000000000000001300002025200152255ustar00rootroot00000000000000src/cpp-utils/pointer/cast.h000066400000000000000000000011711300002025200163300ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_POINTER_CAST_H_ #define MESSMER_CPPUTILS_POINTER_CAST_H_ #include namespace cpputils { /** * dynamic_cast implementation for unique_ptr (moving unique_ptr into a unique_ptr of different type) */ //TODO Also allow passing a rvalue reference, otherwise dynamic_pointer_move(func()) won't work template inline std::unique_ptr dynamic_pointer_move(std::unique_ptr &source) { //TODO Deleter DST *casted = dynamic_cast(source.get()); if (casted != nullptr) { source.release(); } return std::unique_ptr(casted); } } #endif src/cpp-utils/pointer/gcc_4_8_compatibility.h000066400000000000000000000006121300002025200215340ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_GCC48COMPATIBILITY_H #define MESSMER_CPPUTILS_GCC48COMPATIBILITY_H #include #if __GNUC__ == 4 && __GNUC_MINOR__ == 8 // Add std::make_unique namespace std { template inline unique_ptr make_unique(Args&&... args) { return unique_ptr(new T(std::forward(args)...)); } } #endif #endif src/cpp-utils/pointer/optional_ownership_ptr.h000066400000000000000000000024001300002025200222020ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_POINTER_OPTIONALOWNERSHIPPOINTER_H_ #define MESSMER_CPPUTILS_POINTER_OPTIONALOWNERSHIPPOINTER_H_ #include "unique_ref.h" #include /** * optional_ownership_ptr can be used to hold a pointer to an instance of an object. * The pointer might or might not have ownership of the object. * * If it has ownership, it will delete the stored object in its destructor. * If it doesn't have ownership, it won't. * * You can create such pointers with * - WithOwnership(ptr) * - WithoutOwnership(ptr) * - null() */ namespace cpputils { template using optional_ownership_ptr = std::unique_ptr>; template optional_ownership_ptr WithOwnership(std::unique_ptr obj) { auto deleter = obj.get_deleter(); return optional_ownership_ptr(obj.release(), [deleter](T* obj){deleter(obj);}); } template optional_ownership_ptr WithOwnership(unique_ref obj) { return WithOwnership(to_unique_ptr(std::move(obj))); } template optional_ownership_ptr WithoutOwnership(T *obj) { return optional_ownership_ptr(obj, [](T*){}); } template optional_ownership_ptr null() { return WithoutOwnership(nullptr); } } #endif src/cpp-utils/pointer/unique_ref.h000066400000000000000000000113631300002025200175440ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_POINTER_UNIQUE_REF_H #define MESSMER_CPPUTILS_POINTER_UNIQUE_REF_H #include #include #include "../macros.h" #include "gcc_4_8_compatibility.h" #include "cast.h" namespace cpputils { /** * unique_ref behaves like unique_ptr, but guarantees that the pointer points to a valid object. * You can create objects using make_unique_ref (works like make_unique for unique_ptr). * * If you happen to already have a unique_ptr, you can call nullcheck(unique_ptr), * which returns optional>. * Take care that this should be used very rarely, since it circumvents parts of the guarantee. * It still protects against null pointers, but it does not guarantee anymore that the pointer points * to a valid object. It might hold an arbitrary non-null memory location. * * Caution: There is one way a unique_ref can actually hold a nullptr. * It will hold a nullptr after its value was moved to another unique_ref. * Never use the old instance after moving! */ template class unique_ref final { public: unique_ref(unique_ref&& from): _target(std::move(from._target)) {} // TODO Test this upcast-allowing move constructor template unique_ref(unique_ref&& from): _target(std::move(from._target)) {} unique_ref& operator=(unique_ref&& from) { _target = std::move(from._target); return *this; } // TODO Test this upcast-allowing assignment template unique_ref& operator=(unique_ref&& from) { _target = std::move(from._target); return *this; } typename std::add_lvalue_reference::type operator*() const& { return *_target; } typename std::add_rvalue_reference::type operator*() && { return std::move(*_target); } T* operator->() const { return get(); } T* get() const { return _target.get(); } void swap(unique_ref& rhs) { std::swap(_target, rhs._target); } private: unique_ref(std::unique_ptr target): _target(std::move(target)) {} template friend unique_ref make_unique_ref(Args&&... args); template friend boost::optional> nullcheck(std::unique_ptr ptr); template friend class unique_ref; template friend boost::optional> dynamic_pointer_move(unique_ref &source); template friend std::unique_ptr to_unique_ptr(unique_ref ref); std::unique_ptr _target; DISALLOW_COPY_AND_ASSIGN(unique_ref); }; template inline unique_ref make_unique_ref(Args&&... args) { return unique_ref(std::make_unique(std::forward(args)...)); } template inline boost::optional> nullcheck(std::unique_ptr ptr) { if (ptr.get() != nullptr) { return unique_ref(std::move(ptr)); } return boost::none; } template inline void destruct(unique_ref ptr) { to_unique_ptr(std::move(ptr)).reset(); } //TODO Also allow passing a rvalue reference, otherwise dynamic_pointer_move(func()) won't work template inline boost::optional> dynamic_pointer_move(unique_ref &source) { return nullcheck(dynamic_pointer_move(source._target)); } //TODO Write test cases for to_unique_ptr template inline std::unique_ptr to_unique_ptr(unique_ref ref) { return std::move(ref._target); } template inline bool operator==(const unique_ref &lhs, const unique_ref &rhs) { return lhs.get() == rhs.get(); } template inline bool operator!=(const unique_ref &lhs, const unique_ref &rhs) { return !operator==(lhs, rhs); } } namespace std { template inline void swap(cpputils::unique_ref& lhs, cpputils::unique_ref& rhs) { lhs.swap(rhs); } template inline void swap(cpputils::unique_ref&& lhs, cpputils::unique_ref& rhs) { lhs.swap(rhs); } template inline void swap(cpputils::unique_ref& lhs, cpputils::unique_ref&& rhs) { lhs.swap(rhs); } // Allow using it in std::unordered_set / std::unordered_map template struct hash> { size_t operator()(const cpputils::unique_ref &ref) const { return (size_t)ref.get(); } }; // Allow using it in std::map / std::set template struct less> { bool operator()(const cpputils::unique_ref &lhs, const cpputils::unique_ref &rhs) const { return lhs.get() < rhs.get(); } }; } #endif src/cpp-utils/pointer/unique_ref_boost_optional_gtest_workaround.h000066400000000000000000000013431300002025200263350ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_POINTER_UNIQUE_REF_BOOST_OPTIONAL_GTEST_WORKAROUND_H #define MESSMER_CPPUTILS_POINTER_UNIQUE_REF_BOOST_OPTIONAL_GTEST_WORKAROUND_H /** * This is a workaround for using boost::optional> in gtest. * Without including this file, the linker will fail. */ //TODO Test that this solves the problem (add test unit file that doesn't compile without) #include "unique_ref.h" //gtest/boost::optional workaround for working with optional> namespace cpputils { template inline std::ostream& operator<<(std::ostream& out, const cpputils::unique_ref &ref) { out << ref.get(); return out; } } #include #endif src/cpp-utils/process/000077500000000000000000000000001300002025200152235ustar00rootroot00000000000000src/cpp-utils/process/daemonize.cpp000066400000000000000000000025311300002025200177030ustar00rootroot00000000000000#include "daemonize.h" #include #include #include #include #include #include #include #include #include #include #include "../logging/logging.h" using namespace cpputils::logging; namespace cpputils { //TODO Test daemonize() void daemonize() { pid_t pid = fork(); if (pid < 0) { exit(EXIT_FAILURE); } if (pid > 0) { //We're the parent process. Exit. exit(EXIT_SUCCESS); } // We're the child process. umask(0); // Create a new SID for the child process pid_t sid = setsid(); if (sid < 0) { LOG(ERROR) << "Failed to get SID for daemon process"; exit(EXIT_FAILURE); } // Change the current working directory to a directory that's always existin if ((chdir("/")) < 0) { LOG(ERROR) << "Failed to change working directory for daemon process"; exit(EXIT_FAILURE); } // Close out the standard file descriptors. The process can't use them anyhow. close(STDIN_FILENO); close(STDOUT_FILENO); close(STDERR_FILENO); }; } src/cpp-utils/process/daemonize.h000066400000000000000000000002351300002025200173470ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_PROCESS_DAEMONIZE_H #define MESSMER_CPPUTILS_PROCESS_DAEMONIZE_H namespace cpputils { void daemonize(); } #endif src/cpp-utils/process/subprocess.cpp000066400000000000000000000022041300002025200201150ustar00rootroot00000000000000#include "subprocess.h" #include #include #include using std::string; namespace cpputils { //TODO Exception safety string Subprocess::call(const string &command) { FILE *subprocessOutput = _call(command); string result; char buffer[1024]; while(fgets(buffer, sizeof(buffer), subprocessOutput) != nullptr) { result += buffer; } auto returncode = pclose(subprocessOutput); if(WEXITSTATUS(returncode) != 0) { throw std::runtime_error("Subprocess \""+command+"\" exited with code "+std::to_string(WEXITSTATUS(returncode))); } return result; } int Subprocess::callAndGetReturnCode(const string &command) { FILE *subprocess = _call(command); auto returncode = pclose(subprocess); return WEXITSTATUS(returncode); } FILE *Subprocess::_call(const string &command) { FILE *subprocess = popen(command.c_str(), "r"); if (!subprocess) { throw std::runtime_error("Error starting subprocess "+command); } return subprocess; } } src/cpp-utils/process/subprocess.h000066400000000000000000000007511300002025200175670ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_PROCESS_SUBPROCESS_H #define MESSMER_CPPUTILS_PROCESS_SUBPROCESS_H #include #include "../macros.h" namespace cpputils { //TODO Test class Subprocess final { public: static std::string call(const std::string &command); static int callAndGetReturnCode(const std::string &command); private: static FILE* _call(const std::string &command); DISALLOW_COPY_AND_ASSIGN(Subprocess); }; } #endif src/cpp-utils/random/000077500000000000000000000000001300002025200150255ustar00rootroot00000000000000src/cpp-utils/random/OSRandomGenerator.cpp000066400000000000000000000000371300002025200210620ustar00rootroot00000000000000#include "OSRandomGenerator.h" src/cpp-utils/random/OSRandomGenerator.h000066400000000000000000000012201300002025200205220ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_RANDOM_OSRANDOMGENERATOR_H #define MESSMER_CPPUTILS_RANDOM_OSRANDOMGENERATOR_H #include "RandomGenerator.h" #include namespace cpputils { class OSRandomGenerator final : public RandomGenerator { public: OSRandomGenerator(); protected: void _get(void *target, size_t bytes) override; private: DISALLOW_COPY_AND_ASSIGN(OSRandomGenerator); }; inline OSRandomGenerator::OSRandomGenerator() {} inline void OSRandomGenerator::_get(void *target, size_t bytes) { CryptoPP::OS_GenerateRandomBlock(true, (byte*)target, bytes); } } #endif src/cpp-utils/random/PseudoRandomPool.cpp000066400000000000000000000002451300002025200207640ustar00rootroot00000000000000#include "PseudoRandomPool.h" namespace cpputils { constexpr size_t PseudoRandomPool::MIN_BUFFER_SIZE; constexpr size_t PseudoRandomPool::MAX_BUFFER_SIZE; }src/cpp-utils/random/PseudoRandomPool.h000066400000000000000000000020431300002025200204270ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_RANDOM_PSEUDORANDOMPOOL_H #define MESSMER_CPPUTILS_RANDOM_PSEUDORANDOMPOOL_H #include #include "RandomGenerator.h" #include "ThreadsafeRandomDataBuffer.h" #include "RandomGeneratorThread.h" #include namespace cpputils { //TODO Test class PseudoRandomPool final : public RandomGenerator { public: PseudoRandomPool(); protected: void _get(void *target, size_t bytes) override; private: static constexpr size_t MIN_BUFFER_SIZE = 1*1024*1024; // 1MB static constexpr size_t MAX_BUFFER_SIZE = 2*1024*1024; // 2MB ThreadsafeRandomDataBuffer _buffer; RandomGeneratorThread _refillThread; DISALLOW_COPY_AND_ASSIGN(PseudoRandomPool); }; inline void PseudoRandomPool::_get(void *target, size_t bytes) { _buffer.get(target, bytes); } inline PseudoRandomPool::PseudoRandomPool(): _buffer(), _refillThread(&_buffer, MIN_BUFFER_SIZE, MAX_BUFFER_SIZE) { _refillThread.start(); } } #endif src/cpp-utils/random/Random.cpp000066400000000000000000000001121300002025200167430ustar00rootroot00000000000000#include "Random.h" namespace cpputils { std::mutex Random::_mutex; }src/cpp-utils/random/Random.h000066400000000000000000000014071300002025200164200ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_RANDOM_RANDOM_H #define MESSMER_CPPUTILS_RANDOM_RANDOM_H #include "PseudoRandomPool.h" #include "OSRandomGenerator.h" #include "../data/FixedSizeData.h" #include "../data/Data.h" #include namespace cpputils { class Random final { public: static PseudoRandomPool &PseudoRandom() { std::unique_lock lock(_mutex); static PseudoRandomPool random; return random; } static OSRandomGenerator &OSRandom() { std::unique_lock lock(_mutex); static OSRandomGenerator random; return random; } private: static std::mutex _mutex; DISALLOW_COPY_AND_ASSIGN(Random); }; } #endif src/cpp-utils/random/RandomDataBuffer.cpp000066400000000000000000000000361300002025200206740ustar00rootroot00000000000000#include "RandomDataBuffer.h" src/cpp-utils/random/RandomDataBuffer.h000066400000000000000000000024771300002025200203540ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_RANDOM_RANDOMDATABUFFER_H #define MESSMER_CPPUTILS_RANDOM_RANDOMDATABUFFER_H #include "../data/Data.h" #include "../assert/assert.h" namespace cpputils { //TODO Test class RandomDataBuffer final { public: RandomDataBuffer(); size_t size() const; void get(void *target, size_t bytes); void add(Data data); private: size_t _usedUntil; Data _data; DISALLOW_COPY_AND_ASSIGN(RandomDataBuffer); }; inline RandomDataBuffer::RandomDataBuffer() : _usedUntil(0), _data(0) { } inline size_t RandomDataBuffer::size() const { return _data.size() - _usedUntil; } inline void RandomDataBuffer::get(void *target, size_t numBytes) { ASSERT(size() >= numBytes, "Too many bytes requested. Buffer is smaller."); std::memcpy(target, _data.dataOffset(_usedUntil), numBytes); _usedUntil += numBytes; } inline void RandomDataBuffer::add(Data newData) { // Concatenate old and new random data size_t oldSize = size(); Data combined(oldSize + newData.size()); get(combined.data(), oldSize); std::memcpy(combined.dataOffset(oldSize), newData.data(), newData.size()); _data = std::move(combined); _usedUntil = 0; } } #endif src/cpp-utils/random/RandomGenerator.cpp000066400000000000000000000000341300002025200206150ustar00rootroot00000000000000#include "RandomGenerator.h"src/cpp-utils/random/RandomGenerator.h000066400000000000000000000016751300002025200202760ustar00rootroot00000000000000#ifndef MESSMER_CPPUTILS_RANDOM_RANDOMGENERATOR_H #define MESSMER_CPPUTILS_RANDOM_RANDOMGENERATOR_H #include "../data/FixedSizeData.h" #include "../data/Data.h" namespace cpputils { class RandomGenerator { public: RandomGenerator(); template FixedSizeData getFixedSize(); Data get(size_t size); protected: virtual void _get(void *target, size_t bytes) = 0; private: static std::mutex _mutex; DISALLOW_COPY_AND_ASSIGN(RandomGenerator); }; inline RandomGenerator::RandomGenerator() { } template inline FixedSizeData RandomGenerator::getFixedSize() { FixedSizeData result = FixedSizeData::Null(); _get(result.data(), SIZE); return result; } inline Data RandomGenerator::get(size_t size) { Data result(size); _get(result.data(), size); return result; } } #endif src/cpp-utils/random/RandomGeneratorThread.cpp000066400000000000000000000023701300002025200217520ustar00rootroot00000000000000#include "RandomGeneratorThread.h" namespace cpputils { RandomGeneratorThread::RandomGeneratorThread(ThreadsafeRandomDataBuffer *buffer, size_t minSize, size_t maxSize) : _randomGenerator(), _buffer(buffer), _minSize(minSize), _maxSize(maxSize), _thread(std::bind(&RandomGeneratorThread::_loopIteration, this)) { ASSERT(_maxSize >= _minSize, "Invalid parameters"); } void RandomGeneratorThread::start() { return _thread.start(); } bool RandomGeneratorThread::_loopIteration() { _buffer->waitUntilSizeIsLessThan(_minSize); size_t neededRandomDataSize = _maxSize - _buffer->size(); ASSERT(_maxSize > _buffer->size(), "This could theoretically fail if another thread refilled the buffer. But we should be the only refilling thread."); Data randomData = _generateRandomData(neededRandomDataSize); _buffer->add(std::move(randomData)); return true; // Run another iteration (don't terminate thread) } Data RandomGeneratorThread::_generateRandomData(size_t size) { Data newRandom(size); _randomGenerator.GenerateBlock(static_cast(newRandom.data()), size); return newRandom; } } src/cpp-utils/random/RandomGeneratorThread.h000066400000000000000000000017201300002025200214150ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_RANDOM_RANDOMGENERATORTHREAD_H #define MESSMER_CPPUTILS_RANDOM_RANDOMGENERATORTHREAD_H #include "../thread/LoopThread.h" #include "ThreadsafeRandomDataBuffer.h" #include namespace cpputils { //TODO Test class RandomGeneratorThread final { public: RandomGeneratorThread(ThreadsafeRandomDataBuffer *buffer, size_t minSize, size_t maxSize); void start(); private: bool _loopIteration(); Data _generateRandomData(size_t size); CryptoPP::AutoSeededRandomPool _randomGenerator; ThreadsafeRandomDataBuffer *_buffer; size_t _minSize; size_t _maxSize; //This has to be the last member, because it has to be destructed first - otherwise the thread could still be //running while the RandomGeneratorThread object is invalid. LoopThread _thread; DISALLOW_COPY_AND_ASSIGN(RandomGeneratorThread); }; } #endif src/cpp-utils/random/ThreadsafeRandomDataBuffer.h000066400000000000000000000052611300002025200223350ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_RANDOM_THREADSAFERANDOMDATABUFFER_H #define MESSMER_CPPUTILS_RANDOM_THREADSAFERANDOMDATABUFFER_H #include "../data/Data.h" #include "../assert/assert.h" #include "RandomDataBuffer.h" #include namespace cpputils { //TODO Test class ThreadsafeRandomDataBuffer final { public: ThreadsafeRandomDataBuffer(); size_t size() const; void get(void *target, size_t numBytes); void add(Data data); void waitUntilSizeIsLessThan(size_t numBytes); private: size_t _get(void *target, size_t bytes); RandomDataBuffer _buffer; mutable boost::mutex _mutex; boost::condition_variable _dataAddedCv; // _dataGottenCv needs to be boost::condition_variable and not std::condition_variable, because the // RandomGeneratorThread calling ThreadsafeRandomDataBuffer::waitUntilSizeIsLessThan() needs the waiting to be // interruptible to stop the thread in RandomGeneratorThread::stop() or in the RandomGeneratorThread destructor. boost::condition_variable _dataGottenCv; DISALLOW_COPY_AND_ASSIGN(ThreadsafeRandomDataBuffer); }; inline ThreadsafeRandomDataBuffer::ThreadsafeRandomDataBuffer(): _buffer(), _mutex(), _dataAddedCv(), _dataGottenCv() { } inline size_t ThreadsafeRandomDataBuffer::size() const { boost::unique_lock lock(_mutex); return _buffer.size(); } inline void ThreadsafeRandomDataBuffer::get(void *target, size_t numBytes) { size_t alreadyGotten = 0; while (alreadyGotten < numBytes) { size_t got = _get(static_cast(target)+alreadyGotten, numBytes); alreadyGotten += got; ASSERT(alreadyGotten <= numBytes, "Got too many bytes"); } } inline size_t ThreadsafeRandomDataBuffer::_get(void *target, size_t numBytes) { boost::unique_lock lock(_mutex); _dataAddedCv.wait(lock, [this, numBytes] { return _buffer.size() > 0; }); size_t gettableBytes = std::min(_buffer.size(), numBytes); _buffer.get(target, gettableBytes); _dataGottenCv.notify_all(); return gettableBytes; } inline void ThreadsafeRandomDataBuffer::add(Data data) { boost::unique_lock lock(_mutex); _buffer.add(std::move(data)); _dataAddedCv.notify_all(); } inline void ThreadsafeRandomDataBuffer::waitUntilSizeIsLessThan(size_t numBytes) { boost::unique_lock lock(_mutex); _dataGottenCv.wait(lock, [this, numBytes] { return _buffer.size() < numBytes; }); } } #endif src/cpp-utils/system/000077500000000000000000000000001300002025200150715ustar00rootroot00000000000000src/cpp-utils/system/clock_gettime.h000066400000000000000000000013051300002025200200520ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_SYSTEM_CLOCKGETTIME_H #define MESSMER_CPPUTILS_SYSTEM_CLOCKGETTIME_H // Implements clock_gettime for Mac OS X (where it is not implemented by in the standard library) // Source: http://stackoverflow.com/a/9781275/829568 // Caution: The returned value is less precise than the returned value from a linux clock_gettime would be. #ifdef __MACH__ #include #define CLOCK_REALTIME 0 inline int clock_gettime(int /*clk_id*/, struct timespec *result) { struct timeval now; int rv = gettimeofday(&now, nullptr); if (rv) { return rv; } result->tv_sec = now.tv_sec; result->tv_nsec = now.tv_sec * 1000; return 0; } #endif #endif src/cpp-utils/system/get_total_memory.cpp000066400000000000000000000013441300002025200211510ustar00rootroot00000000000000#include "get_total_memory.h" #include #include #include #include namespace cpputils{ namespace system { uint64_t get_total_memory() { uint64_t mem; #ifdef __APPLE__ size_t size = sizeof(mem); int result = sysctlbyname("hw.memsize", &mem, &size, nullptr, 0); if (0 != result) { throw std::runtime_error("sysctlbyname syscall failed"); } #elif __linux__ long numRAMPages = sysconf(_SC_PHYS_PAGES); long pageSize = sysconf(_SC_PAGESIZE); mem = numRAMPages * pageSize; #else #error Not supported on windows yet, TODO http://stackoverflow.com/a/2513561/829568 #endif return mem; } } } src/cpp-utils/system/get_total_memory.h000066400000000000000000000003451300002025200206160ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_SYSTEM_GETTOTALMEMORY_H #define MESSMER_CPPUTILS_SYSTEM_GETTOTALMEMORY_H #include namespace cpputils { namespace system { uint64_t get_total_memory(); } } #endif src/cpp-utils/system/stat.h000066400000000000000000000004631300002025200162200ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_SYSTEM_STAT_H #define MESSMER_CPPUTILS_SYSTEM_STAT_H /** * For platform independence: Apple doesn't have stat.st_atim, but stat.st_atimespec */ #ifdef __APPLE__ # define st_atim st_atimespec # define st_mtim st_mtimespec # define st_ctim st_ctimespec #endif #endif src/cpp-utils/system/time.h000066400000000000000000000021641300002025200162030ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_SYSTEM_TIME_H #define MESSMER_CPPUTILS_SYSTEM_TIME_H #include #include "clock_gettime.h" // TODO Test namespace cpputils { namespace time { inline timespec now() { struct timespec now; clock_gettime(CLOCK_REALTIME, &now); return now; } } } inline bool operator==(const timespec &lhs, const timespec &rhs) { return lhs.tv_sec == rhs.tv_sec && lhs.tv_nsec == rhs.tv_nsec; } inline bool operator<(const timespec &lhs, const timespec &rhs) { return lhs.tv_sec < rhs.tv_sec || (lhs.tv_sec == rhs.tv_sec && lhs.tv_nsec < rhs.tv_nsec); } inline bool operator>(const timespec &lhs, const timespec &rhs) { return lhs.tv_sec > rhs.tv_sec || (lhs.tv_sec == rhs.tv_sec && lhs.tv_nsec > rhs.tv_nsec); } inline bool operator!=(const timespec &lhs, const timespec &rhs) { return !operator==(lhs, rhs); } inline bool operator<=(const timespec &lhs, const timespec &rhs) { return !operator>(lhs, rhs); } inline bool operator>=(const timespec &lhs, const timespec &rhs) { return !operator<(lhs, rhs); } #endif src/cpp-utils/tempfile/000077500000000000000000000000001300002025200153525ustar00rootroot00000000000000src/cpp-utils/tempfile/TempDir.cpp000066400000000000000000000011141300002025200174170ustar00rootroot00000000000000#include "TempDir.h" #include "../logging/logging.h" namespace bf = boost::filesystem; using namespace cpputils::logging; namespace cpputils { TempDir::TempDir() : _path(bf::unique_path(bf::temp_directory_path() / "%%%%-%%%%-%%%%-%%%%")) { bf::create_directory(_path); } TempDir::~TempDir() { remove(); } void TempDir::remove() { try { if (bf::exists(_path)) { bf::remove_all(_path); } } catch (const boost::filesystem::filesystem_error &e) { LOG(ERROR) << "Could not delete tempfile."; } } const bf::path &TempDir::path() const { return _path; } } src/cpp-utils/tempfile/TempDir.h000066400000000000000000000006241300002025200170710ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_TEMPFILE_TEMPDIR_H_ #define MESSMER_CPPUTILS_TEMPFILE_TEMPDIR_H_ #include #include "../macros.h" namespace cpputils { class TempDir final { public: TempDir(); ~TempDir(); const boost::filesystem::path &path() const; void remove(); private: const boost::filesystem::path _path; DISALLOW_COPY_AND_ASSIGN(TempDir); }; } #endif src/cpp-utils/tempfile/TempFile.cpp000066400000000000000000000015271300002025200175700ustar00rootroot00000000000000#include "TempFile.h" #include "../logging/logging.h" #include namespace bf = boost::filesystem; using std::ofstream; using namespace cpputils::logging; namespace cpputils { TempFile::TempFile(const bf::path &path, bool create) : _path(path) { if (create) { ofstream file(_path.c_str()); if (!file.good()) { throw std::runtime_error("Could not create tempfile"); } } } TempFile::TempFile(bool create) : TempFile(bf::unique_path(bf::temp_directory_path() / "%%%%-%%%%-%%%%-%%%%"), create) { } TempFile::~TempFile() { try { if (exists()) { bf::remove(_path); } } catch (const boost::filesystem::filesystem_error &e) { LOG(ERROR) << "Could not delete tempfile."; } } bool TempFile::exists() const { return bf::exists(_path); } const bf::path &TempFile::path() const { return _path; } } src/cpp-utils/tempfile/TempFile.h000066400000000000000000000010401300002025200172230ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_TEMPFILE_TEMPFILE_H_ #define MESSMER_CPPUTILS_TEMPFILE_TEMPFILE_H_ #include #include "../macros.h" namespace cpputils { class TempFile final { public: explicit TempFile(const boost::filesystem::path &path, bool create = true); explicit TempFile(bool create = true); ~TempFile(); const boost::filesystem::path &path() const; //TODO Test exists() bool exists() const; private: const boost::filesystem::path _path; DISALLOW_COPY_AND_ASSIGN(TempFile); }; } #endif src/cpp-utils/thread/000077500000000000000000000000001300002025200150145ustar00rootroot00000000000000src/cpp-utils/thread/LoopThread.cpp000066400000000000000000000012751300002025200175660ustar00rootroot00000000000000#include "LoopThread.h" #include "../logging/logging.h" using std::function; using boost::none; namespace cpputils { LoopThread::LoopThread(function loopIteration): _loopIteration(loopIteration), _runningHandle(none) { } LoopThread::~LoopThread() { if (_runningHandle != none) { stop(); } } void LoopThread::start() { _runningHandle = ThreadSystem::singleton().start(_loopIteration); } void LoopThread::stop() { if (_runningHandle == none) { throw std::runtime_error("LoopThread is not running"); } ThreadSystem::singleton().stop(*_runningHandle); _runningHandle = none; } } src/cpp-utils/thread/LoopThread.h000066400000000000000000000016411300002025200172300ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_THREAD_LOOPTHREAD_H #define MESSMER_CPPUTILS_THREAD_LOOPTHREAD_H #include "ThreadSystem.h" #include namespace cpputils { //TODO Test //TODO Test that fork() doesn't destroy anything (e.g. no deadlock on stop() because thread is not running anymore) // Has to be final, because otherwise there could be a race condition where LoopThreadForkHandler calls a LoopThread // where the child class destructor already ran. class LoopThread final { public: // The loopIteration callback returns true, if more iterations should be run, and false, if the thread should be terminated. LoopThread(std::function loopIteration); ~LoopThread(); void start(); void stop(); private: std::function _loopIteration; boost::optional _runningHandle; }; } #endif src/cpp-utils/thread/ThreadSystem.cpp000066400000000000000000000060221300002025200201340ustar00rootroot00000000000000#include "ThreadSystem.h" #include "../logging/logging.h" using std::function; using namespace cpputils::logging; namespace cpputils { ThreadSystem &ThreadSystem::singleton() { static ThreadSystem system; return system; } ThreadSystem::ThreadSystem(): _runningThreads(), _mutex() { //Stopping the thread before fork() (and then also restarting it in the parent thread after fork()) is important, //because as a running thread it might hold locks or condition variables that won't play well when forked. pthread_atfork(&ThreadSystem::_onBeforeFork, &ThreadSystem::_onAfterFork, &ThreadSystem::_onAfterFork); } ThreadSystem::Handle ThreadSystem::start(function loopIteration) { boost::unique_lock lock(_mutex); auto thread = _startThread(loopIteration); _runningThreads.push_back(RunningThread{loopIteration, std::move(thread)}); return std::prev(_runningThreads.end()); } void ThreadSystem::stop(Handle handle) { boost::unique_lock lock(_mutex); boost::thread thread = std::move(handle->thread); thread.interrupt(); _runningThreads.erase(handle); //It's fine if another thread gets the mutex while we still wait for the join. Joining doesn't change any internal state. lock.unlock(); thread.join(); } void ThreadSystem::_onBeforeFork() { singleton()._stopAllThreadsForRestart(); } void ThreadSystem::_onAfterFork() { singleton()._restartAllThreads(); } void ThreadSystem::_stopAllThreadsForRestart() { _mutex.lock(); // Is unlocked in the after-fork handler. This way, the whole fork() is protected. for (RunningThread &thread : _runningThreads) { thread.thread.interrupt(); } for (RunningThread &thread : _runningThreads) { thread.thread.join(); } } void ThreadSystem::_restartAllThreads() { for (RunningThread &thread : _runningThreads) { thread.thread = _startThread(thread.loopIteration); } _mutex.unlock(); // Was locked in the before-fork handler } boost::thread ThreadSystem::_startThread(function loopIteration) { return boost::thread(std::bind(&ThreadSystem::_runThread, loopIteration)); } void ThreadSystem::_runThread(function loopIteration) { try { bool cont = true; while(cont) { boost::this_thread::interruption_point(); cont = loopIteration(); // This might also be interrupted. } //The thread is terminated gracefully. } catch (const boost::thread_interrupted &e) { //Do nothing, exit thread. } catch (const std::exception &e) { LOG(ERROR) << "LoopThread crashed: " << e.what(); } catch (...) { LOG(ERROR) << "LoopThread crashed"; } //TODO We should remove the thread from _runningThreads here, not in stop(). } } src/cpp-utils/thread/ThreadSystem.h000066400000000000000000000026551300002025200176110ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_THREAD_THREADSYSTEM_H #define MESSMER_CPPUTILS_THREAD_THREADSYSTEM_H #include "../macros.h" #include #include #include namespace cpputils { //TODO Test class ThreadSystem final { private: struct RunningThread { std::function loopIteration; // The loopIteration callback returns true, if more iterations should be run, and false, if the thread should be terminated. boost::thread thread; // boost::thread because we need it to be interruptible. }; public: using Handle = std::list::iterator; static ThreadSystem &singleton(); Handle start(std::function loopIteration); void stop(Handle handle); private: ThreadSystem(); static void _runThread(std::function loopIteration); static void _onBeforeFork(); static void _onAfterFork(); //TODO Rename to _doOnBeforeFork and _doAfterFork or similar, because they also handle locking _mutex for fork(). void _stopAllThreadsForRestart(); void _restartAllThreads(); boost::thread _startThread(std::function loopIteration); std::list _runningThreads; // std::list, because we give out iterators as handles boost::mutex _mutex; DISALLOW_COPY_AND_ASSIGN(ThreadSystem); }; } #endif src/cryfs-cli/000077500000000000000000000000001300002025200135205ustar00rootroot00000000000000src/cryfs-cli/CMakeLists.txt000066400000000000000000000016721300002025200162660ustar00rootroot00000000000000project (cryfs-cli) set(SOURCES Cli.cpp VersionChecker.cpp CallAfterTimeout.cpp Environment.cpp program_options/utils.cpp program_options/ProgramOptions.cpp program_options/Parser.cpp ) add_library(${PROJECT_NAME} ${SOURCES}) target_link_libraries(${PROJECT_NAME} PUBLIC cryfs cpp-utils gitversion) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) if(NOT CRYFS_UPDATE_CHECKS) target_compile_definitions(${PROJECT_NAME} PRIVATE -DCRYFS_NO_UPDATE_CHECKS) endif(NOT CRYFS_UPDATE_CHECKS) add_executable(${PROJECT_NAME}_bin main.cpp) set_target_properties(${PROJECT_NAME}_bin PROPERTIES OUTPUT_NAME cryfs) target_link_libraries(${PROJECT_NAME}_bin PUBLIC ${PROJECT_NAME}) target_enable_style_warnings(${PROJECT_NAME}_bin) target_activate_cpp14(${PROJECT_NAME}_bin) install(TARGETS ${PROJECT_NAME}_bin DESTINATION bin CONFIGURATIONS Release ) src/cryfs-cli/CallAfterTimeout.cpp000066400000000000000000000000361300002025200174270ustar00rootroot00000000000000#include "CallAfterTimeout.h" src/cryfs-cli/CallAfterTimeout.h000066400000000000000000000037421300002025200171030ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CLI_CALLAFTERTIMEOUT_H #define MESSMER_CRYFS_SRC_CLI_CALLAFTERTIMEOUT_H #include #include #include namespace cryfs { class CallAfterTimeout final { public: CallAfterTimeout(boost::chrono::milliseconds timeout, std::function callback); void resetTimer(); private: bool _checkTimeoutThreadIteration(); boost::chrono::time_point _targetTime(); bool _callCallbackIfTimeout(); std::function _callback; boost::chrono::milliseconds _timeout; boost::chrono::time_point _start; cpputils::LoopThread _checkTimeoutThread; std::mutex _mutex; DISALLOW_COPY_AND_ASSIGN(CallAfterTimeout); }; inline CallAfterTimeout::CallAfterTimeout(boost::chrono::milliseconds timeout, std::function callback) :_callback(callback), _timeout(timeout), _start(), _checkTimeoutThread(std::bind(&CallAfterTimeout::_checkTimeoutThreadIteration, this)) { resetTimer(); _checkTimeoutThread.start(); } inline void CallAfterTimeout::resetTimer() { std::unique_lock lock(_mutex); _start = boost::chrono::steady_clock::now(); } inline bool CallAfterTimeout::_checkTimeoutThreadIteration() { boost::this_thread::sleep_until(_targetTime()); return _callCallbackIfTimeout(); } inline boost::chrono::time_point CallAfterTimeout::_targetTime() { std::unique_lock lock(_mutex); return _start + _timeout; } inline bool CallAfterTimeout::_callCallbackIfTimeout() { std::unique_lock lock(_mutex); if (boost::chrono::steady_clock::now() >= _start + _timeout) { _callback(); return false; // Stop thread } return true; // Continue thread } } #endif src/cryfs-cli/Cli.cpp000066400000000000000000000355671300002025200147530ustar00rootroot00000000000000#include "Cli.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include "program_options/Parser.h" #include #include #include #include "VersionChecker.h" #include #include #include "Environment.h" //TODO Fails with gpg-homedir in filesystem: gpg --homedir gpg-homedir --gen-key //TODO Many functions accessing the ProgramOptions object. Factor out into class that stores it as a member. //TODO Factor out class handling askPassword using namespace cryfs; namespace bf = boost::filesystem; using namespace cpputils::logging; using blockstore::ondisk::OnDiskBlockStore; using blockstore::inmemory::InMemoryBlockStore; using program_options::ProgramOptions; using cpputils::make_unique_ref; using cpputils::Random; using cpputils::NoninteractiveConsole; using cpputils::TempFile; using cpputils::RandomGenerator; using cpputils::unique_ref; using cpputils::SCryptSettings; using cpputils::Console; using cpputils::HttpClient; using cpputils::DontEchoStdinToStdoutRAII; using std::cin; using std::cout; using std::string; using std::endl; using std::vector; using std::shared_ptr; using std::make_shared; using std::unique_ptr; using std::make_unique; using std::function; using std::make_shared; using boost::optional; using boost::none; using boost::chrono::duration; using boost::chrono::duration_cast; using boost::chrono::minutes; using boost::chrono::milliseconds; using cpputils::dynamic_pointer_move; using gitversion::VersionCompare; //TODO Delete a large file in parallel possible? Takes a long time right now... //TODO Improve parallelity. //TODO Replace ASSERTs with other error handling when it is not a programming error but an environment influence (e.g. a block is missing) //TODO Can we improve performance by setting compiler parameter -maes for scrypt? //TODO Running nano in a cryfs file system, editing and saving an existing file shows "file was modified since opening". namespace cryfs { Cli::Cli(RandomGenerator &keyGenerator, const SCryptSettings &scryptSettings, shared_ptr console, shared_ptr httpClient): _keyGenerator(keyGenerator), _scryptSettings(scryptSettings), _console(), _httpClient(httpClient), _noninteractive(false) { _noninteractive = Environment::isNoninteractive(); if (_noninteractive) { _console = make_shared(console); } else { _console = console; } } void Cli::_showVersion() { cout << "CryFS Version " << gitversion::VersionString() << endl; if (gitversion::IsDevVersion()) { cout << "WARNING! This is a development version based on git commit " << gitversion::GitCommitId() << ". Please do not use in production!" << endl; } else if (!gitversion::IsStableVersion()) { cout << "WARNING! This is an experimental version. Please backup your data frequently!" << endl; } #ifndef NDEBUG cout << "WARNING! This is a debug build. Performance might be slow." << endl; #endif #ifndef CRYFS_NO_UPDATE_CHECKS if (Environment::noUpdateCheck()) { cout << "Automatic checking for security vulnerabilities and updates is disabled." << endl; } else if (Environment::isNoninteractive()) { cout << "Automatic checking for security vulnerabilities and updates is disabled in noninteractive mode." << endl; } else { _checkForUpdates(); } #else # warning Update checks are disabled. The resulting executable will not go online to check for newer versions or known security vulnerabilities. #endif cout << endl; } void Cli::_checkForUpdates() { VersionChecker versionChecker(_httpClient); optional newestVersion = versionChecker.newestVersion(); if (newestVersion == none) { cout << "Could not check for updates." << endl; } else if (VersionCompare::isOlderThan(gitversion::VersionString(), *newestVersion)) { cout << "CryFS " << *newestVersion << " is released. Please update." << endl; } optional securityWarning = versionChecker.securityWarningFor(gitversion::VersionString()); if (securityWarning != none) { cout << *securityWarning << endl; } } bool Cli::_checkPassword(const string &password) { if (password == "") { std::cerr << "Empty password not allowed. Please try again." << std::endl; return false; } return true; } string Cli::_askPasswordForExistingFilesystem() { string password = _askPasswordFromStdin("Password: "); while (!_checkPassword(password)) { password = _askPasswordFromStdin("Password: "); } return password; }; string Cli::_askPasswordForNewFilesystem() { string password; bool again = false; do { password = _askPasswordFromStdin("Password: "); if (!_checkPassword(password)) { again = true; continue; } if (!_confirmPassword(password)) { again = true; continue; } again = false; } while(again); return password; } bool Cli::_confirmPassword(const string &password) { string confirmPassword = _askPasswordFromStdin("Confirm Password: "); if (password != confirmPassword) { std::cout << "Passwords don't match" << std::endl; return false; } return true; } string Cli::_askPasswordNoninteractive() { //TODO Test string password = _askPasswordFromStdin("Password: "); if (!_checkPassword(password)) { throw std::runtime_error("Invalid password. Password cannot be empty."); } return password; } string Cli::_askPasswordFromStdin(const string &prompt) { DontEchoStdinToStdoutRAII _stdin_input_is_hidden_as_long_as_this_is_in_scope; std::cout << prompt << std::flush; string result; std::getline(cin, result); std::cout << std::endl; //Remove trailing newline if (result[result.size()-1] == '\n') { result.resize(result.size()-1); } return result; } bf::path Cli::_determineConfigFile(const ProgramOptions &options) { auto configFile = options.configFile(); if (configFile == none) { return bf::path(options.baseDir()) / "cryfs.config"; } return *configFile; } CryConfigFile Cli::_loadOrCreateConfig(const ProgramOptions &options) { try { auto configFile = _determineConfigFile(options); auto config = _loadOrCreateConfigFile(configFile, options.cipher(), options.blocksizeBytes()); if (config == none) { std::cerr << "Could not load config file. Did you enter the correct password?" << std::endl; exit(1); } return std::move(*config); } catch (const std::exception &e) { std::cerr << "Error: " << e.what() << std::endl; exit(1); } } optional Cli::_loadOrCreateConfigFile(const bf::path &configFilePath, const optional &cipher, const optional &blocksizeBytes) { if (_noninteractive) { return CryConfigLoader(_console, _keyGenerator, _scryptSettings, &Cli::_askPasswordNoninteractive, &Cli::_askPasswordNoninteractive, cipher, blocksizeBytes).loadOrCreate(configFilePath); } else { return CryConfigLoader(_console, _keyGenerator, _scryptSettings, &Cli::_askPasswordForExistingFilesystem, &Cli::_askPasswordForNewFilesystem, cipher, blocksizeBytes).loadOrCreate(configFilePath); } } void Cli::_runFilesystem(const ProgramOptions &options) { try { auto blockStore = make_unique_ref(options.baseDir()); auto config = _loadOrCreateConfig(options); CryDevice device(std::move(config), std::move(blockStore)); _sanityCheckFilesystem(&device); fspp::FilesystemImpl fsimpl(&device); fspp::fuse::Fuse fuse(&fsimpl, "cryfs", "cryfs@"+options.baseDir().native()); _initLogfile(options); //TODO Test auto unmounting after idle timeout //TODO This can fail due to a race condition if the filesystem isn't started yet (e.g. passing --unmount-idle 0"). auto idleUnmounter = _createIdleCallback(options.unmountAfterIdleMinutes(), [&fuse] {fuse.stop();}); if (idleUnmounter != none) { device.onFsAction(std::bind(&CallAfterTimeout::resetTimer, idleUnmounter->get())); } #ifdef __APPLE__ std::cout << "\nMounting filesystem. To unmount, call:\n$ umount " << options.mountDir() << "\n" << std::endl; #else std::cout << "\nMounting filesystem. To unmount, call:\n$ fusermount -u " << options.mountDir() << "\n" << std::endl; #endif fuse.run(options.mountDir(), options.fuseOptions()); } catch (const std::exception &e) { LOG(ERROR) << "Crashed: " << e.what(); } catch (...) { LOG(ERROR) << "Crashed"; } } void Cli::_sanityCheckFilesystem(CryDevice *device) { //Try to list contents of base directory auto _rootDir = device->Load("/"); // this might throw an exception if the root blob doesn't exist if (_rootDir == none) { throw std::runtime_error("Couldn't find root blob"); } auto rootDir = dynamic_pointer_move(*_rootDir); if (rootDir == none) { throw std::runtime_error("Base directory blob doesn't contain a directory"); } (*rootDir)->children(); // Load children } optional> Cli::_createIdleCallback(optional minutes, function callback) { if (minutes == none) { return none; } uint64_t millis = std::round(60000 * (*minutes)); return make_unique_ref(milliseconds(millis), callback); } void Cli::_initLogfile(const ProgramOptions &options) { spdlog::drop("cryfs"); //TODO Test that --logfile parameter works. Should be: file if specified, otherwise stderr if foreground, else syslog. if (options.logFile() != none) { cpputils::logging::setLogger( spdlog::create>("cryfs", options.logFile()->native())); } else if (options.foreground()) { cpputils::logging::setLogger(spdlog::stderr_logger_mt("cryfs")); } else { cpputils::logging::setLogger(spdlog::syslog_logger("cryfs", "cryfs", LOG_PID)); } } void Cli::_sanityChecks(const ProgramOptions &options) { _checkDirAccessible(options.baseDir(), "base directory"); _checkDirAccessible(options.mountDir(), "mount directory"); _checkMountdirDoesntContainBasedir(options); } void Cli::_checkDirAccessible(const bf::path &dir, const std::string &name) { if (!bf::exists(dir)) { bool create = _console->askYesNo("Could not find " + name + ". Do you want to create it?", false); if (create) { if (!bf::create_directory(dir)) { throw std::runtime_error("Error creating "+name); } } else { throw std::runtime_error(name + " not found."); } } if (!bf::is_directory(dir)) { throw std::runtime_error(name+" is not a directory."); } auto file = _checkDirWriteable(dir, name); _checkDirReadable(dir, file, name); } shared_ptr Cli::_checkDirWriteable(const bf::path &dir, const std::string &name) { auto path = dir / "tempfile"; try { return make_shared(path); } catch (const std::runtime_error &e) { throw std::runtime_error("Could not write to "+name+"."); } } void Cli::_checkDirReadable(const bf::path &dir, shared_ptr tempfile, const std::string &name) { ASSERT(bf::equivalent(dir, tempfile->path().parent_path()), "This function should be called with a file inside the directory"); try { bool found = false; bf::directory_iterator end; for (auto iter = bf::directory_iterator(dir); iter != end; ++iter) { if (bf::equivalent(*iter, tempfile->path())) { found = true; } } if (!found) { //This should not happen. Can only happen if the written temp file got deleted inbetween or maybe was not written at all. throw std::runtime_error("Error accessing "+name+"."); } } catch (const boost::filesystem::filesystem_error &e) { throw std::runtime_error("Could not read from "+name+"."); } } void Cli::_checkMountdirDoesntContainBasedir(const ProgramOptions &options) { if (_pathContains(options.mountDir(), options.baseDir())) { throw std::runtime_error("base directory can't be inside the mount directory."); } } bool Cli::_pathContains(const bf::path &parent, const bf::path &child) { bf::path absParent = bf::canonical(parent); bf::path current = bf::canonical(child); if (absParent.empty() && current.empty()) { return true; } while(!current.empty()) { if (bf::equivalent(current, absParent)) { return true; } current = current.parent_path(); } return false; } int Cli::main(int argc, const char *argv[]) { cpputils::showBacktraceOnSigSegv(); _showVersion(); ProgramOptions options = program_options::Parser(argc, argv).parse(CryCiphers::supportedCipherNames()); try { _sanityChecks(options); _runFilesystem(options); } catch (const std::runtime_error &e) { std::cerr << "Error: " << e.what() << std::endl; exit(1); } return 0; } } src/cryfs-cli/Cli.h000066400000000000000000000054771300002025200144150ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_CLI_H #define MESSMER_CRYFS_CLI_H #include "program_options/ProgramOptions.h" #include #include #include #include #include #include #include #include "CallAfterTimeout.h" namespace cryfs { class Cli final { public: Cli(cpputils::RandomGenerator &keyGenerator, const cpputils::SCryptSettings &scryptSettings, std::shared_ptr console, std::shared_ptr httpClient); int main(int argc, const char *argv[]); private: void _checkForUpdates(); void _runFilesystem(const program_options::ProgramOptions &options); CryConfigFile _loadOrCreateConfig(const program_options::ProgramOptions &options); boost::optional _loadOrCreateConfigFile(const boost::filesystem::path &configFilePath, const boost::optional &cipher, const boost::optional &blocksizeBytes); boost::filesystem::path _determineConfigFile(const program_options::ProgramOptions &options); static std::string _askPasswordForExistingFilesystem(); static std::string _askPasswordForNewFilesystem(); static std::string _askPasswordNoninteractive(); static std::string _askPasswordFromStdin(const std::string &prompt); static bool _confirmPassword(const std::string &password); static bool _checkPassword(const std::string &password); void _showVersion(); void _initLogfile(const program_options::ProgramOptions &options); void _sanityChecks(const program_options::ProgramOptions &options); void _checkMountdirDoesntContainBasedir(const program_options::ProgramOptions &options); bool _pathContains(const boost::filesystem::path &parent, const boost::filesystem::path &child); void _checkDirAccessible(const boost::filesystem::path &dir, const std::string &name); std::shared_ptr _checkDirWriteable(const boost::filesystem::path &dir, const std::string &name); void _checkDirReadable(const boost::filesystem::path &dir, std::shared_ptr tempfile, const std::string &name); boost::optional> _createIdleCallback(boost::optional minutes, std::function callback); void _sanityCheckFilesystem(CryDevice *device); cpputils::RandomGenerator &_keyGenerator; cpputils::SCryptSettings _scryptSettings; std::shared_ptr _console; std::shared_ptr _httpClient; bool _noninteractive; DISALLOW_COPY_AND_ASSIGN(Cli); }; } #endif src/cryfs-cli/Environment.cpp000066400000000000000000000011231300002025200165250ustar00rootroot00000000000000#include "Environment.h" #include using std::string; namespace cryfs { const string Environment::FRONTEND_KEY = "CRYFS_FRONTEND"; const string Environment::FRONTEND_NONINTERACTIVE = "noninteractive"; const string Environment::NOUPDATECHECK_KEY = "CRYFS_NO_UPDATE_CHECK"; bool Environment::isNoninteractive() { char *frontend = std::getenv(FRONTEND_KEY.c_str()); return frontend != nullptr && frontend == FRONTEND_NONINTERACTIVE; } bool Environment::noUpdateCheck() { return nullptr != std::getenv(NOUPDATECHECK_KEY.c_str()); } } src/cryfs-cli/Environment.h000066400000000000000000000007241300002025200162000ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_CLI_ENVIRONMENT_H #define MESSMER_CRYFS_CLI_ENVIRONMENT_H #include namespace cryfs { class Environment { public: static bool isNoninteractive(); static bool noUpdateCheck(); static const std::string FRONTEND_KEY; static const std::string FRONTEND_NONINTERACTIVE; static const std::string NOUPDATECHECK_KEY; private: Environment() = delete; }; } #endif src/cryfs-cli/VersionChecker.cpp000066400000000000000000000042021300002025200171340ustar00rootroot00000000000000#include "VersionChecker.h" #include #include #include #include #include using boost::optional; using boost::none; using std::string; using std::shared_ptr; using std::make_shared; using cpputils::HttpClient; using cpputils::CurlHttpClient; using boost::property_tree::ptree; using boost::property_tree::json_parser_error; using namespace cpputils::logging; namespace cryfs { VersionChecker::VersionChecker(shared_ptr httpClient) : _versionInfo(_getVersionInfo(std::move(httpClient))) { } optional VersionChecker::newestVersion() const { if (_versionInfo == none) { return none; } string version = _versionInfo->get("version_info.current", ""); if (version == "") { return none; } return version; } optional VersionChecker::securityWarningFor(const string &version) const { if (_versionInfo == none) { return none; } auto warnings = _versionInfo->get_child_optional("warnings"); if (warnings == none) { return none; } BOOST_FOREACH(const ptree::value_type &v, *warnings) { if(v.first == version) { return v.second.get_value(); } } return none; } optional VersionChecker::_getVersionInfo(shared_ptr httpClient) { long timeoutMsec = 2000; optional response = httpClient->get("https://www.cryfs.org/version_info.json", timeoutMsec); if (response == none) { return none; } return _parseJson(*response); } optional VersionChecker::_parseJson(const string &json) { try { ptree pt; std::istringstream input(json); read_json(input, pt); return pt; } catch (const json_parser_error &e) { LOG(WARN) << "Error parsing version information json object"; return none; } } } src/cryfs-cli/VersionChecker.h000066400000000000000000000017161300002025200166100ustar00rootroot00000000000000#ifndef MESSMER_CRYFS_SRC_CLI_VERSIONCHECKER_H #define MESSMER_CRYFS_SRC_CLI_VERSIONCHECKER_H #include #include #include #include #include namespace cryfs { class VersionChecker final { public: //TODO Write a cpputils::shared_ref and use it VersionChecker(std::shared_ptr httpClient); boost::optional newestVersion() const; boost::optional securityWarningFor(const std::string &version) const; private: static boost::optional _getVersionInfo(std::shared_ptr httpClient); static boost::optional _parseJson(const std::string &json); boost::optional _versionInfo; DISALLOW_COPY_AND_ASSIGN(VersionChecker); }; } #endif src/cryfs-cli/main.cpp000066400000000000000000000013401300002025200151460ustar00rootroot00000000000000#include "Cli.h" #include #include #include #include using namespace cryfs; using cpputils::Random; using cpputils::SCrypt; using cpputils::CurlHttpClient; using cpputils::IOStreamConsole; using std::make_shared; using std::cerr; int main(int argc, const char *argv[]) { try { auto &keyGenerator = Random::OSRandom(); return Cli(keyGenerator, SCrypt::DefaultSettings, make_shared(), make_shared()).main(argc, argv); } catch (const std::exception &e) { cerr << "Error: " << e.what(); return EXIT_FAILURE; } } src/cryfs-cli/program_options/000077500000000000000000000000001300002025200167425ustar00rootroot00000000000000src/cryfs-cli/program_options/Parser.cpp000066400000000000000000000145271300002025200207130ustar00rootroot00000000000000#include "Parser.h" #include "utils.h" #include #include #include namespace po = boost::program_options; namespace bf = boost::filesystem; using namespace cryfs::program_options; using std::pair; using std::vector; using std::cerr; using std::endl; using std::string; using boost::optional; using boost::none; Parser::Parser(int argc, const char *argv[]) :_options(_argsToVector(argc, argv)) { } vector Parser::_argsToVector(int argc, const char *argv[]) { vector result; for(int i = 0; i < argc; ++i) { result.push_back(argv[i]); } return result; } ProgramOptions Parser::parse(const vector &supportedCiphers) const { pair, vector> options = splitAtDoubleDash(_options); po::variables_map vm = _parseOptionsOrShowHelp(options.first, supportedCiphers); if (!vm.count("base-dir")) { std::cerr << "Please specify a base directory.\n"; _showHelpAndExit(); } if (!vm.count("mount-dir")) { std::cerr << "Please specify a mount directory.\n"; _showHelpAndExit(); } bf::path baseDir = bf::absolute(vm["base-dir"].as()); bf::path mountDir = bf::absolute(vm["mount-dir"].as()); optional configfile = none; if (vm.count("config")) { configfile = bf::absolute(vm["config"].as()); } bool foreground = vm.count("foreground"); if (foreground) { options.second.push_back(const_cast("-f")); } optional unmountAfterIdleMinutes = none; if (vm.count("unmount-idle")) { unmountAfterIdleMinutes = vm["unmount-idle"].as(); } optional logfile = none; if (vm.count("logfile")) { logfile = bf::absolute(vm["logfile"].as()); } optional cipher = none; if (vm.count("cipher")) { cipher = vm["cipher"].as(); _checkValidCipher(*cipher, supportedCiphers); } optional blocksizeBytes = none; if (vm.count("blocksize")) { blocksizeBytes = vm["blocksize"].as(); } return ProgramOptions(baseDir, mountDir, configfile, foreground, unmountAfterIdleMinutes, logfile, cipher, blocksizeBytes, options.second); } void Parser::_checkValidCipher(const string &cipher, const vector &supportedCiphers) { if (std::find(supportedCiphers.begin(), supportedCiphers.end(), cipher) == supportedCiphers.end()) { std::cerr << "Invalid cipher: " << cipher << std::endl; exit(1); } } po::variables_map Parser::_parseOptionsOrShowHelp(const vector &options, const vector &supportedCiphers) { try { return _parseOptions(options, supportedCiphers); } catch(const std::exception &e) { std::cerr << e.what() << std::endl; _showHelpAndExit(); } } po::variables_map Parser::_parseOptions(const vector &options, const vector &supportedCiphers) { po::options_description desc; po::positional_options_description positional_desc; _addAllowedOptions(&desc); _addPositionalOptionForBaseDir(&desc, &positional_desc); po::variables_map vm; vector _options = _to_const_char_vector(options); po::store(po::command_line_parser(_options.size(), _options.data()) .options(desc).positional(positional_desc).run(), vm); if (vm.count("help")) { _showHelpAndExit(); } if (vm.count("show-ciphers")) { _showCiphersAndExit(supportedCiphers); } po::notify(vm); return vm; } vector Parser::_to_const_char_vector(const vector &options) { vector result; result.reserve(options.size()); for (const string &option : options) { result.push_back(option.c_str()); } return result; } void Parser::_addAllowedOptions(po::options_description *desc) { po::options_description options("Allowed options"); options.add_options() ("help,h", "show help message") ("config,c", po::value(), "Configuration file") ("foreground,f", "Run CryFS in foreground.") ("cipher", po::value(), "Cipher to use for encryption. See possible values by calling cryfs with --show-ciphers.") ("blocksize", po::value(), "The block size used when storing ciphertext blocks (in bytes).") ("show-ciphers", "Show list of supported ciphers.") ("unmount-idle", po::value(), "Automatically unmount after specified number of idle minutes.") ("logfile", po::value(), "Specify the file to write log messages to. If this is not specified, log messages will go to stdout, or syslog if CryFS is running in the background.") ; desc->add(options); } void Parser::_addPositionalOptionForBaseDir(po::options_description *desc, po::positional_options_description *positional) { positional->add("base-dir", 1); positional->add("mount-dir", 1); po::options_description hidden("Hidden options"); hidden.add_options() ("base-dir", po::value(), "Base directory") ("mount-dir", po::value(), "Mount directory") ; desc->add(hidden); } [[noreturn]] void Parser::_showCiphersAndExit(const vector &supportedCiphers) { for (const auto &cipher : supportedCiphers) { std::cerr << cipher << "\n"; } exit(0); } [[noreturn]] void Parser::_showHelpAndExit() { cerr << "Usage: cryfs [options] baseDir mountPoint [-- [FUSE Mount Options]]\n"; po::options_description desc; _addAllowedOptions(&desc); cerr << desc << endl; cerr << "Environment variables:\n" << " " << Environment::FRONTEND_KEY << "=" << Environment::FRONTEND_NONINTERACTIVE << "\n" << "\tWork better together with tools.\n" << "\tWith this option set, CryFS won't ask anything, but use default values\n" << "\tfor options you didn't specify on command line. Furthermore, it won't\n" << "\task you to enter a new password a second time (password confirmation).\n" << " " << Environment::NOUPDATECHECK_KEY << "=true\n" << "\tBy default, CryFS connects to the internet to check for known\n" << "\tsecurity vulnerabilities and new versions. This option disables this.\n" << endl; exit(1); } src/cryfs-cli/program_options/Parser.h000066400000000000000000000032331300002025200203500ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_PROGRAMOPTIONS_PARSER_H #define MESSMER_CRYFS_PROGRAMOPTIONS_PARSER_H #include "ProgramOptions.h" #include namespace cryfs { namespace program_options { class Parser final { public: Parser(int argc, const char *argv[]); ProgramOptions parse(const std::vector &supportedCiphers) const; private: static std::vector _argsToVector(int argc, const char *argv[]); static std::vector _to_const_char_vector(const std::vector &options); static void _addAllowedOptions(boost::program_options::options_description *desc); static void _addPositionalOptionForBaseDir(boost::program_options::options_description *desc, boost::program_options::positional_options_description *positional); [[noreturn]] static void _showHelpAndExit(); [[noreturn]] static void _showCiphersAndExit(const std::vector &supportedCiphers); static boost::program_options::variables_map _parseOptionsOrShowHelp(const std::vector &options, const std::vector &supportedCiphers); static boost::program_options::variables_map _parseOptions(const std::vector &options, const std::vector &supportedCiphers); static void _checkValidCipher(const std::string &cipher, const std::vector &supportedCiphers); std::vector _options; DISALLOW_COPY_AND_ASSIGN(Parser); }; } } #endif src/cryfs-cli/program_options/ProgramOptions.cpp000066400000000000000000000032471300002025200224370ustar00rootroot00000000000000#include "ProgramOptions.h" #include #include using namespace cryfs::program_options; using std::string; using std::vector; using boost::optional; namespace bf = boost::filesystem; ProgramOptions::ProgramOptions(const bf::path &baseDir, const bf::path &mountDir, const optional &configFile, bool foreground, const optional &unmountAfterIdleMinutes, const optional &logFile, const optional &cipher, const optional &blocksizeBytes, const vector &fuseOptions) :_baseDir(baseDir), _mountDir(mountDir), _configFile(configFile), _foreground(foreground), _cipher(cipher), _blocksizeBytes(blocksizeBytes), _unmountAfterIdleMinutes(unmountAfterIdleMinutes), _logFile(logFile), _fuseOptions(fuseOptions) { } const bf::path &ProgramOptions::baseDir() const { return _baseDir; } const bf::path &ProgramOptions::mountDir() const { return _mountDir; } const optional &ProgramOptions::configFile() const { return _configFile; } bool ProgramOptions::foreground() const { return _foreground; } const optional &ProgramOptions::unmountAfterIdleMinutes() const { return _unmountAfterIdleMinutes; } const optional &ProgramOptions::logFile() const { return _logFile; } const optional &ProgramOptions::cipher() const { return _cipher; } const optional &ProgramOptions::blocksizeBytes() const { return _blocksizeBytes; } const vector &ProgramOptions::fuseOptions() const { return _fuseOptions; } src/cryfs-cli/program_options/ProgramOptions.h000066400000000000000000000041751300002025200221050ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_PROGRAMOPTIONS_PROGRAMOPTIONS_H #define MESSMER_CRYFS_PROGRAMOPTIONS_PROGRAMOPTIONS_H #include #include #include #include #include namespace cryfs { namespace program_options { class ProgramOptions final { public: ProgramOptions(const boost::filesystem::path &baseDir, const boost::filesystem::path &mountDir, const boost::optional &configFile, bool foreground, const boost::optional &unmountAfterIdleMinutes, const boost::optional &logFile, const boost::optional &cipher, const boost::optional &blocksizeBytes, const std::vector &fuseOptions); ProgramOptions(ProgramOptions &&rhs) = default; const boost::filesystem::path &baseDir() const; const boost::filesystem::path &mountDir() const; const boost::optional &configFile() const; bool foreground() const; const boost::optional &cipher() const; const boost::optional &blocksizeBytes() const; const boost::optional &unmountAfterIdleMinutes() const; const boost::optional &logFile() const; const std::vector &fuseOptions() const; private: boost::filesystem::path _baseDir; boost::filesystem::path _mountDir; boost::optional _configFile; bool _foreground; boost::optional _cipher; boost::optional _blocksizeBytes; boost::optional _unmountAfterIdleMinutes; boost::optional _logFile; std::vector _fuseOptions; DISALLOW_COPY_AND_ASSIGN(ProgramOptions); }; } } #endif src/cryfs-cli/program_options/utils.cpp000066400000000000000000000015751300002025200206160ustar00rootroot00000000000000#include "utils.h" #include #include using std::pair; using std::make_pair; using std::vector; using std::string; namespace cryfs { namespace program_options { pair, vector> splitAtDoubleDash(const vector &options) { auto doubleDashIterator = std::find(options.begin(), options.end(), string("--")); vector beforeDoubleDash(options.begin(), doubleDashIterator); vector afterDoubleDash; afterDoubleDash.reserve(options.size()-beforeDoubleDash.size()); if (options.end() >= doubleDashIterator+1) { std::copy(doubleDashIterator + 1, options.end(), std::back_inserter(afterDoubleDash)); } return make_pair( beforeDoubleDash, afterDoubleDash ); } } } src/cryfs-cli/program_options/utils.h000066400000000000000000000007621300002025200202600ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_PROGRAMOPTIONS_UTILS_H #define MESSMER_CRYFS_PROGRAMOPTIONS_UTILS_H #include #include #include namespace cryfs { namespace program_options { /** * Splits an array of program options into two arrays of program options, split at a double dash '--' option. */ std::pair, std::vector> splitAtDoubleDash(const std::vector &options); } } #endif src/cryfs/000077500000000000000000000000001300002025200127535ustar00rootroot00000000000000src/cryfs/CMakeLists.txt000066400000000000000000000045611300002025200155210ustar00rootroot00000000000000project (cryfs) set(LIB_SOURCES # cryfs.cpp config/crypto/outer/OuterConfig.cpp config/crypto/outer/OuterEncryptor.cpp config/crypto/CryConfigEncryptorFactory.cpp config/crypto/inner/ConcreteInnerEncryptor.cpp config/crypto/inner/InnerConfig.cpp config/crypto/inner/InnerEncryptor.cpp config/crypto/CryConfigEncryptor.cpp config/CryConfigConsole.cpp config/CryConfigLoader.cpp config/CryConfig.cpp config/CryConfigFile.cpp config/CryCipher.cpp config/CryConfigCreator.cpp filesystem/CryOpenFile.cpp filesystem/fsblobstore/utils/DirEntry.cpp filesystem/fsblobstore/utils/DirEntryList.cpp filesystem/fsblobstore/FsBlobStore.cpp filesystem/fsblobstore/FsBlobView.cpp filesystem/fsblobstore/FileBlob.cpp filesystem/fsblobstore/FsBlob.cpp filesystem/fsblobstore/SymlinkBlob.cpp filesystem/fsblobstore/DirBlob.cpp filesystem/CryNode.cpp filesystem/parallelaccessfsblobstore/DirBlobRef.cpp filesystem/parallelaccessfsblobstore/ParallelAccessFsBlobStore.cpp filesystem/parallelaccessfsblobstore/ParallelAccessFsBlobStoreAdapter.cpp filesystem/parallelaccessfsblobstore/FsBlobRef.cpp filesystem/parallelaccessfsblobstore/FileBlobRef.cpp filesystem/parallelaccessfsblobstore/SymlinkBlobRef.cpp filesystem/CrySymlink.cpp filesystem/CryDir.cpp filesystem/cachingfsblobstore/DirBlobRef.cpp filesystem/cachingfsblobstore/CachingFsBlobStore.cpp filesystem/cachingfsblobstore/FsBlobRef.cpp filesystem/cachingfsblobstore/FileBlobRef.cpp filesystem/cachingfsblobstore/SymlinkBlobRef.cpp filesystem/CryFile.cpp filesystem/CryDevice.cpp ) add_library(${PROJECT_NAME} STATIC ${LIB_SOURCES}) set_target_properties(${PROJECT_NAME} PROPERTIES OUTPUT_NAME cryfs) target_link_libraries(${PROJECT_NAME} PRIVATE cpp-utils blockstore blobstore fspp gitversion) # TODO Check that dependent projects don't get this linked in target_add_boost(${PROJECT_NAME} program_options chrono) # TODO Check that dependent projects don't get boost added (use PRIVATE here) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) #install(TARGETS ${PROJECT_NAME} # DESTINATION lib # CONFIGURATIONS Release #) src/cryfs/config/000077500000000000000000000000001300002025200142205ustar00rootroot00000000000000src/cryfs/config/CryCipher.cpp000066400000000000000000000100521300002025200166120ustar00rootroot00000000000000#include "CryCipher.h" #include #include #include "crypto/inner/ConcreteInnerEncryptor.h" using std::vector; using std::string; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::FixedSizeData; using blockstore::BlockStore; using std::shared_ptr; using std::make_shared; using boost::optional; using boost::none; using blockstore::encrypted::EncryptedBlockStore; using namespace cryfs; using namespace cpputils; constexpr size_t CryCiphers::MAX_KEY_SIZE; template class CryCipherInstance: public CryCipher { public: BOOST_CONCEPT_ASSERT((CipherConcept)); static_assert(Cipher::EncryptionKey::BINARY_LENGTH <= CryCiphers::MAX_KEY_SIZE, "The key size for this cipher is too large. Please modify CryCiphers::MAX_KEY_SIZE"); CryCipherInstance(const optional warning = none): _warning(warning) { } string cipherName() const override { return Cipher::NAME; } const optional &warning() const override { return _warning; } unique_ref createEncryptedBlockstore(unique_ref baseBlockStore, const string &encKey) const override { return make_unique_ref>(std::move(baseBlockStore), Cipher::EncryptionKey::FromString(encKey)); } string createKey(cpputils::RandomGenerator &randomGenerator) const override { return Cipher::CreateKey(randomGenerator).ToString(); } unique_ref createInnerConfigEncryptor(const FixedSizeData &key) const override { return make_unique_ref>(key.take()); } private: optional _warning; }; const string CryCiphers::INTEGRITY_WARNING = "This cipher does not ensure integrity."; //We have to use shared_ptr instead of unique_ref, because c++ initializer_list needs copyable values const vector> CryCiphers::SUPPORTED_CIPHERS = { make_shared>(), make_shared>(INTEGRITY_WARNING), make_shared>(), make_shared>(INTEGRITY_WARNING), make_shared>(), make_shared>(INTEGRITY_WARNING), make_shared>(), make_shared>(INTEGRITY_WARNING), make_shared>(), make_shared>(INTEGRITY_WARNING), make_shared>(), make_shared>(INTEGRITY_WARNING), make_shared>(), make_shared>(INTEGRITY_WARNING), #if CRYPTOPP_VERSION != 564 make_shared>(), make_shared>(INTEGRITY_WARNING), #endif make_shared>(), make_shared>(INTEGRITY_WARNING), make_shared>(), make_shared>(INTEGRITY_WARNING) }; const CryCipher& CryCiphers::find(const string &cipherName) { auto found = std::find_if(CryCiphers::SUPPORTED_CIPHERS.begin(), CryCiphers::SUPPORTED_CIPHERS.end(), [cipherName] (const std::shared_ptr& element) { return element->cipherName() == cipherName; }); ASSERT(found != CryCiphers::SUPPORTED_CIPHERS.end(), "Unknown Cipher: "+cipherName); return **found; } vector CryCiphers::supportedCipherNames() { vector result; for (const auto& cipher : CryCiphers::SUPPORTED_CIPHERS) { result.push_back(cipher->cipherName()); } return result; } src/cryfs/config/CryCipher.h000066400000000000000000000027551300002025200162720ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYCIPHER_H #define MESSMER_CRYFS_SRC_CONFIG_CRYCIPHER_H #include #include #include #include #include #include "crypto/inner/InnerEncryptor.h" namespace cryfs { class CryCipher; class CryCiphers final { public: static std::vector supportedCipherNames(); //A static_assert in CryCipherInstance ensures that there is no cipher with a key size larger than specified here. //TODO Calculate this from SUPPORTED_CIPHERS instead of setting it manually static constexpr size_t MAX_KEY_SIZE = 56; // in bytes static const CryCipher& find(const std::string &cipherName); private: static const std::string INTEGRITY_WARNING; static const std::vector> SUPPORTED_CIPHERS; }; class CryCipher { public: virtual ~CryCipher() {} virtual std::string cipherName() const = 0; virtual const boost::optional &warning() const = 0; virtual cpputils::unique_ref createEncryptedBlockstore(cpputils::unique_ref baseBlockStore, const std::string &encKey) const = 0; virtual std::string createKey(cpputils::RandomGenerator &randomGenerator) const = 0; virtual cpputils::unique_ref createInnerConfigEncryptor(const cpputils::FixedSizeData &key) const = 0; }; } #endif src/cryfs/config/CryConfig.cpp000066400000000000000000000076301300002025200166150ustar00rootroot00000000000000#include "CryConfig.h" #include #include #include #include #include #include namespace bf = boost::filesystem; using boost::property_tree::ptree; using boost::optional; using boost::none; using std::string; using std::stringstream; using cpputils::Data; using gitversion::VersionCompare; using cpputils::Random; namespace cryfs { CryConfig::CryConfig() : _rootBlob(""), _encKey(""), _cipher(""), _version(""), _createdWithVersion(""), _blocksizeBytes(0), _filesystemId(FilesystemID::Null()) { } CryConfig::CryConfig(CryConfig &&rhs) : _rootBlob(std::move(rhs._rootBlob)), _encKey(std::move(rhs._encKey)), _cipher(std::move(rhs._cipher)), _version(std::move(rhs._version)), _createdWithVersion(std::move(rhs._createdWithVersion)), _blocksizeBytes(rhs._blocksizeBytes), _filesystemId(std::move(rhs._filesystemId)) { } CryConfig::CryConfig(const CryConfig &rhs) : _rootBlob(rhs._rootBlob), _encKey(rhs._encKey), _cipher(rhs._cipher), _version(rhs._version), _createdWithVersion(rhs._createdWithVersion), _blocksizeBytes(rhs._blocksizeBytes), _filesystemId(rhs._filesystemId) { } CryConfig CryConfig::load(const Data &data) { stringstream stream; data.StoreToStream(stream); ptree pt; read_json(stream, pt); CryConfig cfg; cfg._rootBlob = pt.get("cryfs.rootblob"); cfg._encKey = pt.get("cryfs.key"); cfg._cipher = pt.get("cryfs.cipher"); cfg._version = pt.get("cryfs.version", "0.8"); // CryFS 0.8 didn't specify this field, so if the field doesn't exist, it's 0.8. cfg._createdWithVersion = pt.get("cryfs.createdWithVersion", cfg._version); // In CryFS <= 0.9.2, we didn't have this field, but also didn't update cryfs.version, so we can use this field instead. cfg._blocksizeBytes = pt.get("cryfs.blocksizeBytes", 32832); // CryFS <= 0.9.2 used a 32KB block size which was this physical block size. optional filesystemIdOpt = pt.get_optional("cryfs.filesystemId"); if (filesystemIdOpt == none) { cfg._filesystemId = Random::PseudoRandom().getFixedSize(); } else { cfg._filesystemId = FilesystemID::FromString(*filesystemIdOpt); } return cfg; } Data CryConfig::save() const { ptree pt; pt.put("cryfs.rootblob", _rootBlob); pt.put("cryfs.key", _encKey); pt.put("cryfs.cipher", _cipher); pt.put("cryfs.version", _version); pt.put("cryfs.createdWithVersion", _createdWithVersion); pt.put("cryfs.blocksizeBytes", _blocksizeBytes); pt.put("cryfs.filesystemId", _filesystemId.ToString()); stringstream stream; write_json(stream, pt); return Data::LoadFromStream(stream); } const std::string &CryConfig::RootBlob() const { return _rootBlob; } void CryConfig::SetRootBlob(const std::string &value) { _rootBlob = value; } const string &CryConfig::EncryptionKey() const { return _encKey; } void CryConfig::SetEncryptionKey(const std::string &value) { _encKey = value; } const std::string &CryConfig::Cipher() const { return _cipher; }; void CryConfig::SetCipher(const std::string &value) { _cipher = value; } const std::string &CryConfig::Version() const { return _version; } void CryConfig::SetVersion(const std::string &value) { _version = value; } const std::string &CryConfig::CreatedWithVersion() const { return _createdWithVersion; } void CryConfig::SetCreatedWithVersion(const std::string &value) { _createdWithVersion = value; } uint64_t CryConfig::BlocksizeBytes() const { return _blocksizeBytes; } void CryConfig::SetBlocksizeBytes(uint64_t value) { _blocksizeBytes = value; } const CryConfig::FilesystemID &CryConfig::FilesystemId() const { return _filesystemId; } void CryConfig::SetFilesystemId(const FilesystemID &value) { _filesystemId = value; } } src/cryfs/config/CryConfig.h000066400000000000000000000026741300002025200162650ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYCONFIG_H_ #define MESSMER_CRYFS_SRC_CONFIG_CRYCONFIG_H_ #include #include #include #include namespace cryfs { class CryConfig final { public: //TODO No default constructor, pass in config values instead! CryConfig(); CryConfig(CryConfig &&rhs); CryConfig(const CryConfig &rhs); const std::string &RootBlob() const; void SetRootBlob(const std::string &value); const std::string &EncryptionKey() const; void SetEncryptionKey(const std::string &value); const std::string &Cipher() const; void SetCipher(const std::string &value); const std::string &Version() const; void SetVersion(const std::string &value); const std::string &CreatedWithVersion() const; void SetCreatedWithVersion(const std::string &value); uint64_t BlocksizeBytes() const; void SetBlocksizeBytes(uint64_t value); using FilesystemID = cpputils::FixedSizeData<16>; const FilesystemID &FilesystemId() const; void SetFilesystemId(const FilesystemID &value); static CryConfig load(const cpputils::Data &data); cpputils::Data save() const; private: std::string _rootBlob; std::string _encKey; std::string _cipher; std::string _version; std::string _createdWithVersion; uint64_t _blocksizeBytes; FilesystemID _filesystemId; CryConfig &operator=(const CryConfig &rhs) = delete; }; } #endif src/cryfs/config/CryConfigConsole.cpp000066400000000000000000000047421300002025200201410ustar00rootroot00000000000000#include "CryConfigConsole.h" #include "CryCipher.h" using cpputils::unique_ref; using cpputils::Console; using boost::optional; using boost::none; using std::string; using std::vector; using std::shared_ptr; namespace cryfs { constexpr const char *CryConfigConsole::DEFAULT_CIPHER; constexpr uint32_t CryConfigConsole::DEFAULT_BLOCKSIZE_BYTES; CryConfigConsole::CryConfigConsole(shared_ptr console) : _console(std::move(console)), _useDefaultSettings(none) { } string CryConfigConsole::askCipher() { if (_checkUseDefaultSettings()) { return DEFAULT_CIPHER; } else { return _askCipher(); } } string CryConfigConsole::_askCipher() const { vector ciphers = CryCiphers::supportedCipherNames(); string cipherName = ""; bool askAgain = true; while(askAgain) { _console->print("\n"); int cipherIndex = _console->ask("Which block cipher do you want to use?", ciphers); cipherName = ciphers[cipherIndex]; askAgain = !_showWarningForCipherAndReturnIfOk(cipherName); }; return cipherName; } bool CryConfigConsole::_showWarningForCipherAndReturnIfOk(const string &cipherName) const { auto warning = CryCiphers::find(cipherName).warning(); if (warning == none) { return true; } return _console->askYesNo(string() + (*warning) + " Do you want to take this cipher nevertheless?", true); } uint32_t CryConfigConsole::askBlocksizeBytes() { if (_checkUseDefaultSettings()) { return DEFAULT_BLOCKSIZE_BYTES; } else { return _askBlocksizeBytes(); } } uint32_t CryConfigConsole::_askBlocksizeBytes() const { vector sizes = {"8KB", "32KB", "64KB", "512KB", "1MB", "4MB"}; int index = _console->ask("Which block size do you want to use?", sizes); switch(index) { case 0: return 8*1024; case 1: return 32*1024; case 2: return 64*1024; case 3: return 512*1024; case 4: return 1024*1024; case 5: return 4*1024*1024; default: ASSERT(false, "Unhandled case"); } } bool CryConfigConsole::_checkUseDefaultSettings() { if (_useDefaultSettings == none) { _useDefaultSettings = _console->askYesNo("Use default settings?", true); } return *_useDefaultSettings; } } src/cryfs/config/CryConfigConsole.h000066400000000000000000000020241300002025200175750ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYCONFIGCONSOLE_H #define MESSMER_CRYFS_SRC_CONFIG_CRYCONFIGCONSOLE_H #include #include #include namespace cryfs { class CryConfigConsole final { public: CryConfigConsole(std::shared_ptr console); CryConfigConsole(CryConfigConsole &&rhs) = default; std::string askCipher(); uint32_t askBlocksizeBytes(); static constexpr const char *DEFAULT_CIPHER = "aes-256-gcm"; static constexpr uint32_t DEFAULT_BLOCKSIZE_BYTES = 32 * 1024; // 32KB private: bool _checkUseDefaultSettings(); std::string _askCipher() const; bool _showWarningForCipherAndReturnIfOk(const std::string &cipherName) const; uint32_t _askBlocksizeBytes() const; std::shared_ptr _console; boost::optional _useDefaultSettings; DISALLOW_COPY_AND_ASSIGN(CryConfigConsole); }; } #endif src/cryfs/config/CryConfigCreator.cpp000066400000000000000000000052341300002025200201330ustar00rootroot00000000000000#include "CryConfigCreator.h" #include "CryCipher.h" #include #include using cpputils::Console; using cpputils::unique_ref; using cpputils::RandomGenerator; using cpputils::Random; using std::string; using std::shared_ptr; using std::vector; using boost::optional; using boost::none; namespace cryfs { CryConfigCreator::CryConfigCreator(shared_ptr console, RandomGenerator &encryptionKeyGenerator) :_console(console), _configConsole(console), _encryptionKeyGenerator(encryptionKeyGenerator) { } CryConfig CryConfigCreator::create(const optional &cipherFromCommandLine, const optional &blocksizeBytesFromCommandLine) { CryConfig config; config.SetCipher(_generateCipher(cipherFromCommandLine)); config.SetVersion(gitversion::VersionString()); config.SetCreatedWithVersion(gitversion::VersionString()); config.SetBlocksizeBytes(_generateBlocksizeBytes(blocksizeBytesFromCommandLine)); config.SetRootBlob(_generateRootBlobKey()); config.SetEncryptionKey(_generateEncKey(config.Cipher())); config.SetFilesystemId(_generateFilesystemID()); return config; } uint32_t CryConfigCreator::_generateBlocksizeBytes(const optional &blocksizeBytesFromCommandLine) { if (blocksizeBytesFromCommandLine != none) { // TODO Check block size is valid (i.e. large enough) return *blocksizeBytesFromCommandLine; } else { return _configConsole.askBlocksizeBytes(); } } string CryConfigCreator::_generateCipher(const optional &cipherFromCommandLine) { if (cipherFromCommandLine != none) { ASSERT(std::find(CryCiphers::supportedCipherNames().begin(), CryCiphers::supportedCipherNames().end(), *cipherFromCommandLine) != CryCiphers::supportedCipherNames().end(), "Invalid cipher"); return *cipherFromCommandLine; } else { return _configConsole.askCipher(); } } string CryConfigCreator::_generateEncKey(const std::string &cipher) { _console->print("\nGenerating secure encryption key. This might take some time.."); auto key = CryCiphers::find(cipher).createKey(_encryptionKeyGenerator); _console->print("done\n"); return key; } string CryConfigCreator::_generateRootBlobKey() { //An empty root blob entry will tell CryDevice to create a new root blob return ""; } CryConfig::FilesystemID CryConfigCreator::_generateFilesystemID() { return Random::PseudoRandom().getFixedSize(); } } src/cryfs/config/CryConfigCreator.h000066400000000000000000000024171300002025200176000ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYCONFIGCREATOR_H #define MESSMER_CRYFS_SRC_CONFIG_CRYCONFIGCREATOR_H #include #include #include #include "CryConfig.h" #include "CryConfigConsole.h" namespace cryfs { class CryConfigCreator final { public: CryConfigCreator(std::shared_ptr console, cpputils::RandomGenerator &encryptionKeyGenerator); CryConfigCreator(CryConfigCreator &&rhs) = default; CryConfig create(const boost::optional &cipherFromCommandLine, const boost::optional &blocksizeBytesFromCommandLine); private: std::string _generateCipher(const boost::optional &cipherFromCommandLine); std::string _generateEncKey(const std::string &cipher); std::string _generateRootBlobKey(); uint32_t _generateBlocksizeBytes(const boost::optional &blocksizeBytesFromCommandLine); CryConfig::FilesystemID _generateFilesystemID(); std::shared_ptr _console; CryConfigConsole _configConsole; cpputils::RandomGenerator &_encryptionKeyGenerator; DISALLOW_COPY_AND_ASSIGN(CryConfigCreator); }; } #endif src/cryfs/config/CryConfigFile.cpp000066400000000000000000000050061300002025200174100ustar00rootroot00000000000000#include "CryConfigFile.h" #include #include #include #include using boost::optional; using boost::none; using std::ifstream; using std::ofstream; using std::string; using std::istringstream; using std::ostringstream; using std::stringstream; using std::istream; using cpputils::Data; using cpputils::unique_ref; using cpputils::SCryptSettings; namespace bf = boost::filesystem; using namespace cpputils::logging; namespace cryfs { CryConfigFile::~CryConfigFile() { //We do not call save() here, because we do not want the config file to be re-encrypted on each filesystem run } optional CryConfigFile::load(const bf::path &path, const string &password) { auto encryptedConfigData = Data::LoadFromFile(path); if (encryptedConfigData == none) { LOG(ERROR) << "Config file not found"; return none; } auto encryptor = CryConfigEncryptorFactory::loadKey(*encryptedConfigData, password); if (encryptor == none) { return none; } auto decrypted = (*encryptor)->decrypt(*encryptedConfigData); if (decrypted == none) { return none; } CryConfig config = CryConfig::load(decrypted->data); if (config.Cipher() != decrypted->cipherName) { LOG(ERROR) << "Inner cipher algorithm used to encrypt config file doesn't match config value"; return none; } auto configFile = CryConfigFile(path, std::move(config), std::move(*encryptor)); if (decrypted->wasInDeprecatedConfigFormat) { // Migrate it to new format configFile.save(); } //TODO For newer compilers, this works without std::move return std::move(configFile); } CryConfigFile CryConfigFile::create(const bf::path &path, const CryConfig &config, const string &password, const SCryptSettings &scryptSettings) { if (bf::exists(path)) { throw std::runtime_error("Config file exists already."); } auto result = CryConfigFile(path, config, CryConfigEncryptorFactory::deriveKey(password, scryptSettings)); result.save(); return result; } CryConfigFile::CryConfigFile(const bf::path &path, const CryConfig &config, unique_ref encryptor) : _path (path), _config(config), _encryptor(std::move(encryptor)) { } void CryConfigFile::save() const { Data configData = _config.save(); auto encrypted = _encryptor->encrypt(configData, _config.Cipher()); encrypted.StoreToFile(_path); } CryConfig *CryConfigFile::config() { return &_config; } } src/cryfs/config/CryConfigFile.h000066400000000000000000000021541300002025200170560ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYCONFIGFILE_H #define MESSMER_CRYFS_SRC_CONFIG_CRYCONFIGFILE_H #include #include #include "CryConfig.h" #include #include "crypto/CryConfigEncryptorFactory.h" namespace cryfs { class CryConfigFile final { public: CryConfigFile(CryConfigFile &&rhs) = default; ~CryConfigFile(); static CryConfigFile create(const boost::filesystem::path &path, const CryConfig &config, const std::string &password, const cpputils::SCryptSettings &scryptSettings); static boost::optional load(const boost::filesystem::path &path, const std::string &password); void save() const; CryConfig *config(); private: CryConfigFile(const boost::filesystem::path &path, const CryConfig &config, cpputils::unique_ref encryptor); boost::filesystem::path _path; CryConfig _config; cpputils::unique_ref _encryptor; DISALLOW_COPY_AND_ASSIGN(CryConfigFile); }; } #endif src/cryfs/config/CryConfigLoader.cpp000066400000000000000000000106421300002025200177410ustar00rootroot00000000000000#include "CryConfigLoader.h" #include "CryConfigFile.h" #include #include #include #include #include #include namespace bf = boost::filesystem; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::Console; using cpputils::Random; using cpputils::RandomGenerator; using cpputils::SCryptSettings; using boost::optional; using boost::none; using std::shared_ptr; using std::vector; using std::string; using std::function; using std::shared_ptr; using gitversion::VersionCompare; using namespace cpputils::logging; namespace cryfs { CryConfigLoader::CryConfigLoader(shared_ptr console, RandomGenerator &keyGenerator, const SCryptSettings &scryptSettings, function askPasswordForExistingFilesystem, function askPasswordForNewFilesystem, const optional &cipherFromCommandLine, const boost::optional &blocksizeBytesFromCommandLine) : _console(console), _creator(console, keyGenerator), _scryptSettings(scryptSettings), _askPasswordForExistingFilesystem(askPasswordForExistingFilesystem), _askPasswordForNewFilesystem(askPasswordForNewFilesystem), _cipherFromCommandLine(cipherFromCommandLine), _blocksizeBytesFromCommandLine(blocksizeBytesFromCommandLine) { } optional CryConfigLoader::_loadConfig(const bf::path &filename) { string password = _askPasswordForExistingFilesystem(); std::cout << "Loading config file (this can take some time)..." << std::flush; auto config = CryConfigFile::load(filename, password); if (config == none) { return none; } std::cout << "done" << std::endl; _checkVersion(*config->config()); #ifndef CRYFS_NO_COMPATIBILITY //Since 0.9.3-alpha set the config value cryfs.blocksizeBytes wrongly to 32768 (but didn't use the value), we have to fix this here. if (config->config()->Version() != "0+unknown" && VersionCompare::isOlderThan(config->config()->Version(), "0.9.3-rc1")) { config->config()->SetBlocksizeBytes(32832); } #endif if (config->config()->Version() != gitversion::VersionString()) { config->config()->SetVersion(gitversion::VersionString()); config->save(); } _checkCipher(*config->config()); return std::move(*config); } void CryConfigLoader::_checkVersion(const CryConfig &config) { if (gitversion::VersionCompare::isOlderThan(gitversion::VersionString(), config.Version())) { if (!_console->askYesNo("This filesystem is for CryFS " + config.Version() + " and should not be opened with older versions. It is strongly recommended to update your CryFS version. However, if you have backed up your base directory and know what you're doing, you can continue trying to load it. Do you want to continue?", false)) { throw std::runtime_error("This filesystem is for CryFS " + config.Version() + ". Please update your CryFS version."); } } if (gitversion::VersionCompare::isOlderThan(config.Version(), gitversion::VersionString())) { if (!_console->askYesNo("This filesystem is for CryFS " + config.Version() + ". It can be migrated to CryFS " + gitversion::VersionString() + ", but afterwards couldn't be opened anymore with older versions. Do you want to migrate it?", false)) { throw std::runtime_error("This filesystem is for CryFS " + config.Version() + ". It has to be migrated."); } } } void CryConfigLoader::_checkCipher(const CryConfig &config) const { if (_cipherFromCommandLine != none && config.Cipher() != *_cipherFromCommandLine) { throw std::runtime_error(string() + "Filesystem uses " + config.Cipher() + " cipher and not " + *_cipherFromCommandLine + " as specified."); } } optional CryConfigLoader::loadOrCreate(const bf::path &filename) { if (bf::exists(filename)) { return _loadConfig(filename); } else { return _createConfig(filename); } } CryConfigFile CryConfigLoader::_createConfig(const bf::path &filename) { auto config = _creator.create(_cipherFromCommandLine, _blocksizeBytesFromCommandLine); //TODO Ask confirmation if using insecure password (<8 characters) string password = _askPasswordForNewFilesystem(); std::cout << "Creating config file (this can take some time)..." << std::flush; auto result = CryConfigFile::create(filename, std::move(config), password, _scryptSettings); std::cout << "done" << std::endl; return result; } } src/cryfs/config/CryConfigLoader.h000066400000000000000000000031271300002025200174060ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYCONFIGLOADER_H_ #define MESSMER_CRYFS_SRC_CONFIG_CRYCONFIGLOADER_H_ #include #include #include "CryConfigFile.h" #include "CryCipher.h" #include "CryConfigCreator.h" #include namespace cryfs { class CryConfigLoader final { public: CryConfigLoader(std::shared_ptr console, cpputils::RandomGenerator &keyGenerator, const cpputils::SCryptSettings &scryptSettings, std::function askPasswordForExistingFilesystem, std::function askPasswordForNewFilesystem, const boost::optional &cipherFromCommandLine, const boost::optional &blocksizeBytesFromCommandLine); CryConfigLoader(CryConfigLoader &&rhs) = default; boost::optional loadOrCreate(const boost::filesystem::path &filename); private: boost::optional _loadConfig(const boost::filesystem::path &filename); CryConfigFile _createConfig(const boost::filesystem::path &filename); void _checkVersion(const CryConfig &config); void _checkCipher(const CryConfig &config) const; std::shared_ptr _console; CryConfigCreator _creator; cpputils::SCryptSettings _scryptSettings; std::function _askPasswordForExistingFilesystem; std::function _askPasswordForNewFilesystem; boost::optional _cipherFromCommandLine; boost::optional _blocksizeBytesFromCommandLine; DISALLOW_COPY_AND_ASSIGN(CryConfigLoader); }; } #endif src/cryfs/config/crypto/000077500000000000000000000000001300002025200155405ustar00rootroot00000000000000src/cryfs/config/crypto/CryConfigEncryptor.cpp000066400000000000000000000044231300002025200220400ustar00rootroot00000000000000#include "CryConfigEncryptor.h" #include using std::string; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::Data; using cpputils::RandomPadding; using cpputils::FixedSizeData; using boost::optional; using boost::none; using namespace cpputils::logging; namespace cryfs { constexpr size_t CryConfigEncryptor::OuterKeySize; constexpr size_t CryConfigEncryptor::MaxTotalKeySize; CryConfigEncryptor::CryConfigEncryptor(FixedSizeData derivedKey, cpputils::Data kdfParameters) : _derivedKey(std::move(derivedKey)), _kdfParameters(std::move(kdfParameters)) { } Data CryConfigEncryptor::encrypt(const Data &plaintext, const string &cipherName) const { InnerConfig innerConfig = _innerEncryptor(cipherName)->encrypt(plaintext); Data serializedInnerConfig = innerConfig.serialize(); OuterConfig outerConfig = _outerEncryptor()->encrypt(serializedInnerConfig); return outerConfig.serialize(); } optional CryConfigEncryptor::decrypt(const Data &data) const { auto outerConfig = OuterConfig::deserialize(data); if (outerConfig == none) { return none; } auto serializedInnerConfig = _outerEncryptor()->decrypt(*outerConfig); if(serializedInnerConfig == none) { return none; } auto innerConfig = InnerConfig::deserialize(*serializedInnerConfig); if (innerConfig == none) { return none; } auto plaintext = _innerEncryptor(innerConfig->cipherName)->decrypt(*innerConfig); if (plaintext == none) { return none; } return Decrypted{std::move(*plaintext), innerConfig->cipherName, outerConfig->wasInDeprecatedConfigFormat}; } unique_ref CryConfigEncryptor::_outerEncryptor() const { auto outerKey = _derivedKey.take(); return make_unique_ref(outerKey, _kdfParameters.copy()); } unique_ref CryConfigEncryptor::_innerEncryptor(const string &cipherName) const { auto innerKey = _derivedKey.drop(); return CryCiphers::find(cipherName).createInnerConfigEncryptor(innerKey); } } src/cryfs/config/crypto/CryConfigEncryptor.h000066400000000000000000000030411300002025200215000ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYPTO_CRYCONFIGENCRYPTOR_H #define MESSMER_CRYFS_SRC_CONFIG_CRYPTO_CRYCONFIGENCRYPTOR_H #include #include #include #include #include "inner/InnerEncryptor.h" #include "outer/OuterEncryptor.h" #include "../CryCipher.h" namespace cryfs { //TODO Use own exception for cpputils::Serializer/cpputils::Deserializer errors and only catch them class CryConfigEncryptor final { public: static constexpr size_t OuterKeySize = OuterEncryptor::Cipher::EncryptionKey::BINARY_LENGTH; static constexpr size_t MaxTotalKeySize = OuterKeySize + CryCiphers::MAX_KEY_SIZE; struct Decrypted { cpputils::Data data; std::string cipherName; bool wasInDeprecatedConfigFormat; }; CryConfigEncryptor(cpputils::FixedSizeData derivedKey, cpputils::Data _kdfParameters); cpputils::Data encrypt(const cpputils::Data &plaintext, const std::string &cipherName) const; boost::optional decrypt(const cpputils::Data &data) const; private: cpputils::unique_ref _outerEncryptor() const; cpputils::unique_ref _innerEncryptor(const std::string &cipherName) const; cpputils::FixedSizeData _derivedKey; cpputils::Data _kdfParameters; DISALLOW_COPY_AND_ASSIGN(CryConfigEncryptor); }; } #endif src/cryfs/config/crypto/CryConfigEncryptorFactory.cpp000066400000000000000000000036161300002025200233730ustar00rootroot00000000000000#include "CryConfigEncryptorFactory.h" #include #include "outer/OuterConfig.h" using namespace cpputils::logging; using boost::optional; using boost::none; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::Data; using cpputils::FixedSizeData; using cpputils::SCryptParameters; using cpputils::SCrypt; using cpputils::SCryptSettings; using std::string; namespace cryfs { optional> CryConfigEncryptorFactory::loadKey(const Data &data, const string &password) { auto outerConfig = OuterConfig::deserialize(data); if (outerConfig == none) { return none; } return _deriveKey(SCrypt::forExistingKey(outerConfig->kdfParameters), password); } unique_ref CryConfigEncryptorFactory::deriveKey(const string &password, const SCryptSettings &scryptSettings) { return _deriveKey(SCrypt::forNewKey(scryptSettings), password); } unique_ref CryConfigEncryptorFactory::_deriveKey(cpputils::unique_ref kdf, const string &password) { //TODO It would be better, not to generate a MaxTotalKeySize key here, but to generate the outer key first, and then // (once we know which inner cipher was used) only generate as many key bytes as we need for the inner cipher. // This would need a change in the scrypt interface though, because right now we can't continue past key computations. //TODO I might be able to know the actual key size here (at runtime) and switch the SCrypt deriveKey() interface to getting a dynamic size. auto key = kdf->deriveKey(password); return make_unique_ref(std::move(key), kdf->kdfParameters().copy()); } } src/cryfs/config/crypto/CryConfigEncryptorFactory.h000066400000000000000000000016701300002025200230360ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYPTO_CRYCONFIGENCRYPTORFACTORY_H #define MESSMER_CRYFS_SRC_CONFIG_CRYPTO_CRYCONFIGENCRYPTORFACTORY_H #include "inner/ConcreteInnerEncryptor.h" #include "CryConfigEncryptor.h" #include #include #include "../CryCipher.h" namespace cryfs { class CryConfigEncryptorFactory final { public: static cpputils::unique_ref deriveKey(const std::string &password, const cpputils::SCryptSettings &scryptSettings); static boost::optional> loadKey(const cpputils::Data &ciphertext, const std::string &password); private: static cpputils::unique_ref _deriveKey(cpputils::unique_ref kdf, const std::string &password); }; } #endif src/cryfs/config/crypto/inner/000077500000000000000000000000001300002025200166535ustar00rootroot00000000000000src/cryfs/config/crypto/inner/ConcreteInnerEncryptor.cpp000066400000000000000000000000441300002025200240210ustar00rootroot00000000000000#include "ConcreteInnerEncryptor.h" src/cryfs/config/crypto/inner/ConcreteInnerEncryptor.h000066400000000000000000000044311300002025200234720ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYPTO_INNER_CONCRETECRYCONFIGENCRYPTOR_H #define MESSMER_CRYFS_SRC_CONFIG_CRYPTO_INNER_CONCRETECRYCONFIGENCRYPTOR_H #include #include "InnerEncryptor.h" #include "InnerConfig.h" namespace cryfs { template class ConcreteInnerEncryptor final: public InnerEncryptor { public: static constexpr size_t CONFIG_SIZE = 512; // Inner config data is grown to this size before encryption to hide its actual size ConcreteInnerEncryptor(typename Cipher::EncryptionKey key); InnerConfig encrypt(const cpputils::Data &config) const override; boost::optional decrypt(const InnerConfig &innerConfig) const override; private: typename Cipher::EncryptionKey _key; DISALLOW_COPY_AND_ASSIGN(ConcreteInnerEncryptor); }; template ConcreteInnerEncryptor::ConcreteInnerEncryptor(typename Cipher::EncryptionKey key) : _key(std::move(key)) { } template boost::optional ConcreteInnerEncryptor::decrypt(const InnerConfig &innerConfig) const { if (innerConfig.cipherName != Cipher::NAME) { cpputils::logging::LOG(cpputils::logging::ERROR) << "Initialized ConcreteInnerEncryptor with wrong cipher"; return boost::none; } auto decrypted = Cipher::decrypt(static_cast(innerConfig.encryptedConfig.data()), innerConfig.encryptedConfig.size(), _key); if (decrypted == boost::none) { cpputils::logging::LOG(cpputils::logging::ERROR) << "Failed decrypting configuration file"; return boost::none; } auto configData = cpputils::RandomPadding::remove(*decrypted); if (configData == boost::none) { return boost::none; } return std::move(*configData); } template InnerConfig ConcreteInnerEncryptor::encrypt(const cpputils::Data &config) const { auto padded = cpputils::RandomPadding::add(config, CONFIG_SIZE); auto encrypted = Cipher::encrypt(static_cast(padded.data()), padded.size(), _key); return InnerConfig{Cipher::NAME, std::move(encrypted)}; } } #endif src/cryfs/config/crypto/inner/InnerConfig.cpp000066400000000000000000000040231300002025200215570ustar00rootroot00000000000000#include "InnerConfig.h" #include using std::string; using std::exception; using cpputils::Deserializer; using cpputils::Serializer; using cpputils::Data; using boost::optional; using boost::none; using namespace cpputils::logging; namespace cryfs { const string InnerConfig::HEADER = "cryfs.config.inner;0"; Data InnerConfig::serialize() const { try { Serializer serializer(Serializer::StringSize(HEADER) + Serializer::StringSize(cipherName) + encryptedConfig.size()); serializer.writeString(HEADER); serializer.writeString(cipherName); serializer.writeTailData(encryptedConfig); return serializer.finished(); } catch (const exception &e) { LOG(ERROR) << "Error serializing inner configuration: " << e.what(); throw; // This is a programming logic error, pass through exception. } } optional InnerConfig::deserialize(const Data &data) { Deserializer deserializer(&data); try { _checkHeader(&deserializer); string cipherName = deserializer.readString(); auto result = deserializer.readTailData(); deserializer.finished(); return InnerConfig {cipherName, std::move(result)}; } catch (const exception &e) { LOG(ERROR) << "Error deserializing inner configuration: " << e.what(); return none; // This can be caused by invalid input data and does not have to be a programming error. Don't throw exception. } } void InnerConfig::_checkHeader(Deserializer *deserializer) { string header = deserializer->readString(); if (header != HEADER) { throw std::runtime_error("Invalid header. Maybe this filesystem was created with a different version of CryFS?"); } } void InnerConfig::_writeHeader(Serializer *serializer) { serializer->writeString(HEADER); } } src/cryfs/config/crypto/inner/InnerConfig.h000066400000000000000000000013061300002025200212250ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYPTO_INNER_INNERCONFIG_H #define MESSMER_CRYFS_SRC_CONFIG_CRYPTO_INNER_INNERCONFIG_H #include #include #include namespace cryfs { struct InnerConfig final { std::string cipherName; cpputils::Data encryptedConfig; cpputils::Data serialize() const; static boost::optional deserialize(const cpputils::Data &data); private: static void _checkHeader(cpputils::Deserializer *deserializer); static void _writeHeader(cpputils::Serializer *serializer); static const std::string HEADER; }; } #endif src/cryfs/config/crypto/inner/InnerEncryptor.cpp000066400000000000000000000000341300002025200223350ustar00rootroot00000000000000#include "InnerEncryptor.h" src/cryfs/config/crypto/inner/InnerEncryptor.h000066400000000000000000000012011300002025200217770ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYPTO_INNER_INNERENCRYPTOR_H #define MESSMER_CRYFS_SRC_CONFIG_CRYPTO_INNER_INNERENCRYPTOR_H #include #include #include #include #include #include "InnerConfig.h" namespace cryfs { class InnerEncryptor { public: virtual ~InnerEncryptor() {} virtual InnerConfig encrypt(const cpputils::Data &plaintext) const = 0; virtual boost::optional decrypt(const InnerConfig &innerConfig) const = 0; }; } #endif src/cryfs/config/crypto/outer/000077500000000000000000000000001300002025200166765ustar00rootroot00000000000000src/cryfs/config/crypto/outer/OuterConfig.cpp000066400000000000000000000061411300002025200216300ustar00rootroot00000000000000#include "OuterConfig.h" #include using std::string; using std::exception; using cpputils::Data; using cpputils::Serializer; using cpputils::Deserializer; using cpputils::SCryptParameters; using boost::optional; using boost::none; using namespace cpputils::logging; namespace cryfs { #ifndef CRYFS_NO_COMPATIBILITY const string OuterConfig::OLD_HEADER = "cryfs.config;0;scrypt"; #endif const string OuterConfig::HEADER = "cryfs.config;1;scrypt"; void OuterConfig::_checkHeader(Deserializer *deserializer) { string header = deserializer->readString(); if (header != HEADER) { throw std::runtime_error("Invalid header"); } } void OuterConfig::_writeHeader(Serializer *serializer) { serializer->writeString(HEADER); } Data OuterConfig::serialize() const { try { Serializer serializer(Serializer::StringSize(HEADER) + Serializer::DataSize(kdfParameters) + encryptedInnerConfig.size()); _writeHeader(&serializer); serializer.writeData(kdfParameters); serializer.writeTailData(encryptedInnerConfig); return serializer.finished(); } catch (const exception &e) { LOG(ERROR) << "Error serializing CryConfigEncryptor: " << e.what(); throw; // This is a programming logic error. Pass through exception. } } optional OuterConfig::deserialize(const Data &data) { Deserializer deserializer(&data); try { #ifndef CRYFS_NO_COMPATIBILITY string header = deserializer.readString(); if (header == OLD_HEADER) { return _deserializeOldFormat(&deserializer); } else if (header == HEADER) { return _deserializeNewFormat(&deserializer); } else { throw std::runtime_error("Invalid header"); } #else _checkHeader(&deserializer); _deserializeNewFormat(&deserializer); #endif } catch (const exception &e) { LOG(ERROR) << "Error deserializing outer configuration: " << e.what(); return none; // This can be caused by invalid input data and does not have to be a programming error. Don't throw exception. } } OuterConfig OuterConfig::_deserializeOldFormat(Deserializer *deserializer) { auto kdfParameters = SCryptParameters::deserializeOldFormat(deserializer); auto kdfParametersSerialized = kdfParameters.serialize(); auto encryptedInnerConfig = deserializer->readTailData(); deserializer->finished(); return OuterConfig {std::move(kdfParametersSerialized), std::move(encryptedInnerConfig), true}; } OuterConfig OuterConfig::_deserializeNewFormat(Deserializer *deserializer) { auto kdfParameters = deserializer->readData(); auto encryptedInnerConfig = deserializer->readTailData(); deserializer->finished(); return OuterConfig {std::move(kdfParameters), std::move(encryptedInnerConfig), false}; } } src/cryfs/config/crypto/outer/OuterConfig.h000066400000000000000000000017761300002025200213060ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYPTO_OUTER_OUTERCONFIG_H #define MESSMER_CRYFS_SRC_CONFIG_CRYPTO_OUTER_OUTERCONFIG_H #include #include #include namespace cryfs { struct OuterConfig final { cpputils::Data kdfParameters; cpputils::Data encryptedInnerConfig; bool wasInDeprecatedConfigFormat; cpputils::Data serialize() const; static boost::optional deserialize(const cpputils::Data &data); private: static void _checkHeader(cpputils::Deserializer *deserializer); static void _writeHeader(cpputils::Serializer *serializer); static OuterConfig _deserializeNewFormat(cpputils::Deserializer *deserializer); static const std::string HEADER; #ifndef CRYFS_NO_COMPATIBILITY static const std::string OLD_HEADER; static OuterConfig _deserializeOldFormat(cpputils::Deserializer *deserializer); #endif }; } #endif src/cryfs/config/crypto/outer/OuterEncryptor.cpp000066400000000000000000000023751300002025200224150ustar00rootroot00000000000000#include "OuterEncryptor.h" #include #include "OuterConfig.h" using std::string; using cpputils::unique_ref; using cpputils::Data; using cpputils::RandomPadding; using boost::optional; using boost::none; using namespace cpputils::logging; namespace cryfs { OuterEncryptor::OuterEncryptor(Cipher::EncryptionKey key, cpputils::Data kdfParameters) : _key(std::move(key)), _kdfParameters(std::move(kdfParameters)) { } OuterConfig OuterEncryptor::encrypt(const Data &plaintext) const { auto padded = RandomPadding::add(plaintext, CONFIG_SIZE); auto ciphertext = Cipher::encrypt(static_cast(padded.data()), padded.size(), _key); return OuterConfig{_kdfParameters.copy(), std::move(ciphertext), false}; } optional OuterEncryptor::decrypt(const OuterConfig &outerConfig) const { ASSERT(outerConfig.kdfParameters == _kdfParameters, "OuterEncryptor was initialized with wrong key config"); auto inner = Cipher::decrypt(static_cast(outerConfig.encryptedInnerConfig.data()), outerConfig.encryptedInnerConfig.size(), _key); if(inner == none) { return none; } return RandomPadding::remove(*inner); } } src/cryfs/config/crypto/outer/OuterEncryptor.h000066400000000000000000000017271300002025200220620ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_SRC_CONFIG_CRYPTO_OUTER_OUTERENCRYPTOR_H #define MESSMER_CRYFS_SRC_CONFIG_CRYPTO_OUTER_OUTERENCRYPTOR_H #include #include #include #include #include "OuterConfig.h" namespace cryfs { class OuterEncryptor final { public: using Cipher = cpputils::AES256_GCM; static constexpr size_t CONFIG_SIZE = 1024; // Config data is grown to this size before encryption to hide its actual size OuterEncryptor(Cipher::EncryptionKey key, cpputils::Data kdfParameters); OuterConfig encrypt(const cpputils::Data &encryptedInnerConfig) const; boost::optional decrypt(const OuterConfig &outerConfig) const; private: Cipher::EncryptionKey _key; cpputils::Data _kdfParameters; DISALLOW_COPY_AND_ASSIGN(OuterEncryptor); }; } #endif src/cryfs/cryfs.cpp000066400000000000000000000006121300002025200146040ustar00rootroot00000000000000#include "cryfs.h" class cryfs_load_handle { public: cryfs_load_handle(const char *value_): value(value_) {} const char *value; }; cryfs_load_handle *cryfs_load_init() { return new cryfs_load_handle("Hello Library World!"); } void cryfs_load_free(cryfs_load_handle *handle) { delete handle; } const char *cryfs_test(cryfs_load_handle *handle) { return handle->value; } src/cryfs/cryfs.h000066400000000000000000000004741300002025200142570ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_CRYFS_H #define MESSMER_CRYFS_CRYFS_H #ifdef __cplusplus extern "C" { #endif struct cryfs_load_handle; cryfs_load_handle *cryfs_load_init(); void cryfs_load_free(cryfs_load_handle *handle); const char *cryfs_test(cryfs_load_handle *handle); #ifdef __cplusplus } #endif #endif src/cryfs/filesystem/000077500000000000000000000000001300002025200151375ustar00rootroot00000000000000src/cryfs/filesystem/CryDevice.cpp000066400000000000000000000206431300002025200175250ustar00rootroot00000000000000#include #include #include "parallelaccessfsblobstore/DirBlobRef.h" #include "CryDevice.h" #include "CryDir.h" #include "CryFile.h" #include "CrySymlink.h" #include #include #include #include #include "parallelaccessfsblobstore/ParallelAccessFsBlobStore.h" #include "cachingfsblobstore/CachingFsBlobStore.h" #include "../config/CryCipher.h" using std::string; //TODO Get rid of this in favor of exception hierarchy using fspp::fuse::CHECK_RETVAL; using fspp::fuse::FuseErrnoException; using blockstore::BlockStore; using blockstore::Key; using blockstore::encrypted::EncryptedBlockStore; using blobstore::onblocks::BlobStoreOnBlocks; using blobstore::onblocks::BlobOnBlocks; using blockstore::caching::CachingBlockStore; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::dynamic_pointer_move; using boost::optional; using boost::none; using cryfs::fsblobstore::FsBlobStore; using cryfs::cachingfsblobstore::CachingFsBlobStore; using cryfs::parallelaccessfsblobstore::ParallelAccessFsBlobStore; using cryfs::parallelaccessfsblobstore::FileBlobRef; using cryfs::parallelaccessfsblobstore::DirBlobRef; using cryfs::parallelaccessfsblobstore::SymlinkBlobRef; using cryfs::parallelaccessfsblobstore::FsBlobRef; using namespace cpputils::logging; namespace bf = boost::filesystem; namespace cryfs { CryDevice::CryDevice(CryConfigFile configFile, unique_ref blockStore) : _fsBlobStore( make_unique_ref( make_unique_ref( make_unique_ref( make_unique_ref( make_unique_ref( CreateEncryptedBlockStore(*configFile.config(), std::move(blockStore)) ), configFile.config()->BlocksizeBytes()))) ) ), _rootKey(GetOrCreateRootKey(&configFile)), _onFsAction() { } Key CryDevice::CreateRootBlobAndReturnKey() { auto rootBlob = _fsBlobStore->createDirBlob(); rootBlob->flush(); // Don't cache, but directly write the root blob (this causes it to fail early if the base directory is not accessible) return rootBlob->key(); } optional> CryDevice::Load(const bf::path &path) { // TODO Split into smaller functions ASSERT(path.is_absolute(), "Non absolute path given"); callFsActionCallbacks(); if (path.parent_path().empty()) { //We are asked to load the base directory '/'. return optional>(make_unique_ref(this, none, none, _rootKey)); } auto parentWithGrandparent = LoadDirBlobWithParent(path.parent_path()); auto parent = std::move(parentWithGrandparent.blob); auto grandparent = std::move(parentWithGrandparent.parent); auto optEntry = parent->GetChild(path.filename().native()); if (optEntry == boost::none) { return boost::none; } const auto &entry = *optEntry; switch(entry.type()) { case fspp::Dir::EntryType::DIR: return optional>(make_unique_ref(this, std::move(parent), std::move(grandparent), entry.key())); case fspp::Dir::EntryType::FILE: return optional>(make_unique_ref(this, std::move(parent), std::move(grandparent), entry.key())); case fspp::Dir::EntryType::SYMLINK: return optional>(make_unique_ref(this, std::move(parent), std::move(grandparent), entry.key())); } ASSERT(false, "Switch/case not exhaustive"); } CryDevice::DirBlobWithParent CryDevice::LoadDirBlobWithParent(const bf::path &path) { auto blob = LoadBlobWithParent(path); auto dir = dynamic_pointer_move(blob.blob); if (dir == none) { throw FuseErrnoException(ENOTDIR); // Loaded blob is not a directory } return DirBlobWithParent{std::move(*dir), std::move(blob.parent)}; } CryDevice::BlobWithParent CryDevice::LoadBlobWithParent(const bf::path &path) { optional> parentBlob = none; optional> currentBlobOpt = _fsBlobStore->load(_rootKey); if (currentBlobOpt == none) { LOG(ERROR) << "Could not load root blob. Is the base directory accessible?"; throw FuseErrnoException(EIO); } unique_ref currentBlob = std::move(*currentBlobOpt); for (const bf::path &component : path.relative_path()) { auto currentDir = dynamic_pointer_move(currentBlob); if (currentDir == none) { throw FuseErrnoException(ENOTDIR); // Path component is not a dir } auto childOpt = (*currentDir)->GetChild(component.c_str()); if (childOpt == boost::none) { throw FuseErrnoException(ENOENT); // Child entry in directory not found } Key childKey = childOpt->key(); auto nextBlob = _fsBlobStore->load(childKey); if (nextBlob == none) { throw FuseErrnoException(ENOENT); // Blob for directory entry not found } parentBlob = std::move(*currentDir); currentBlob = std::move(*nextBlob); } return BlobWithParent{std::move(currentBlob), std::move(parentBlob)}; //TODO (I think this is resolved, but I should test it) // Running the python script, waiting for "Create files in sequential order...", then going into dir ~/tmp/cryfs-mount-.../Bonnie.../ and calling "ls" // crashes cryfs with a sigsegv. // Possible reason: Many parallel changes to a directory blob are a race condition. Need something like ParallelAccessStore! } void CryDevice::statfs(const bf::path &path, struct statvfs *fsstat) { // TODO Do we need path for something? What does it represent from fuse side? UNUSED(path); callFsActionCallbacks(); uint64_t numUsedBlocks = _fsBlobStore->numBlocks(); uint64_t numFreeBlocks = _fsBlobStore->estimateSpaceForNumBlocksLeft(); fsstat->f_bsize = _fsBlobStore->virtualBlocksizeBytes(); fsstat->f_blocks = numUsedBlocks + numFreeBlocks; fsstat->f_bfree = numFreeBlocks; fsstat->f_bavail = numFreeBlocks; fsstat->f_files = numUsedBlocks + numFreeBlocks; fsstat->f_ffree = numFreeBlocks; fsstat->f_namemax = 255; // We theoretically support unlimited file name length, but this is default for many Linux file systems, so probably also makes sense for CryFS. //f_frsize, f_favail, f_fsid and f_flag are ignored in fuse, see http://fuse.sourcearchive.com/documentation/2.7.0/structfuse__operations_4e765e29122e7b6b533dc99849a52655.html#4e765e29122e7b6b533dc99849a52655 } unique_ref CryDevice::CreateFileBlob() { return _fsBlobStore->createFileBlob(); } unique_ref CryDevice::CreateDirBlob() { return _fsBlobStore->createDirBlob(); } unique_ref CryDevice::CreateSymlinkBlob(const bf::path &target) { return _fsBlobStore->createSymlinkBlob(target); } unique_ref CryDevice::LoadBlob(const blockstore::Key &key) { auto blob = _fsBlobStore->load(key); if (blob == none) { LOG(ERROR) << "Could not load blob " << key.ToString() << ". Is the base directory accessible?"; throw FuseErrnoException(EIO); } return std::move(*blob); } void CryDevice::RemoveBlob(const blockstore::Key &key) { auto blob = _fsBlobStore->load(key); if (blob == none) { LOG(ERROR) << "Could not load blob " << key.ToString() << ". Is the base directory accessible?"; throw FuseErrnoException(EIO); } _fsBlobStore->remove(std::move(*blob)); } Key CryDevice::GetOrCreateRootKey(CryConfigFile *configFile) { string root_key = configFile->config()->RootBlob(); if (root_key == "") { auto new_key = CreateRootBlobAndReturnKey(); configFile->config()->SetRootBlob(new_key.ToString()); configFile->save(); return new_key; } return Key::FromString(root_key); } cpputils::unique_ref CryDevice::CreateEncryptedBlockStore(const CryConfig &config, unique_ref baseBlockStore) { //TODO Test that CryFS is using the specified cipher return CryCiphers::find(config.Cipher()).createEncryptedBlockstore(std::move(baseBlockStore), config.EncryptionKey()); } void CryDevice::onFsAction(std::function callback) { _onFsAction.push_back(callback); } void CryDevice::callFsActionCallbacks() const { for (const auto &callback : _onFsAction) { callback(); } } uint64_t CryDevice::numBlocks() const { return _fsBlobStore->numBlocks(); } } src/cryfs/filesystem/CryDevice.h000066400000000000000000000046201300002025200171670ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_CRYDEVICE_H_ #define MESSMER_CRYFS_FILESYSTEM_CRYDEVICE_H_ #include #include "../config/CryConfigFile.h" #include #include #include "parallelaccessfsblobstore/ParallelAccessFsBlobStore.h" #include "parallelaccessfsblobstore/DirBlobRef.h" #include "parallelaccessfsblobstore/FileBlobRef.h" #include "parallelaccessfsblobstore/SymlinkBlobRef.h" namespace cryfs { class CryDevice final: public fspp::Device { public: CryDevice(CryConfigFile config, cpputils::unique_ref blockStore); void statfs(const boost::filesystem::path &path, struct ::statvfs *fsstat) override; cpputils::unique_ref CreateFileBlob(); cpputils::unique_ref CreateDirBlob(); cpputils::unique_ref CreateSymlinkBlob(const boost::filesystem::path &target); cpputils::unique_ref LoadBlob(const blockstore::Key &key); struct DirBlobWithParent { cpputils::unique_ref blob; boost::optional> parent; }; DirBlobWithParent LoadDirBlobWithParent(const boost::filesystem::path &path); void RemoveBlob(const blockstore::Key &key); void onFsAction(std::function callback); boost::optional> Load(const boost::filesystem::path &path) override; void callFsActionCallbacks() const; uint64_t numBlocks() const; private: cpputils::unique_ref _fsBlobStore; blockstore::Key _rootKey; std::vector> _onFsAction; blockstore::Key GetOrCreateRootKey(CryConfigFile *config); blockstore::Key CreateRootBlobAndReturnKey(); static cpputils::unique_ref CreateEncryptedBlockStore(const CryConfig &config, cpputils::unique_ref baseBlockStore); struct BlobWithParent { cpputils::unique_ref blob; boost::optional> parent; }; BlobWithParent LoadBlobWithParent(const boost::filesystem::path &path); DISALLOW_COPY_AND_ASSIGN(CryDevice); }; } #endif src/cryfs/filesystem/CryDir.cpp000066400000000000000000000101351300002025200170370ustar00rootroot00000000000000#include "CryDir.h" #include #include #include #include #include #include "CryDevice.h" #include "CryFile.h" #include "CryOpenFile.h" #include //TODO Get rid of this in favor of exception hierarchy using fspp::fuse::CHECK_RETVAL; using fspp::fuse::FuseErrnoException; namespace bf = boost::filesystem; using std::string; using std::vector; using blockstore::Key; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::dynamic_pointer_move; using boost::optional; using boost::none; using cryfs::parallelaccessfsblobstore::DirBlobRef; namespace cryfs { CryDir::CryDir(CryDevice *device, optional> parent, optional> grandparent, const Key &key) : CryNode(device, std::move(parent), std::move(grandparent), key) { } CryDir::~CryDir() { } unique_ref CryDir::createAndOpenFile(const string &name, mode_t mode, uid_t uid, gid_t gid) { device()->callFsActionCallbacks(); if (!isRootDir()) { //TODO Instead of doing nothing when we're the root directory, handle timestamps in the root dir correctly (and delete isRootDir() function) parent()->updateModificationTimestampForChild(key()); } auto child = device()->CreateFileBlob(); auto now = cpputils::time::now(); auto dirBlob = LoadBlob(); dirBlob->AddChildFile(name, child->key(), mode, uid, gid, now, now); return make_unique_ref(device(), cpputils::to_unique_ptr(std::move(dirBlob)), std::move(child)); } void CryDir::createDir(const string &name, mode_t mode, uid_t uid, gid_t gid) { device()->callFsActionCallbacks(); if (!isRootDir()) { //TODO Instead of doing nothing when we're the root directory, handle timestamps in the root dir correctly (and delete isRootDir() function) parent()->updateModificationTimestampForChild(key()); } auto blob = LoadBlob(); auto child = device()->CreateDirBlob(); auto now = cpputils::time::now(); blob->AddChildDir(name, child->key(), mode, uid, gid, now, now); } unique_ref CryDir::LoadBlob() const { auto blob = CryNode::LoadBlob(); auto dir_blob = dynamic_pointer_move(blob); ASSERT(dir_blob != none, "Blob does not store a directory"); return std::move(*dir_blob); } unique_ref> CryDir::children() { device()->callFsActionCallbacks(); if (!isRootDir()) { //TODO Instead of doing nothing when we're the root directory, handle timestamps in the root dir correctly (and delete isRootDir() function) parent()->updateAccessTimestampForChild(key()); } auto children = make_unique_ref>(); children->push_back(fspp::Dir::Entry(fspp::Dir::EntryType::DIR, ".")); children->push_back(fspp::Dir::Entry(fspp::Dir::EntryType::DIR, "..")); auto blob = LoadBlob(); blob->AppendChildrenTo(children.get()); return children; } fspp::Dir::EntryType CryDir::getType() const { device()->callFsActionCallbacks(); return fspp::Dir::EntryType::DIR; } void CryDir::createSymlink(const string &name, const bf::path &target, uid_t uid, gid_t gid) { device()->callFsActionCallbacks(); if (!isRootDir()) { //TODO Instead of doing nothing when we're the root directory, handle timestamps in the root dir correctly (and delete isRootDir() function) parent()->updateModificationTimestampForChild(key()); } auto blob = LoadBlob(); auto child = device()->CreateSymlinkBlob(target); auto now = cpputils::time::now(); blob->AddChildSymlink(name, child->key(), uid, gid, now, now); } void CryDir::remove() { device()->callFsActionCallbacks(); if (grandparent() != none) { //TODO Instead of doing nothing when we're in the root directory, handle timestamps in the root dir correctly (*grandparent())->updateModificationTimestampForChild(parent()->key()); } { auto blob = LoadBlob(); if (0 != blob->NumChildren()) { throw FuseErrnoException(ENOTEMPTY); } } //TODO removeNode() calls CryDevice::RemoveBlob, which loads the blob again. So we're loading it twice. Should be optimized. removeNode(); } } src/cryfs/filesystem/CryDir.h000066400000000000000000000024221300002025200165040ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_CRYDIR_H_ #define MESSMER_CRYFS_FILESYSTEM_CRYDIR_H_ #include #include "CryNode.h" #include "parallelaccessfsblobstore/DirBlobRef.h" namespace cryfs { class CryDir final: public fspp::Dir, CryNode { public: CryDir(CryDevice *device, boost::optional> parent, boost::optional> grandparent, const blockstore::Key &key); ~CryDir(); //TODO return type variance to CryFile/CryDir? cpputils::unique_ref createAndOpenFile(const std::string &name, mode_t mode, uid_t uid, gid_t gid) override; void createDir(const std::string &name, mode_t mode, uid_t uid, gid_t gid) override; void createSymlink(const std::string &name, const boost::filesystem::path &target, uid_t uid, gid_t gid) override; //TODO Make Entry a public class instead of hidden in DirBlob (which is not publicly visible) cpputils::unique_ref> children() override; fspp::Dir::EntryType getType() const override; void remove() override; private: cpputils::unique_ref LoadBlob() const; DISALLOW_COPY_AND_ASSIGN(CryDir); }; } #endif src/cryfs/filesystem/CryFile.cpp000066400000000000000000000036011300002025200172000ustar00rootroot00000000000000#include "CryFile.h" #include "CryDevice.h" #include "CryOpenFile.h" #include namespace bf = boost::filesystem; //TODO Get rid of this in favor of exception hierarchy using fspp::fuse::CHECK_RETVAL; using fspp::fuse::FuseErrnoException; using blockstore::Key; using boost::none; using boost::optional; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::dynamic_pointer_move; using cryfs::parallelaccessfsblobstore::DirBlobRef; using cryfs::parallelaccessfsblobstore::FileBlobRef; namespace cryfs { CryFile::CryFile(CryDevice *device, unique_ref parent, optional> grandparent, const Key &key) : CryNode(device, std::move(parent), std::move(grandparent), key) { } CryFile::~CryFile() { } unique_ref CryFile::LoadBlob() const { auto blob = CryNode::LoadBlob(); auto file_blob = dynamic_pointer_move(blob); ASSERT(file_blob != none, "Blob does not store a file"); return std::move(*file_blob); } unique_ref CryFile::open(int flags) { // TODO Should we honor open flags? UNUSED(flags); device()->callFsActionCallbacks(); auto blob = LoadBlob(); return make_unique_ref(device(), parent(), std::move(blob)); } void CryFile::truncate(off_t size) { device()->callFsActionCallbacks(); auto blob = LoadBlob(); blob->resize(size); parent()->updateModificationTimestampForChild(key()); } fspp::Dir::EntryType CryFile::getType() const { device()->callFsActionCallbacks(); return fspp::Dir::EntryType::FILE; } void CryFile::remove() { device()->callFsActionCallbacks(); if (grandparent() != none) { //TODO Instead of doing nothing when we're in the root directory, handle timestamps in the root dir correctly (*grandparent())->updateModificationTimestampForChild(parent()->key()); } removeNode(); } } src/cryfs/filesystem/CryFile.h000066400000000000000000000015721300002025200166520ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_CRYFILE_H_ #define MESSMER_CRYFS_FILESYSTEM_CRYFILE_H_ #include "parallelaccessfsblobstore/FileBlobRef.h" #include "parallelaccessfsblobstore/DirBlobRef.h" #include #include "CryNode.h" namespace cryfs { class CryFile final: public fspp::File, CryNode { public: CryFile(CryDevice *device, cpputils::unique_ref parent, boost::optional> grandparent, const blockstore::Key &key); ~CryFile(); cpputils::unique_ref open(int flags) override; void truncate(off_t size) override; fspp::Dir::EntryType getType() const override; void remove() override; private: cpputils::unique_ref LoadBlob() const; DISALLOW_COPY_AND_ASSIGN(CryFile); }; } #endif src/cryfs/filesystem/CryNode.cpp000066400000000000000000000141461300002025200172140ustar00rootroot00000000000000#include "CryNode.h" #include #include "CryDevice.h" #include "CryDir.h" #include "CryFile.h" #include #include #include #include namespace bf = boost::filesystem; using blockstore::Key; using blobstore::Blob; using cpputils::dynamic_pointer_move; using cpputils::unique_ref; using boost::optional; using boost::none; using std::shared_ptr; using cryfs::parallelaccessfsblobstore::FsBlobRef; using cryfs::parallelaccessfsblobstore::DirBlobRef; //TODO Get rid of this in favor of an exception hierarchy using fspp::fuse::CHECK_RETVAL; using fspp::fuse::FuseErrnoException; namespace cryfs { CryNode::CryNode(CryDevice *device, optional> parent, optional> grandparent, const Key &key) : _device(device), _parent(none), _grandparent(none), _key(key) { ASSERT(parent != none || grandparent == none, "Grandparent can only be set when parent is not none"); if (parent != none) { _parent = cpputils::to_unique_ptr(std::move(*parent)); } _grandparent = std::move(grandparent); } CryNode::~CryNode() { } void CryNode::access(int mask) const { // TODO Should we implement access()? UNUSED(mask); device()->callFsActionCallbacks(); return; } bool CryNode::isRootDir() const { return _parent == none; } shared_ptr CryNode::parent() const { ASSERT(_parent != none, "We are the root directory and can't get the parent of the root directory"); return *_parent; } shared_ptr CryNode::parent() { ASSERT(_parent != none, "We are the root directory and can't get the parent of the root directory"); return *_parent; } optional CryNode::grandparent() { if (_grandparent == none) { return none; } return _grandparent->get(); } void CryNode::rename(const bf::path &to) { device()->callFsActionCallbacks(); if (_parent == none) { //We are the root direcory. throw FuseErrnoException(EBUSY); } auto targetDirWithParent = _device->LoadDirBlobWithParent(to.parent_path()); auto targetDir = std::move(targetDirWithParent.blob); auto targetDirParent = std::move(targetDirWithParent.parent); auto old = (*_parent)->GetChild(_key); if (old == boost::none) { throw FuseErrnoException(EIO); } fsblobstore::DirEntry oldEntry = *old; // Copying this (instead of only keeping the reference) is necessary, because the operations below (i.e. RenameChild()) might make a reference invalid. auto onOverwritten = [this] (const blockstore::Key &key) { device()->RemoveBlob(key); }; _updateParentModificationTimestamp(); if (targetDir->key() == (*_parent)->key()) { targetDir->RenameChild(oldEntry.key(), to.filename().native(), onOverwritten); } else { _updateTargetDirModificationTimestamp(*targetDir, std::move(targetDirParent)); targetDir->AddOrOverwriteChild(to.filename().native(), oldEntry.key(), oldEntry.type(), oldEntry.mode(), oldEntry.uid(), oldEntry.gid(), oldEntry.lastAccessTime(), oldEntry.lastModificationTime(), onOverwritten); (*_parent)->RemoveChild(oldEntry.name()); // targetDir is now the new parent for this node. Adapt to it, so we can call further operations on this node object. _parent = cpputils::to_unique_ptr(std::move(targetDir)); } } void CryNode::_updateParentModificationTimestamp() { if (_grandparent != none) { // TODO Handle timestamps of the root directory (_grandparent == none) correctly. ASSERT(_parent != none, "Grandparent is set, so also parent has to be set"); (*_grandparent)->updateModificationTimestampForChild((*_parent)->key()); } } void CryNode::_updateTargetDirModificationTimestamp(const DirBlobRef &targetDir, optional> targetDirParent) { if (targetDirParent != none) { // TODO Handle timestamps of the root directory (targetDirParent == none) correctly. (*targetDirParent)->updateModificationTimestampForChild(targetDir.key()); } } void CryNode::utimens(timespec lastAccessTime, timespec lastModificationTime) { device()->callFsActionCallbacks(); if (_parent == none) { //We are the root direcory. //TODO What should we do? throw FuseErrnoException(EIO); } (*_parent)->utimensChild(_key, lastAccessTime, lastModificationTime); } void CryNode::removeNode() { //TODO Instead of all these if-else and having _parent being an optional, we could also introduce a CryRootDir which inherits from fspp::Dir. if (_parent == none) { //We are the root direcory. //TODO What should we do? throw FuseErrnoException(EIO); } (*_parent)->RemoveChild(_key); _device->RemoveBlob(_key); } CryDevice *CryNode::device() { return _device; } const CryDevice *CryNode::device() const { return _device; } unique_ref CryNode::LoadBlob() const { return _device->LoadBlob(_key); } const blockstore::Key &CryNode::key() const { return _key; } void CryNode::stat(struct ::stat *result) const { device()->callFsActionCallbacks(); if(_parent == none) { //We are the root directory. //TODO What should we do? result->st_uid = getuid(); result->st_gid = getgid(); result->st_mode = S_IFDIR | S_IRUSR | S_IWUSR | S_IXUSR; result->st_size = fsblobstore::DirBlob::DIR_LSTAT_SIZE; //TODO If possible without performance loss, then for a directory, st_nlink should return number of dir entries (including "." and "..") result->st_nlink = 1; struct timespec now; clock_gettime(CLOCK_REALTIME, &now); result->st_atim = now; result->st_mtim = now; result->st_ctim = now; } else { (*_parent)->statChild(_key, result); } } void CryNode::chmod(mode_t mode) { device()->callFsActionCallbacks(); if (_parent == none) { //We are the root direcory. //TODO What should we do? throw FuseErrnoException(EIO); } (*_parent)->chmodChild(_key, mode); } void CryNode::chown(uid_t uid, gid_t gid) { device()->callFsActionCallbacks(); if (_parent == none) { //We are the root direcory. //TODO What should we do? throw FuseErrnoException(EIO); } (*_parent)->chownChild(_key, uid, gid); } } src/cryfs/filesystem/CryNode.h000066400000000000000000000042011300002025200166500ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_CRYNODE_H_ #define MESSMER_CRYFS_FILESYSTEM_CRYNODE_H_ #include #include #include #include "parallelaccessfsblobstore/DirBlobRef.h" #include "CryDevice.h" namespace cryfs { class CryNode: public virtual fspp::Node { public: virtual ~CryNode(); // TODO grandparent is only needed to set the timestamps of the parent directory on rename and remove. Delete grandparent parameter once we store timestamps in the blob itself instead of in the directory listing. CryNode(CryDevice *device, boost::optional> parent, boost::optional> grandparent, const blockstore::Key &key); void access(int mask) const override; void stat(struct ::stat *result) const override; void chmod(mode_t mode) override; void chown(uid_t uid, gid_t gid) override; void rename(const boost::filesystem::path &to) override; void utimens(timespec lastAccessTime, timespec lastModificationTime) override; protected: CryNode(); CryDevice *device(); const CryDevice *device() const; const blockstore::Key &key() const; cpputils::unique_ref LoadBlob() const; bool isRootDir() const; std::shared_ptr parent() const; std::shared_ptr parent(); boost::optional grandparent(); virtual fspp::Dir::EntryType getType() const = 0; void removeNode(); private: void _updateParentModificationTimestamp(); void _updateTargetDirModificationTimestamp(const parallelaccessfsblobstore::DirBlobRef &targetDir, boost::optional> targetDirParent); CryDevice *_device; boost::optional> _parent; boost::optional> _grandparent; blockstore::Key _key; DISALLOW_COPY_AND_ASSIGN(CryNode); }; } #endif src/cryfs/filesystem/CryOpenFile.cpp000066400000000000000000000034321300002025200200240ustar00rootroot00000000000000#include "CryOpenFile.h" #include #include #include "CryDevice.h" #include namespace bf = boost::filesystem; using std::shared_ptr; using cpputils::unique_ref; using cryfs::parallelaccessfsblobstore::FileBlobRef; using cryfs::parallelaccessfsblobstore::DirBlobRef; //TODO Get rid of this in favor of a exception hierarchy using fspp::fuse::CHECK_RETVAL; using fspp::fuse::FuseErrnoException; namespace cryfs { CryOpenFile::CryOpenFile(const CryDevice *device, shared_ptr parent, unique_ref fileBlob) : _device(device), _parent(parent), _fileBlob(std::move(fileBlob)) { } CryOpenFile::~CryOpenFile() { //TODO } void CryOpenFile::flush() { _device->callFsActionCallbacks(); _fileBlob->flush(); _parent->flush(); } void CryOpenFile::stat(struct ::stat *result) const { _device->callFsActionCallbacks(); _parent->statChildExceptSize(_fileBlob->key(), result); result->st_size = _fileBlob->size(); } void CryOpenFile::truncate(off_t size) const { _device->callFsActionCallbacks(); _fileBlob->resize(size); _parent->updateModificationTimestampForChild(_fileBlob->key()); } size_t CryOpenFile::read(void *buf, size_t count, off_t offset) const { _device->callFsActionCallbacks(); _parent->updateAccessTimestampForChild(_fileBlob->key()); return _fileBlob->read(buf, offset, count); } void CryOpenFile::write(const void *buf, size_t count, off_t offset) { _device->callFsActionCallbacks(); _parent->updateModificationTimestampForChild(_fileBlob->key()); _fileBlob->write(buf, offset, count); } void CryOpenFile::fsync() { _device->callFsActionCallbacks(); _fileBlob->flush(); _parent->flush(); } void CryOpenFile::fdatasync() { _device->callFsActionCallbacks(); _fileBlob->flush(); } } src/cryfs/filesystem/CryOpenFile.h000066400000000000000000000021041300002025200174640ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_CRYOPENFILE_H_ #define MESSMER_CRYFS_FILESYSTEM_CRYOPENFILE_H_ #include #include "parallelaccessfsblobstore/FileBlobRef.h" #include "parallelaccessfsblobstore/DirBlobRef.h" namespace cryfs { class CryDevice; class CryOpenFile final: public fspp::OpenFile { public: explicit CryOpenFile(const CryDevice *device, std::shared_ptr parent, cpputils::unique_ref fileBlob); ~CryOpenFile(); void stat(struct ::stat *result) const override; void truncate(off_t size) const override; size_t read(void *buf, size_t count, off_t offset) const override; void write(const void *buf, size_t count, off_t offset) override; void flush() override; void fsync() override; void fdatasync() override; private: const CryDevice *_device; std::shared_ptr _parent; cpputils::unique_ref _fileBlob; DISALLOW_COPY_AND_ASSIGN(CryOpenFile); }; } #endif src/cryfs/filesystem/CrySymlink.cpp000066400000000000000000000033571300002025200177570ustar00rootroot00000000000000#include "CrySymlink.h" #include #include "CryDevice.h" #include "CrySymlink.h" #include "parallelaccessfsblobstore/SymlinkBlobRef.h" //TODO Get rid of this in favor of exception hierarchy using fspp::fuse::CHECK_RETVAL; using fspp::fuse::FuseErrnoException; namespace bf = boost::filesystem; using std::string; using std::vector; using blockstore::Key; using boost::none; using boost::optional; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::dynamic_pointer_move; using cryfs::parallelaccessfsblobstore::SymlinkBlobRef; using cryfs::parallelaccessfsblobstore::DirBlobRef; namespace cryfs { CrySymlink::CrySymlink(CryDevice *device, unique_ref parent, optional> grandparent, const Key &key) : CryNode(device, std::move(parent), std::move(grandparent), key) { } CrySymlink::~CrySymlink() { } unique_ref CrySymlink::LoadBlob() const { auto blob = CryNode::LoadBlob(); auto symlink_blob = dynamic_pointer_move(blob); ASSERT(symlink_blob != none, "Blob does not store a symlink"); return std::move(*symlink_blob); } fspp::Dir::EntryType CrySymlink::getType() const { device()->callFsActionCallbacks(); return fspp::Dir::EntryType::SYMLINK; } bf::path CrySymlink::target() { device()->callFsActionCallbacks(); parent()->updateAccessTimestampForChild(key()); auto blob = LoadBlob(); return blob->target(); } void CrySymlink::remove() { device()->callFsActionCallbacks(); if (grandparent() != none) { //TODO Instead of doing nothing when we're in the root directory, handle timestamps in the root dir correctly (*grandparent())->updateModificationTimestampForChild(parent()->key()); } removeNode(); } } src/cryfs/filesystem/CrySymlink.h000066400000000000000000000015401300002025200174140ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_CRYSYMLINK_H_ #define MESSMER_CRYFS_FILESYSTEM_CRYSYMLINK_H_ #include #include "CryNode.h" #include "parallelaccessfsblobstore/SymlinkBlobRef.h" #include "parallelaccessfsblobstore/DirBlobRef.h" namespace cryfs { class CrySymlink final: public fspp::Symlink, CryNode { public: CrySymlink(CryDevice *device, cpputils::unique_ref parent, boost::optional> grandparent, const blockstore::Key &key); ~CrySymlink(); boost::filesystem::path target() override; fspp::Dir::EntryType getType() const override; void remove() override; private: cpputils::unique_ref LoadBlob() const; DISALLOW_COPY_AND_ASSIGN(CrySymlink); }; } #endif src/cryfs/filesystem/cachingfsblobstore/000077500000000000000000000000001300002025200210005ustar00rootroot00000000000000src/cryfs/filesystem/cachingfsblobstore/CachingFsBlobStore.cpp000066400000000000000000000031761300002025200251540ustar00rootroot00000000000000#include "CachingFsBlobStore.h" #include "../fsblobstore/FsBlobStore.h" namespace bf = boost::filesystem; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::dynamic_pointer_move; using blobstore::BlobStore; using blockstore::Key; using boost::optional; using boost::none; using std::function; using cryfs::fsblobstore::FsBlobStore; using cryfs::fsblobstore::FsBlob; using cryfs::fsblobstore::FileBlob; using cryfs::fsblobstore::DirBlob; using cryfs::fsblobstore::SymlinkBlob; namespace cryfs { namespace cachingfsblobstore { optional> CachingFsBlobStore::load(const Key &key) { auto fromCache = _cache.pop(key); if (fromCache != none) { return _makeRef(std::move(*fromCache)); } auto fromBaseStore = _baseBlobStore->load(key); if (fromBaseStore != none) { return _makeRef(std::move(*fromBaseStore)); } return none; } unique_ref CachingFsBlobStore::_makeRef(unique_ref baseBlob) { auto fileBlob = dynamic_pointer_move(baseBlob); if (fileBlob != none) { return make_unique_ref(std::move(*fileBlob), this); } auto dirBlob = dynamic_pointer_move(baseBlob); if (dirBlob != none) { return make_unique_ref(std::move(*dirBlob), this); } auto symlinkBlob = dynamic_pointer_move(baseBlob); if (symlinkBlob != none) { return make_unique_ref(std::move(*symlinkBlob), this); } ASSERT(false, "Unknown blob type"); } } } src/cryfs/filesystem/cachingfsblobstore/CachingFsBlobStore.h000066400000000000000000000105521300002025200246150ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_CACHINGFSBLOBSTORE_CACHINGFSBLOBSTORE_H #define MESSMER_CRYFS_FILESYSTEM_CACHINGFSBLOBSTORE_CACHINGFSBLOBSTORE_H #include #include "../fsblobstore/FsBlobStore.h" #include #include "FileBlobRef.h" #include "DirBlobRef.h" #include "SymlinkBlobRef.h" namespace cryfs { namespace cachingfsblobstore { //TODO Test classes in cachingfsblobstore //TODO Inherit from same interface as FsBlobStore? class CachingFsBlobStore final { public: CachingFsBlobStore(cpputils::unique_ref baseBlobStore); ~CachingFsBlobStore(); cpputils::unique_ref createFileBlob(); cpputils::unique_ref createDirBlob(); cpputils::unique_ref createSymlinkBlob(const boost::filesystem::path &target); boost::optional> load(const blockstore::Key &key); void remove(cpputils::unique_ref blob); uint64_t virtualBlocksizeBytes() const; uint64_t numBlocks() const; uint64_t estimateSpaceForNumBlocksLeft() const; void releaseForCache(cpputils::unique_ref baseBlob); private: cpputils::unique_ref _makeRef(cpputils::unique_ref baseBlob); cpputils::unique_ref _baseBlobStore; //TODO Move Cache to some common location, not in blockstore //TODO Use other cache config (i.e. smaller max number of entries) here than in blockstore blockstore::caching::Cache, 50> _cache; DISALLOW_COPY_AND_ASSIGN(CachingFsBlobStore); }; inline CachingFsBlobStore::CachingFsBlobStore(cpputils::unique_ref baseBlobStore) : _baseBlobStore(std::move(baseBlobStore)), _cache() { } inline CachingFsBlobStore::~CachingFsBlobStore() { } inline cpputils::unique_ref CachingFsBlobStore::createFileBlob() { // This already creates the file blob in the underlying blobstore. // We could also cache this operation, but that is more complicated (blockstore::CachingBlockStore does it) // and probably not worth it here. return cpputils::make_unique_ref(_baseBlobStore->createFileBlob(), this); } inline cpputils::unique_ref CachingFsBlobStore::createDirBlob() { // This already creates the file blob in the underlying blobstore. // We could also cache this operation, but that is more complicated (blockstore::CachingBlockStore does it) // and probably not worth it here. return cpputils::make_unique_ref(_baseBlobStore->createDirBlob(), this); } inline cpputils::unique_ref CachingFsBlobStore::createSymlinkBlob(const boost::filesystem::path &target) { // This already creates the file blob in the underlying blobstore. // We could also cache this operation, but that is more complicated (blockstore::CachingBlockStore does it) // and probably not worth it here. return cpputils::make_unique_ref(_baseBlobStore->createSymlinkBlob(target), this); } inline void CachingFsBlobStore::remove(cpputils::unique_ref blob) { auto baseBlob = blob->releaseBaseBlob(); return _baseBlobStore->remove(std::move(baseBlob)); } inline void CachingFsBlobStore::releaseForCache(cpputils::unique_ref baseBlob) { blockstore::Key key = baseBlob->key(); _cache.push(key, std::move(baseBlob)); } inline uint64_t CachingFsBlobStore::virtualBlocksizeBytes() const { return _baseBlobStore->virtualBlocksizeBytes(); } inline uint64_t CachingFsBlobStore::numBlocks() const { return _baseBlobStore->numBlocks(); } inline uint64_t CachingFsBlobStore::estimateSpaceForNumBlocksLeft() const { return _baseBlobStore->estimateSpaceForNumBlocksLeft(); } } } #endif src/cryfs/filesystem/cachingfsblobstore/DirBlobRef.cpp000066400000000000000000000000301300002025200234470ustar00rootroot00000000000000#include "DirBlobRef.h" src/cryfs/filesystem/cachingfsblobstore/DirBlobRef.h000066400000000000000000000103051300002025200231220ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_CACHINGFSBLOBSTORE_DIRBLOBREF_H #define MESSMER_CRYFS_FILESYSTEM_CACHINGFSBLOBSTORE_DIRBLOBREF_H #include "FsBlobRef.h" #include "../fsblobstore/DirBlob.h" namespace cryfs { namespace cachingfsblobstore { class DirBlobRef final: public FsBlobRef { public: DirBlobRef(cpputils::unique_ref base, CachingFsBlobStore *fsBlobStore): FsBlobRef(std::move(base), fsBlobStore), _base(dynamic_cast(baseBlob())) { ASSERT(_base != nullptr, "We just initialized this with a pointer to DirBlob. Can't be something else now."); } using Entry = fsblobstore::DirEntry; boost::optional GetChild(const std::string &name) const { return _base->GetChild(name); } boost::optional GetChild(const blockstore::Key &key) const { return _base->GetChild(key); } size_t NumChildren() const { return _base->NumChildren(); } void RemoveChild(const blockstore::Key &key) { return _base->RemoveChild(key); } void RemoveChild(const std::string &name) { return _base->RemoveChild(name); } void flush() { return _base->flush(); } void AddOrOverwriteChild(const std::string &name, const blockstore::Key &blobKey, fspp::Dir::EntryType type, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime, std::function onOverwritten) { return _base->AddOrOverwriteChild(name, blobKey, type, mode, uid, gid, lastAccessTime, lastModificationTime, onOverwritten); } void RenameChild(const blockstore::Key &key, const std::string &newName, std::function onOverwritten) { return _base->RenameChild(key, newName, onOverwritten); } void statChild(const blockstore::Key &key, struct ::stat *result) const { return _base->statChild(key, result); } void statChildExceptSize(const blockstore::Key &key, struct ::stat *result) const { return _base->statChildExceptSize(key, result); } void updateAccessTimestampForChild(const blockstore::Key &key) { return _base->updateAccessTimestampForChild(key); } void updateModificationTimestampForChild(const blockstore::Key &key) { return _base->updateModificationTimestampForChild(key); } void chmodChild(const blockstore::Key &key, mode_t mode) { return _base->chmodChild(key, mode); } void chownChild(const blockstore::Key &key, uid_t uid, gid_t gid) { return _base->chownChild(key, uid, gid); } void utimensChild(const blockstore::Key &key, timespec lastAccessTime, timespec lastModificationTime) { return _base->utimensChild(key, lastAccessTime, lastModificationTime); } void AddChildDir(const std::string &name, const blockstore::Key &blobKey, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { return _base->AddChildDir(name, blobKey, mode, uid, gid, lastAccessTime, lastModificationTime); } void AddChildFile(const std::string &name, const blockstore::Key &blobKey, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { return _base->AddChildFile(name, blobKey, mode, uid, gid, lastAccessTime, lastModificationTime); } void AddChildSymlink(const std::string &name, const blockstore::Key &blobKey, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { return _base->AddChildSymlink(name, blobKey, uid, gid, lastAccessTime, lastModificationTime); } void AppendChildrenTo(std::vector *result) const { return _base->AppendChildrenTo(result); } const blockstore::Key &key() const { return _base->key(); } off_t lstat_size() const { return _base->lstat_size(); } void setLstatSizeGetter(std::function getLstatSize) { return _base->setLstatSizeGetter(getLstatSize); } private: fsblobstore::DirBlob *_base; DISALLOW_COPY_AND_ASSIGN(DirBlobRef); }; } } #endif src/cryfs/filesystem/cachingfsblobstore/FileBlobRef.cpp000066400000000000000000000000311300002025200236110ustar00rootroot00000000000000#include "FileBlobRef.h" src/cryfs/filesystem/cachingfsblobstore/FileBlobRef.h000066400000000000000000000025241300002025200232670ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_CACHINGFSBLOBSTORE_FILEBLOBREF_H #define MESSMER_CRYFS_FILESYSTEM_CACHINGFSBLOBSTORE_FILEBLOBREF_H #include "FsBlobRef.h" #include "../fsblobstore/FileBlob.h" namespace cryfs { namespace cachingfsblobstore { class FileBlobRef final: public FsBlobRef { public: FileBlobRef(cpputils::unique_ref base, CachingFsBlobStore *fsBlobStore) :FsBlobRef(std::move(base), fsBlobStore), _base(dynamic_cast(baseBlob())) { ASSERT(_base != nullptr, "We just initialized this with a pointer to FileBlob. Can't be something else now."); } void resize(off_t size) { return _base->resize(size); } off_t size() const { return _base->size(); } ssize_t read(void *target, uint64_t offset, uint64_t count) const { return _base->read(target, offset, count); } void write(const void *source, uint64_t offset, uint64_t count) { return _base->write(source, offset, count); } void flush() { return _base->flush(); } const blockstore::Key &key() const { return _base->key(); } off_t lstat_size() const { return _base->lstat_size(); } private: fsblobstore::FileBlob *_base; DISALLOW_COPY_AND_ASSIGN(FileBlobRef); }; } } #endif src/cryfs/filesystem/cachingfsblobstore/FsBlobRef.cpp000066400000000000000000000003631300002025200233120ustar00rootroot00000000000000#include "FsBlobRef.h" #include "CachingFsBlobStore.h" namespace cryfs { namespace cachingfsblobstore { FsBlobRef::~FsBlobRef() { if (_baseBlob.get() != nullptr) { _fsBlobStore->releaseForCache(std::move(_baseBlob)); } } } }src/cryfs/filesystem/cachingfsblobstore/FsBlobRef.h000066400000000000000000000020361300002025200227560ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_CACHINGFSBLOBSTORE_FSBLOBREF_H #define MESSMER_CRYFS_FILESYSTEM_CACHINGFSBLOBSTORE_FSBLOBREF_H #include "../fsblobstore/FsBlob.h" namespace cryfs { namespace cachingfsblobstore { class CachingFsBlobStore; //TODO Rename to CachedFsBlob, CachedFileBlob, CachedDirBlob to avoid confusion with parallelaccessfsblobstore class FsBlobRef { public: virtual ~FsBlobRef(); virtual const blockstore::Key &key() const = 0; virtual off_t lstat_size() const = 0; cpputils::unique_ref releaseBaseBlob() { return std::move(_baseBlob); } protected: FsBlobRef(cpputils::unique_ref baseBlob, cachingfsblobstore::CachingFsBlobStore *fsBlobStore): _fsBlobStore(fsBlobStore), _baseBlob(std::move(baseBlob)) {} fsblobstore::FsBlob *baseBlob() { return _baseBlob.get(); } private: CachingFsBlobStore *_fsBlobStore; cpputils::unique_ref _baseBlob; DISALLOW_COPY_AND_ASSIGN(FsBlobRef); }; } } #endif src/cryfs/filesystem/cachingfsblobstore/SymlinkBlobRef.cpp000066400000000000000000000000341300002025200243630ustar00rootroot00000000000000#include "SymlinkBlobRef.h" src/cryfs/filesystem/cachingfsblobstore/SymlinkBlobRef.h000066400000000000000000000020021300002025200240250ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_CACHINGFSBLOBSTORE_SYMLINKBLOBREF_H #define MESSMER_CRYFS_FILESYSTEM_CACHINGFSBLOBSTORE_SYMLINKBLOBREF_H #include "FsBlobRef.h" #include "../fsblobstore/SymlinkBlob.h" namespace cryfs { namespace cachingfsblobstore { class SymlinkBlobRef final: public FsBlobRef { public: SymlinkBlobRef(cpputils::unique_ref base, CachingFsBlobStore *fsBlobStore) :FsBlobRef(std::move(base), fsBlobStore), _base(dynamic_cast(baseBlob())) { ASSERT(_base != nullptr, "We just initialized this with a pointer to SymlinkBlob. Can't be something else now."); } const boost::filesystem::path &target() const { return _base->target(); } const blockstore::Key &key() const { return _base->key(); } off_t lstat_size() const { return _base->lstat_size(); } private: fsblobstore::SymlinkBlob *_base; DISALLOW_COPY_AND_ASSIGN(SymlinkBlobRef); }; } } #endif src/cryfs/filesystem/fsblobstore/000077500000000000000000000000001300002025200174635ustar00rootroot00000000000000src/cryfs/filesystem/fsblobstore/DirBlob.cpp000066400000000000000000000164571300002025200215210ustar00rootroot00000000000000#include "DirBlob.h" #include //TODO Remove and replace with exception hierarchy #include #include #include #include "../CryDevice.h" #include "FileBlob.h" #include "SymlinkBlob.h" #include using std::vector; using std::string; using std::pair; using std::make_pair; using blobstore::Blob; using blockstore::Key; using cpputils::Data; using cpputils::unique_ref; using cpputils::make_unique_ref; using boost::none; namespace cryfs { namespace fsblobstore { constexpr off_t DirBlob::DIR_LSTAT_SIZE; DirBlob::DirBlob(FsBlobStore *fsBlobStore, unique_ref blob, std::function getLstatSize) : FsBlob(std::move(blob)), _fsBlobStore(fsBlobStore), _getLstatSize(getLstatSize), _entries(), _mutex(), _changed(false) { ASSERT(baseBlob().blobType() == FsBlobView::BlobType::DIR, "Loaded blob is not a directory"); _readEntriesFromBlob(); } DirBlob::~DirBlob() { std::unique_lock lock(_mutex); _writeEntriesToBlob(); } void DirBlob::flush() { std::unique_lock lock(_mutex); _writeEntriesToBlob(); baseBlob().flush(); } unique_ref DirBlob::InitializeEmptyDir(FsBlobStore *fsBlobStore, unique_ref blob, std::function getLstatSize) { InitializeBlob(blob.get(), FsBlobView::BlobType::DIR); return make_unique_ref(fsBlobStore, std::move(blob), getLstatSize); } void DirBlob::_writeEntriesToBlob() { if (_changed) { Data serialized = _entries.serialize(); baseBlob().resize(serialized.size()); baseBlob().write(serialized.data(), 0, serialized.size()); _changed = false; } } void DirBlob::_readEntriesFromBlob() { //No lock needed, because this is only called from the constructor. Data data = baseBlob().readAll(); _entries.deserializeFrom(static_cast(data.data()), data.size()); } void DirBlob::AddChildDir(const std::string &name, const Key &blobKey, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { std::unique_lock lock(_mutex); _addChild(name, blobKey, fspp::Dir::EntryType::DIR, mode, uid, gid, lastAccessTime, lastModificationTime); } void DirBlob::AddChildFile(const std::string &name, const Key &blobKey, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { std::unique_lock lock(_mutex); _addChild(name, blobKey, fspp::Dir::EntryType::FILE, mode, uid, gid, lastAccessTime, lastModificationTime); } void DirBlob::AddChildSymlink(const std::string &name, const blockstore::Key &blobKey, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { std::unique_lock lock(_mutex); _addChild(name, blobKey, fspp::Dir::EntryType::SYMLINK, S_IFLNK | S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH | S_IWOTH | S_IXOTH, uid, gid, lastAccessTime, lastModificationTime); } void DirBlob::_addChild(const std::string &name, const Key &blobKey, fspp::Dir::EntryType entryType, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { _entries.add(name, blobKey, entryType, mode, uid, gid, lastAccessTime, lastModificationTime); _changed = true; } void DirBlob::AddOrOverwriteChild(const std::string &name, const Key &blobKey, fspp::Dir::EntryType entryType, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime, std::function onOverwritten) { std::unique_lock lock(_mutex); _entries.addOrOverwrite(name, blobKey, entryType, mode, uid, gid, lastAccessTime, lastModificationTime, onOverwritten); _changed = true; } void DirBlob::RenameChild(const blockstore::Key &key, const std::string &newName, std::function onOverwritten) { std::unique_lock lock(_mutex); _entries.rename(key, newName, onOverwritten); _changed = true; } boost::optional DirBlob::GetChild(const string &name) const { std::unique_lock lock(_mutex); return _entries.get(name); } boost::optional DirBlob::GetChild(const Key &key) const { std::unique_lock lock(_mutex); return _entries.get(key); } void DirBlob::RemoveChild(const string &name) { std::unique_lock lock(_mutex); _entries.remove(name); _changed = true; } void DirBlob::RemoveChild(const Key &key) { std::unique_lock lock(_mutex); _entries.remove(key); _changed = true; } void DirBlob::AppendChildrenTo(vector *result) const { std::unique_lock lock(_mutex); result->reserve(result->size() + _entries.size()); for (const auto &entry : _entries) { result->emplace_back(entry.type(), entry.name()); } } off_t DirBlob::lstat_size() const { return DIR_LSTAT_SIZE; } void DirBlob::statChild(const Key &key, struct ::stat *result) const { statChildExceptSize(key, result); result->st_size = _getLstatSize(key); } void DirBlob::statChildExceptSize(const Key &key, struct ::stat *result) const { auto childOpt = GetChild(key); if (childOpt == boost::none) { throw fspp::fuse::FuseErrnoException(ENOENT); } const auto &child = *childOpt; result->st_mode = child.mode(); result->st_uid = child.uid(); result->st_gid = child.gid(); //TODO If possible without performance loss, then for a directory, st_nlink should return number of dir entries (including "." and "..") result->st_nlink = 1; result->st_atim = child.lastAccessTime(); result->st_mtim = child.lastModificationTime(); result->st_ctim = child.lastMetadataChangeTime(); //TODO Move ceilDivision to general utils which can be used by cryfs as well result->st_blocks = blobstore::onblocks::utils::ceilDivision(result->st_size, (off_t)512); result->st_blksize = _fsBlobStore->virtualBlocksizeBytes(); } void DirBlob::updateAccessTimestampForChild(const Key &key) { std::unique_lock lock(_mutex); _entries.updateAccessTimestampForChild(key); _changed = true; } void DirBlob::updateModificationTimestampForChild(const Key &key) { std::unique_lock lock(_mutex); _entries.updateModificationTimestampForChild(key); _changed = true; } void DirBlob::chmodChild(const Key &key, mode_t mode) { std::unique_lock lock(_mutex); _entries.setMode(key, mode); _changed = true; } void DirBlob::chownChild(const Key &key, uid_t uid, gid_t gid) { std::unique_lock lock(_mutex); if(_entries.setUidGid(key, uid, gid)) { _changed = true; } } void DirBlob::utimensChild(const Key &key, timespec lastAccessTime, timespec lastModificationTime) { std::unique_lock lock(_mutex); _entries.setAccessTimes(key, lastAccessTime, lastModificationTime); _changed = true; } void DirBlob::setLstatSizeGetter(std::function getLstatSize) { std::unique_lock lock(_mutex); _getLstatSize = getLstatSize; } cpputils::unique_ref DirBlob::releaseBaseBlob() { std::unique_lock lock(_mutex); _writeEntriesToBlob(); return FsBlob::releaseBaseBlob(); } size_t DirBlob::NumChildren() const { return _entries.size(); } } } src/cryfs/filesystem/fsblobstore/DirBlob.h000066400000000000000000000075361300002025200211640ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_DIRBLOB_H_ #define MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_DIRBLOB_H_ #include #include #include #include "FsBlob.h" #include "utils/DirEntryList.h" #include namespace cryfs { namespace fsblobstore { class FsBlobStore; class DirBlob final : public FsBlob { public: constexpr static off_t DIR_LSTAT_SIZE = 4096; static cpputils::unique_ref InitializeEmptyDir(FsBlobStore *fsBlobStore, cpputils::unique_ref blob, std::function getLstatSize); DirBlob(FsBlobStore *fsBlobStore, cpputils::unique_ref blob, std::function getLstatSize); ~DirBlob(); off_t lstat_size() const override; void AppendChildrenTo(std::vector *result) const; //TODO Test NumChildren() size_t NumChildren() const; boost::optional GetChild(const std::string &name) const; boost::optional GetChild(const blockstore::Key &key) const; void AddChildDir(const std::string &name, const blockstore::Key &blobKey, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime); void AddChildFile(const std::string &name, const blockstore::Key &blobKey, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime); void AddChildSymlink(const std::string &name, const blockstore::Key &blobKey, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime); void AddOrOverwriteChild(const std::string &name, const blockstore::Key &blobKey, fspp::Dir::EntryType type, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime, std::function onOverwritten); void RenameChild(const blockstore::Key &key, const std::string &newName, std::function onOverwritten); void RemoveChild(const std::string &name); void RemoveChild(const blockstore::Key &key); void flush(); void statChild(const blockstore::Key &key, struct ::stat *result) const; void statChildExceptSize(const blockstore::Key &key, struct ::stat *result) const; void updateAccessTimestampForChild(const blockstore::Key &key); void updateModificationTimestampForChild(const blockstore::Key &key); void chmodChild(const blockstore::Key &key, mode_t mode); void chownChild(const blockstore::Key &key, uid_t uid, gid_t gid); void utimensChild(const blockstore::Key &key, timespec lastAccessTime, timespec lastModificationTime); void setLstatSizeGetter(std::function getLstatSize); private: void _addChild(const std::string &name, const blockstore::Key &blobKey, fspp::Dir::EntryType type, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime); void _readEntriesFromBlob(); void _writeEntriesToBlob(); cpputils::unique_ref releaseBaseBlob() override; FsBlobStore *_fsBlobStore; std::function _getLstatSize; DirEntryList _entries; mutable std::mutex _mutex; bool _changed; DISALLOW_COPY_AND_ASSIGN(DirBlob); }; } } #endif src/cryfs/filesystem/fsblobstore/FileBlob.cpp000066400000000000000000000020661300002025200216510ustar00rootroot00000000000000#include "FileBlob.h" #include #include using blobstore::Blob; using cpputils::unique_ref; using cpputils::make_unique_ref; using blockstore::Key; namespace cryfs { namespace fsblobstore { FileBlob::FileBlob(unique_ref blob) : FsBlob(std::move(blob)) { ASSERT(baseBlob().blobType() == FsBlobView::BlobType::FILE, "Loaded blob is not a file"); } unique_ref FileBlob::InitializeEmptyFile(unique_ref blob) { InitializeBlob(blob.get(), FsBlobView::BlobType::FILE); return make_unique_ref(std::move(blob)); } ssize_t FileBlob::read(void *target, uint64_t offset, uint64_t count) const { return baseBlob().tryRead(target, offset, count); } void FileBlob::write(const void *source, uint64_t offset, uint64_t count) { baseBlob().write(source, offset, count); } void FileBlob::flush() { baseBlob().flush(); } void FileBlob::resize(off_t size) { baseBlob().resize(size); } off_t FileBlob::lstat_size() const { return size(); } off_t FileBlob::size() const { return baseBlob().size(); } } } src/cryfs/filesystem/fsblobstore/FileBlob.h000066400000000000000000000015041300002025200213120ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_FILEBLOB_H_ #define MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_FILEBLOB_H_ #include "FsBlob.h" namespace cryfs { namespace fsblobstore { class FileBlob final: public FsBlob { public: static cpputils::unique_ref InitializeEmptyFile(cpputils::unique_ref blob); FileBlob(cpputils::unique_ref blob); ssize_t read(void *target, uint64_t offset, uint64_t count) const; void write(const void *source, uint64_t offset, uint64_t count); void flush(); void resize(off_t size); off_t lstat_size() const override; off_t size() const; private: DISALLOW_COPY_AND_ASSIGN(FileBlob); }; } } #endif src/cryfs/filesystem/fsblobstore/FsBlob.cpp000066400000000000000000000000241300002025200213320ustar00rootroot00000000000000#include "FsBlob.h" src/cryfs/filesystem/fsblobstore/FsBlob.h000066400000000000000000000035161300002025200210100ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_FSBLOB_H #define MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_FSBLOB_H #include #include #include "FsBlobView.h" namespace cryfs { namespace fsblobstore { class FsBlob { public: virtual ~FsBlob(); virtual off_t lstat_size() const = 0; const blockstore::Key &key() const; protected: FsBlob(cpputils::unique_ref baseBlob); FsBlobView &baseBlob(); const FsBlobView &baseBlob() const; static void InitializeBlob(blobstore::Blob *blob, FsBlobView::BlobType magicNumber); friend class FsBlobStore; virtual cpputils::unique_ref releaseBaseBlob(); private: FsBlobView _baseBlob; DISALLOW_COPY_AND_ASSIGN(FsBlob); }; // --------------------------- // Inline function definitions // --------------------------- inline FsBlob::FsBlob(cpputils::unique_ref baseBlob) : _baseBlob(std::move(baseBlob)) { } inline FsBlob::~FsBlob() { } inline const blockstore::Key &FsBlob::key() const { return _baseBlob.key(); } inline const FsBlobView &FsBlob::baseBlob() const { return _baseBlob; } inline FsBlobView &FsBlob::baseBlob() { return _baseBlob; } inline void FsBlob::InitializeBlob(blobstore::Blob *blob, FsBlobView::BlobType magicNumber) { FsBlobView::InitializeBlob(blob, magicNumber); } inline cpputils::unique_ref FsBlob::releaseBaseBlob() { return _baseBlob.releaseBaseBlob(); } } } #endif src/cryfs/filesystem/fsblobstore/FsBlobStore.cpp000066400000000000000000000020571300002025200223570ustar00rootroot00000000000000#include "FsBlobStore.h" #include "FileBlob.h" #include "DirBlob.h" #include "SymlinkBlob.h" namespace bf = boost::filesystem; using cpputils::unique_ref; using cpputils::make_unique_ref; using blobstore::BlobStore; using blockstore::Key; using boost::none; using std::function; namespace cryfs { namespace fsblobstore { boost::optional> FsBlobStore::load(const blockstore::Key &key) { auto blob = _baseBlobStore->load(key); if (blob == none) { return none; } FsBlobView::BlobType blobType = FsBlobView::blobType(**blob); if (blobType == FsBlobView::BlobType::FILE) { return unique_ref(make_unique_ref(std::move(*blob))); } else if (blobType == FsBlobView::BlobType::DIR) { return unique_ref(make_unique_ref(this, std::move(*blob), _getLstatSize())); } else if (blobType == FsBlobView::BlobType::SYMLINK) { return unique_ref(make_unique_ref(std::move(*blob))); } else { ASSERT(false, "Unknown magic number"); } } } }src/cryfs/filesystem/fsblobstore/FsBlobStore.h000066400000000000000000000057711300002025200220320ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_FSBLOBSTORE_H #define MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_FSBLOBSTORE_H #include #include #include #include "FileBlob.h" #include "DirBlob.h" #include "SymlinkBlob.h" namespace cryfs { namespace fsblobstore { //TODO Test classes in fsblobstore class FsBlobStore final { public: FsBlobStore(cpputils::unique_ref baseBlobStore); cpputils::unique_ref createFileBlob(); cpputils::unique_ref createDirBlob(); cpputils::unique_ref createSymlinkBlob(const boost::filesystem::path &target); boost::optional> load(const blockstore::Key &key); void remove(cpputils::unique_ref blob); uint64_t numBlocks() const; uint64_t estimateSpaceForNumBlocksLeft() const; uint64_t virtualBlocksizeBytes() const; private: std::function _getLstatSize(); cpputils::unique_ref _baseBlobStore; DISALLOW_COPY_AND_ASSIGN(FsBlobStore); }; inline FsBlobStore::FsBlobStore(cpputils::unique_ref baseBlobStore) : _baseBlobStore(std::move(baseBlobStore)) { } inline cpputils::unique_ref FsBlobStore::createFileBlob() { auto blob = _baseBlobStore->create(); return FileBlob::InitializeEmptyFile(std::move(blob)); } inline cpputils::unique_ref FsBlobStore::createDirBlob() { auto blob = _baseBlobStore->create(); return DirBlob::InitializeEmptyDir(this, std::move(blob), _getLstatSize()); } inline cpputils::unique_ref FsBlobStore::createSymlinkBlob(const boost::filesystem::path &target) { auto blob = _baseBlobStore->create(); return SymlinkBlob::InitializeSymlink(std::move(blob), target); } inline uint64_t FsBlobStore::numBlocks() const { return _baseBlobStore->numBlocks(); } inline uint64_t FsBlobStore::estimateSpaceForNumBlocksLeft() const { return _baseBlobStore->estimateSpaceForNumBlocksLeft(); } inline void FsBlobStore::remove(cpputils::unique_ref blob) { _baseBlobStore->remove(blob->releaseBaseBlob()); } inline std::function FsBlobStore::_getLstatSize() { return [this] (const blockstore::Key &key) { auto blob = load(key); ASSERT(blob != boost::none, "Blob not found"); return (*blob)->lstat_size(); }; } inline uint64_t FsBlobStore::virtualBlocksizeBytes() const { return _baseBlobStore->virtualBlocksizeBytes(); } } } #endif src/cryfs/filesystem/fsblobstore/FsBlobView.cpp000066400000000000000000000001461300002025200221720ustar00rootroot00000000000000#include "FsBlobView.h" namespace cryfs { constexpr uint16_t FsBlobView::FORMAT_VERSION_HEADER; }src/cryfs/filesystem/fsblobstore/FsBlobView.h000066400000000000000000000074331300002025200216450ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_FSBLOBVIEW_H #define MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_FSBLOBVIEW_H #include #include namespace cryfs { //TODO Test class FsBlobView final : public blobstore::Blob { public: //TODO Rename to "Type" or similar enum class BlobType : uint8_t { DIR = 0x00, FILE = 0x01, SYMLINK = 0x02 }; FsBlobView(cpputils::unique_ref baseBlob): _baseBlob(std::move(baseBlob)) { _checkHeader(*_baseBlob); } static void InitializeBlob(blobstore::Blob *baseBlob, BlobType blobType) { baseBlob->resize(sizeof(FORMAT_VERSION_HEADER) + 1); baseBlob->write(&FORMAT_VERSION_HEADER, 0, sizeof(FORMAT_VERSION_HEADER)); uint8_t blobTypeInt = static_cast(blobType); baseBlob->write(&blobTypeInt, sizeof(FORMAT_VERSION_HEADER), 1); } static BlobType blobType(const blobstore::Blob &blob) { _checkHeader(blob); return _blobType(blob); } BlobType blobType() const { return _blobType(*_baseBlob); } const blockstore::Key &key() const override { return _baseBlob->key(); } uint64_t size() const override { return _baseBlob->size() - sizeof(FORMAT_VERSION_HEADER) - 1; } void resize(uint64_t numBytes) override { return _baseBlob->resize(numBytes + sizeof(FORMAT_VERSION_HEADER) + 1); } cpputils::Data readAll() const override { cpputils::Data data = _baseBlob->readAll(); cpputils::Data dataWithoutHeader(data.size() - sizeof(FORMAT_VERSION_HEADER) - 1); //Can we avoid this memcpy? Maybe by having Data::subdata() that returns a reference to the same memory region? Should we? std::memcpy(dataWithoutHeader.data(), data.dataOffset(sizeof(FORMAT_VERSION_HEADER) + 1), dataWithoutHeader.size()); return dataWithoutHeader; } void read(void *target, uint64_t offset, uint64_t size) const override { return _baseBlob->read(target, offset + sizeof(FORMAT_VERSION_HEADER) + 1, size); } uint64_t tryRead(void *target, uint64_t offset, uint64_t size) const override { return _baseBlob->tryRead(target, offset + sizeof(FORMAT_VERSION_HEADER) + 1, size); } void write(const void *source, uint64_t offset, uint64_t size) override { return _baseBlob->write(source, offset + sizeof(FORMAT_VERSION_HEADER) + 1, size); } void flush() override { return _baseBlob->flush(); } cpputils::unique_ref releaseBaseBlob() { return std::move(_baseBlob); } private: static constexpr uint16_t FORMAT_VERSION_HEADER = 0; static void _checkHeader(const blobstore::Blob &blob) { static_assert(sizeof(uint16_t) == sizeof(FORMAT_VERSION_HEADER), "Wrong type used to read format version header"); uint16_t actualFormatVersion; blob.read(&actualFormatVersion, 0, sizeof(FORMAT_VERSION_HEADER)); if (FORMAT_VERSION_HEADER != actualFormatVersion) { throw std::runtime_error("This file system entity has the wrong format. Was it created with a newer version of CryFS?"); } } static BlobType _blobType(const blobstore::Blob &blob) { uint8_t result; blob.read(&result, sizeof(FORMAT_VERSION_HEADER), 1); return static_cast(result); } cpputils::unique_ref _baseBlob; DISALLOW_COPY_AND_ASSIGN(FsBlobView); }; } #endif src/cryfs/filesystem/fsblobstore/SymlinkBlob.cpp000066400000000000000000000024171300002025200224200ustar00rootroot00000000000000#include "SymlinkBlob.h" #include #include using std::string; using blobstore::Blob; using cpputils::unique_ref; using cpputils::make_unique_ref; namespace bf = boost::filesystem; namespace cryfs { namespace fsblobstore { SymlinkBlob::SymlinkBlob(unique_ref blob) : FsBlob(std::move(blob)), _target(_readTargetFromBlob(baseBlob())) { ASSERT(baseBlob().blobType() == FsBlobView::BlobType::SYMLINK, "Loaded blob is not a symlink"); } unique_ref SymlinkBlob::InitializeSymlink(unique_ref blob, const bf::path &target) { InitializeBlob(blob.get(), FsBlobView::BlobType::SYMLINK); FsBlobView symlinkBlobView(std::move(blob)); string targetStr = target.native(); symlinkBlobView.resize(targetStr.size()); symlinkBlobView.write(targetStr.c_str(), 0, targetStr.size()); return make_unique_ref(symlinkBlobView.releaseBaseBlob()); } bf::path SymlinkBlob::_readTargetFromBlob(const FsBlobView &blob) { char targetStr[blob.size() + 1]; // +1 because of the nullbyte blob.read(targetStr, 0, blob.size()); targetStr[blob.size()] = '\0'; return targetStr; } const bf::path &SymlinkBlob::target() const { return _target; } off_t SymlinkBlob::lstat_size() const { return target().native().size(); } } } src/cryfs/filesystem/fsblobstore/SymlinkBlob.h000066400000000000000000000016531300002025200220660ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_SYMLINKBLOB_H_ #define MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_SYMLINKBLOB_H_ #include #include "FsBlob.h" namespace cryfs { namespace fsblobstore { class SymlinkBlob final: public FsBlob { public: static cpputils::unique_ref InitializeSymlink(cpputils::unique_ref blob, const boost::filesystem::path &target); SymlinkBlob(cpputils::unique_ref blob); const boost::filesystem::path &target() const; off_t lstat_size() const override; private: boost::filesystem::path _target; static boost::filesystem::path _readTargetFromBlob(const FsBlobView &blob); DISALLOW_COPY_AND_ASSIGN(SymlinkBlob); }; } } #endif src/cryfs/filesystem/fsblobstore/utils/000077500000000000000000000000001300002025200206235ustar00rootroot00000000000000src/cryfs/filesystem/fsblobstore/utils/DirEntry.cpp000066400000000000000000000116641300002025200230770ustar00rootroot00000000000000#include "DirEntry.h" using std::vector; using std::string; using blockstore::Key; namespace cryfs { namespace fsblobstore { void DirEntry::serialize(uint8_t *dest) const { ASSERT( ((_type == fspp::Dir::EntryType::FILE) && S_ISREG(_mode) && !S_ISDIR(_mode) && !S_ISLNK(_mode)) || ((_type == fspp::Dir::EntryType::DIR) && !S_ISREG(_mode) && S_ISDIR(_mode) && !S_ISLNK(_mode)) || ((_type == fspp::Dir::EntryType::SYMLINK) && !S_ISREG(_mode) && !S_ISDIR(_mode) && S_ISLNK(_mode)) , "Wrong mode bit set for this type: " + std::to_string(_mode & S_IFREG) + ", " + std::to_string( _mode & S_IFDIR) + ", " + std::to_string(_mode & S_IFLNK) + ", " + std::to_string(static_cast(_type)) ); unsigned int offset = 0; offset += _serializeUint8(dest + offset, static_cast(_type)); offset += _serializeUint32(dest + offset, _mode); offset += _serializeUint32(dest + offset, _uid); offset += _serializeUint32(dest + offset, _gid); offset += _serializeTimeValue(dest + offset, _lastAccessTime); offset += _serializeTimeValue(dest + offset, _lastModificationTime); offset += _serializeTimeValue(dest + offset, _lastMetadataChangeTime); offset += _serializeString(dest + offset, _name); offset += _serializeKey(dest + offset, _key); ASSERT(offset == serializedSize(), "Didn't write correct number of elements"); } const char *DirEntry::deserializeAndAddToVector(const char *pos, vector *result) { fspp::Dir::EntryType type = static_cast(_deserializeUint8(&pos)); mode_t mode = _deserializeUint32(&pos); uid_t uid = _deserializeUint32(&pos); gid_t gid = _deserializeUint32(&pos); timespec lastAccessTime = _deserializeTimeValue(&pos); timespec lastModificationTime = _deserializeTimeValue(&pos); timespec lastMetadataChangeTime = _deserializeTimeValue(&pos); string name = _deserializeString(&pos); Key key = _deserializeKey(&pos); result->emplace_back(type, name, key, mode, uid, gid, lastAccessTime, lastModificationTime, lastMetadataChangeTime); return pos; } unsigned int DirEntry::_serializeTimeValue(uint8_t *dest, timespec value) { unsigned int offset = 0; *reinterpret_cast(dest+offset) = value.tv_sec; offset += sizeof(uint64_t); *reinterpret_cast(dest+offset) = value.tv_nsec; offset += sizeof(uint32_t); ASSERT(offset == _serializedTimeValueSize(), "serialized to wrong size"); return offset; } size_t DirEntry::_serializedTimeValueSize() { return sizeof(uint64_t) + sizeof(uint32_t); } timespec DirEntry::_deserializeTimeValue(const char **pos) { timespec value; value.tv_sec = *(uint64_t*)(*pos); *pos += sizeof(uint64_t); value.tv_nsec = *(uint32_t*)(*pos); *pos += sizeof(uint32_t); return value; } unsigned int DirEntry::_serializeUint8(uint8_t *dest, uint8_t value) { *reinterpret_cast(dest) = value; return sizeof(uint8_t); } uint8_t DirEntry::_deserializeUint8(const char **pos) { uint8_t value = *(uint8_t*)(*pos); *pos += sizeof(uint8_t); return value; } unsigned int DirEntry::_serializeUint32(uint8_t *dest, uint32_t value) { *reinterpret_cast(dest) = value; return sizeof(uint32_t); } uint32_t DirEntry::_deserializeUint32(const char **pos) { uint32_t value = *(uint32_t*)(*pos); *pos += sizeof(uint32_t); return value; } unsigned int DirEntry::_serializeString(uint8_t *dest, const string &value) { std::memcpy(dest, value.c_str(), value.size()+1); return value.size() + 1; } string DirEntry::_deserializeString(const char **pos) { size_t length = strlen(*pos); string value(*pos, length); *pos += length + 1; return value; } unsigned int DirEntry::_serializeKey(uint8_t *dest, const Key &key) { key.ToBinary(dest); return key.BINARY_LENGTH; } Key DirEntry::_deserializeKey(const char **pos) { Key key = Key::FromBinary(*pos); *pos += Key::BINARY_LENGTH; return key; } size_t DirEntry::serializedSize() const { return 1 + sizeof(uint32_t) + sizeof(uint32_t) + sizeof(uint32_t) + 3*_serializedTimeValueSize() + ( _name.size() + 1) + _key.BINARY_LENGTH; } } } src/cryfs/filesystem/fsblobstore/utils/DirEntry.h000066400000000000000000000135511300002025200225410ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_UTILS_DIRENTRY_H #define MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_UTILS_DIRENTRY_H #include #include #include // TODO Implement (and test) atime, noatime, strictatime, relatime mount options namespace cryfs { namespace fsblobstore { class DirEntry final { public: DirEntry(fspp::Dir::EntryType type, const std::string &name, const blockstore::Key &key, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime, timespec lastMetadataChangeTime); void serialize(uint8_t* dest) const; size_t serializedSize() const; static const char *deserializeAndAddToVector(const char *pos, std::vector *result); fspp::Dir::EntryType type() const; void setType(fspp::Dir::EntryType value); const std::string &name() const; void setName(const std::string &value); const blockstore::Key &key() const; mode_t mode() const; void setMode(mode_t value); uid_t uid() const; void setUid(uid_t value); gid_t gid() const; void setGid(gid_t value); timespec lastAccessTime() const; void setLastAccessTime(timespec value); timespec lastModificationTime() const; void setLastModificationTime(timespec value); timespec lastMetadataChangeTime() const; private: static size_t _serializedTimeValueSize(); static unsigned int _serializeTimeValue(uint8_t *dest, timespec value); static unsigned int _serializeUint8(uint8_t *dest, uint8_t value); static unsigned int _serializeUint32(uint8_t *dest, uint32_t value); static unsigned int _serializeString(uint8_t *dest, const std::string &value); static unsigned int _serializeKey(uint8_t *dest, const blockstore::Key &value); static timespec _deserializeTimeValue(const char **pos); static uint8_t _deserializeUint8(const char **pos); static uint32_t _deserializeUint32(const char **pos); static std::string _deserializeString(const char **pos); static blockstore::Key _deserializeKey(const char **pos); void _updateLastMetadataChangeTime(); fspp::Dir::EntryType _type; std::string _name; blockstore::Key _key; mode_t _mode; uid_t _uid; gid_t _gid; timespec _lastAccessTime; timespec _lastModificationTime; timespec _lastMetadataChangeTime; }; inline DirEntry::DirEntry(fspp::Dir::EntryType type, const std::string &name, const blockstore::Key &key, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime, timespec lastMetadataChangeTime) : _type(type), _name(name), _key(key), _mode(mode), _uid(uid), _gid(gid), _lastAccessTime(lastAccessTime), _lastModificationTime(lastModificationTime), _lastMetadataChangeTime(lastMetadataChangeTime) { switch (_type) { case fspp::Dir::EntryType::FILE: _mode |= S_IFREG; break; case fspp::Dir::EntryType::DIR: _mode |= S_IFDIR; break; case fspp::Dir::EntryType::SYMLINK: _mode |= S_IFLNK; break; } ASSERT((S_ISREG(_mode) && _type == fspp::Dir::EntryType::FILE) || (S_ISDIR(_mode) && _type == fspp::Dir::EntryType::DIR) || (S_ISLNK(_mode) && _type == fspp::Dir::EntryType::SYMLINK), "Unknown mode in entry"); } inline fspp::Dir::EntryType DirEntry::type() const { return _type; } inline const std::string &DirEntry::name() const { return _name; } inline const blockstore::Key &DirEntry::key() const { return _key; } inline mode_t DirEntry::mode() const { return _mode; } inline uid_t DirEntry::uid() const { return _uid; } inline gid_t DirEntry::gid() const { return _gid; } inline timespec DirEntry::lastAccessTime() const { return _lastAccessTime; } inline timespec DirEntry::lastModificationTime() const { return _lastModificationTime; } inline timespec DirEntry::lastMetadataChangeTime() const { return _lastMetadataChangeTime; } inline void DirEntry::setType(fspp::Dir::EntryType value) { _type = value; _updateLastMetadataChangeTime(); } inline void DirEntry::setName(const std::string &value) { _name = value; _updateLastMetadataChangeTime(); } inline void DirEntry::setMode(mode_t value) { _mode = value; _updateLastMetadataChangeTime(); } inline void DirEntry::setUid(uid_t value) { _uid = value; _updateLastMetadataChangeTime(); } inline void DirEntry::setGid(gid_t value) { _gid = value; _updateLastMetadataChangeTime(); } inline void DirEntry::setLastAccessTime(timespec value) { _lastAccessTime = value; } inline void DirEntry::setLastModificationTime(timespec value) { _lastModificationTime = value; _updateLastMetadataChangeTime(); } inline void DirEntry::_updateLastMetadataChangeTime() { _lastMetadataChangeTime = cpputils::time::now(); } } } #endif src/cryfs/filesystem/fsblobstore/utils/DirEntryList.cpp000066400000000000000000000217701300002025200237320ustar00rootroot00000000000000#include "DirEntryList.h" #include #include //TODO Get rid of that in favor of better error handling #include using cpputils::Data; using std::string; using std::vector; using blockstore::Key; namespace cryfs { namespace fsblobstore { DirEntryList::DirEntryList() : _entries() { } Data DirEntryList::serialize() const { Data serialized(_serializedSize()); unsigned int offset = 0; for (auto iter = _entries.begin(); iter != _entries.end(); ++iter) { ASSERT(iter == _entries.begin() || std::less()((iter-1)->key(), iter->key()), "Invariant hurt: Directory entries should be ordered by key and not have duplicate keys."); iter->serialize(static_cast(serialized.dataOffset(offset))); offset += iter->serializedSize(); } return serialized; } uint64_t DirEntryList::_serializedSize() const { uint64_t serializedSize = 0; for (const auto &entry : _entries) { serializedSize += entry.serializedSize(); } return serializedSize; } void DirEntryList::deserializeFrom(const void *data, uint64_t size) { _entries.clear(); const char *pos = static_cast(data); while (pos < static_cast(data) + size) { pos = DirEntry::deserializeAndAddToVector(pos, &_entries); ASSERT(_entries.size() == 1 || std::less()(_entries[_entries.size()-2].key(), _entries[_entries.size()-1].key()), "Invariant hurt: Directory entries should be ordered by key and not have duplicate keys."); } } bool DirEntryList::_hasChild(const string &name) const { return _entries.end() != _findByName(name); } void DirEntryList::add(const string &name, const Key &blobKey, fspp::Dir::EntryType entryType, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { if (_hasChild(name)) { throw fspp::fuse::FuseErrnoException(EEXIST); } _add(name, blobKey, entryType, mode, uid, gid, lastAccessTime, lastModificationTime); } void DirEntryList::_add(const string &name, const Key &blobKey, fspp::Dir::EntryType entryType, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { auto insert_pos = _findUpperBound(blobKey); _entries.emplace(insert_pos, entryType, name, blobKey, mode, uid, gid, lastAccessTime, lastModificationTime, cpputils::time::now()); } void DirEntryList::addOrOverwrite(const string &name, const Key &blobKey, fspp::Dir::EntryType entryType, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime, std::function onOverwritten) { auto found = _findByName(name); if (found != _entries.end()) { onOverwritten(found->key()); _overwrite(found, name, blobKey, entryType, mode, uid, gid, lastAccessTime, lastModificationTime); } else { _add(name, blobKey, entryType, mode, uid, gid, lastAccessTime, lastModificationTime); } } void DirEntryList::rename(const blockstore::Key &key, const std::string &name, std::function onOverwritten) { auto foundSameName = _findByName(name); if (foundSameName != _entries.end() && foundSameName->key() != key) { _checkAllowedOverwrite(foundSameName->type(), _findByKey(key)->type()); onOverwritten(foundSameName->key()); _entries.erase(foundSameName); } _findByKey(key)->setName(name); } void DirEntryList::_checkAllowedOverwrite(fspp::Dir::EntryType oldType, fspp::Dir::EntryType newType) { if (oldType != newType) { if (oldType == fspp::Dir::EntryType::DIR) { // new path is an existing directory, but old path is not a directory throw fspp::fuse::FuseErrnoException(EISDIR); } if (newType == fspp::Dir::EntryType::DIR) { // oldpath is a directory, and newpath exists but is not a directory. throw fspp::fuse::FuseErrnoException(ENOTDIR); } } } void DirEntryList::_overwrite(vector::iterator entry, const string &name, const Key &blobKey, fspp::Dir::EntryType entryType, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { _checkAllowedOverwrite(entry->type(), entryType); // The new entry has possibly a different key, so it has to be in a different list position (list is ordered by keys). // That's why we remove-and-add instead of just modifying the existing entry. _entries.erase(entry); _add(name, blobKey, entryType, mode, uid, gid, lastAccessTime, lastModificationTime); } boost::optional DirEntryList::get(const string &name) const { auto found = _findByName(name); if (found == _entries.end()) { return boost::none; } return *found; } boost::optional DirEntryList::get(const Key &key) const { auto found = _findByKey(key); if (found == _entries.end()) { return boost::none; } return *found; } void DirEntryList::remove(const string &name) { auto found = _findByName(name); if (found == _entries.end()) { throw fspp::fuse::FuseErrnoException(ENOENT); } _entries.erase(found); } void DirEntryList::remove(const Key &key) { auto lowerBound = _findLowerBound(key); auto upperBound = std::find_if(lowerBound, _entries.end(), [&key] (const DirEntry &entry) { return entry.key() != key; }); _entries.erase(lowerBound, upperBound); } vector::iterator DirEntryList::_findByName(const string &name) { return std::find_if(_entries.begin(), _entries.end(), [&name] (const DirEntry &entry) { return entry.name() == name; }); } vector::const_iterator DirEntryList::_findByName(const string &name) const { return const_cast(this)->_findByName(name); } vector::iterator DirEntryList::_findByKey(const Key &key) { auto found = _findLowerBound(key); if (found == _entries.end() || found->key() != key) { throw fspp::fuse::FuseErrnoException(ENOENT); } return found; } vector::iterator DirEntryList::_findLowerBound(const Key &key) { return _findFirst(key, [&key] (const DirEntry &entry) { return !std::less()(entry.key(), key); }); } vector::iterator DirEntryList::_findUpperBound(const Key &key) { return _findFirst(key, [&key] (const DirEntry &entry) { return std::less()(key, entry.key()); }); } vector::iterator DirEntryList::_findFirst(const Key &hint, std::function pred) { //TODO Factor out a datastructure that keeps a sorted std::vector and allows these _findLowerBound()/_findUpperBound operations using this hinted linear search if (_entries.size() == 0) { return _entries.end(); } double startpos_percent = static_cast(*static_cast(hint.data())) / std::numeric_limits::max(); auto iter = _entries.begin() + static_cast(startpos_percent * (_entries.size()-1)); ASSERT(iter >= _entries.begin() && iter < _entries.end(), "Startpos out of range"); while(iter != _entries.begin() && pred(*iter)) { --iter; } while(iter != _entries.end() && !pred(*iter)) { ++iter; } return iter; } vector::const_iterator DirEntryList::_findByKey(const Key &key) const { return const_cast(this)->_findByKey(key); } size_t DirEntryList::size() const { return _entries.size(); } DirEntryList::const_iterator DirEntryList::begin() const { return _entries.begin(); } DirEntryList::const_iterator DirEntryList::end() const { return _entries.end(); } void DirEntryList::setMode(const Key &key, mode_t mode) { auto found = _findByKey(key); ASSERT ((S_ISREG(mode) && S_ISREG(found->mode())) || (S_ISDIR(mode) && S_ISDIR(found->mode())) || (S_ISLNK(mode)), "Unknown mode in entry"); found->setMode(mode); } bool DirEntryList::setUidGid(const Key &key, uid_t uid, gid_t gid) { auto found = _findByKey(key); bool changed = false; if (uid != (uid_t)-1) { found->setUid(uid); changed = true; } if (gid != (gid_t)-1) { found->setGid(gid); changed = true; } return changed; } void DirEntryList::setAccessTimes(const blockstore::Key &key, timespec lastAccessTime, timespec lastModificationTime) { auto found = _findByKey(key); found->setLastAccessTime(lastAccessTime); found->setLastModificationTime(lastModificationTime); } void DirEntryList::updateAccessTimestampForChild(const blockstore::Key &key) { auto found = _findByKey(key); // TODO Think about implementing relatime behavior. Currently, CryFS follows strictatime. found->setLastAccessTime(cpputils::time::now()); } void DirEntryList::updateModificationTimestampForChild(const blockstore::Key &key) { auto found = _findByKey(key); found->setLastModificationTime(cpputils::time::now()); } } } src/cryfs/filesystem/fsblobstore/utils/DirEntryList.h000066400000000000000000000071521300002025200233750ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_UTILS_DIRENTRYLIST_H #define MESSMER_CRYFS_FILESYSTEM_FSBLOBSTORE_UTILS_DIRENTRYLIST_H #include #include "DirEntry.h" #include #include //TODO Address elements by name instead of by key when accessing them. Who knows whether there is two hard links for the same blob. namespace cryfs { namespace fsblobstore { class DirEntryList final { public: using const_iterator = std::vector::const_iterator; DirEntryList(); cpputils::Data serialize() const; void deserializeFrom(const void *data, uint64_t size); void add(const std::string &name, const blockstore::Key &blobKey, fspp::Dir::EntryType entryType, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime); void addOrOverwrite(const std::string &name, const blockstore::Key &blobKey, fspp::Dir::EntryType entryType, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime, std::function onOverwritten); void rename(const blockstore::Key &key, const std::string &name, std::function onOverwritten); boost::optional get(const std::string &name) const; boost::optional get(const blockstore::Key &key) const; void remove(const std::string &name); void remove(const blockstore::Key &key); size_t size() const; const_iterator begin() const; const_iterator end() const; void setMode(const blockstore::Key &key, mode_t mode); bool setUidGid(const blockstore::Key &key, uid_t uid, gid_t gid); void setAccessTimes(const blockstore::Key &key, timespec lastAccessTime, timespec lastModificationTime); void updateAccessTimestampForChild(const blockstore::Key &key); void updateModificationTimestampForChild(const blockstore::Key &key); private: uint64_t _serializedSize() const; bool _hasChild(const std::string &name) const; std::vector::iterator _findByName(const std::string &name); std::vector::const_iterator _findByName(const std::string &name) const; std::vector::iterator _findByKey(const blockstore::Key &key); std::vector::const_iterator _findByKey(const blockstore::Key &key) const; std::vector::iterator _findUpperBound(const blockstore::Key &key); std::vector::iterator _findLowerBound(const blockstore::Key &key); std::vector::iterator _findFirst(const blockstore::Key &hint, std::function pred); void _add(const std::string &name, const blockstore::Key &blobKey, fspp::Dir::EntryType entryType, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime); void _overwrite(std::vector::iterator entry, const std::string &name, const blockstore::Key &blobKey, fspp::Dir::EntryType entryType, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime); static void _checkAllowedOverwrite(fspp::Dir::EntryType oldType, fspp::Dir::EntryType newType); std::vector _entries; DISALLOW_COPY_AND_ASSIGN(DirEntryList); }; } } #endif src/cryfs/filesystem/parallelaccessfsblobstore/000077500000000000000000000000001300002025200223625ustar00rootroot00000000000000src/cryfs/filesystem/parallelaccessfsblobstore/DirBlobRef.cpp000066400000000000000000000000301300002025200250310ustar00rootroot00000000000000#include "DirBlobRef.h" src/cryfs/filesystem/parallelaccessfsblobstore/DirBlobRef.h000066400000000000000000000075021300002025200245110ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_PARALLELACCESSFSBLOBSTORE_DIRBLOBREF_H #define MESSMER_CRYFS_FILESYSTEM_PARALLELACCESSFSBLOBSTORE_DIRBLOBREF_H #include "FsBlobRef.h" #include "../cachingfsblobstore/DirBlobRef.h" namespace cryfs { namespace parallelaccessfsblobstore { class DirBlobRef final: public FsBlobRef { public: DirBlobRef(cachingfsblobstore::DirBlobRef *base): _base(base) {} using Entry = fsblobstore::DirEntry; boost::optional GetChild(const std::string &name) const { return _base->GetChild(name); } boost::optional GetChild(const blockstore::Key &key) const { return _base->GetChild(key); } size_t NumChildren() const { return _base->NumChildren(); } void RemoveChild(const blockstore::Key &key) { return _base->RemoveChild(key); } void RemoveChild(const std::string &name) { return _base->RemoveChild(name); } void flush() { return _base->flush(); } void AddOrOverwriteChild(const std::string &name, const blockstore::Key &blobKey, fspp::Dir::EntryType type, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime, std::function onOverwritten) { return _base->AddOrOverwriteChild(name, blobKey, type, mode, uid, gid, lastAccessTime, lastModificationTime, onOverwritten); } void RenameChild(const blockstore::Key &key, const std::string &newName, std::function onOverwritten) { return _base->RenameChild(key, newName, onOverwritten); } void statChild(const blockstore::Key &key, struct ::stat *result) const { return _base->statChild(key, result); } void statChildExceptSize(const blockstore::Key &key, struct ::stat *result) const { return _base->statChildExceptSize(key, result); } void updateAccessTimestampForChild(const blockstore::Key &key) { return _base->updateAccessTimestampForChild(key); } void updateModificationTimestampForChild(const blockstore::Key &key) { return _base->updateModificationTimestampForChild(key); } void chmodChild(const blockstore::Key &key, mode_t mode) { return _base->chmodChild(key, mode); } void chownChild(const blockstore::Key &key, uid_t uid, gid_t gid) { return _base->chownChild(key, uid, gid); } void utimensChild(const blockstore::Key &key, timespec lastAccessTime, timespec lastModificationTime) { return _base->utimensChild(key, lastAccessTime, lastModificationTime); } void AddChildDir(const std::string &name, const blockstore::Key &blobKey, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { return _base->AddChildDir(name, blobKey, mode, uid, gid, lastAccessTime, lastModificationTime); } void AddChildFile(const std::string &name, const blockstore::Key &blobKey, mode_t mode, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { return _base->AddChildFile(name, blobKey, mode, uid, gid, lastAccessTime, lastModificationTime); } void AddChildSymlink(const std::string &name, const blockstore::Key &blobKey, uid_t uid, gid_t gid, timespec lastAccessTime, timespec lastModificationTime) { return _base->AddChildSymlink(name, blobKey, uid, gid, lastAccessTime, lastModificationTime); } void AppendChildrenTo(std::vector *result) const { return _base->AppendChildrenTo(result); } const blockstore::Key &key() const { return _base->key(); } off_t lstat_size() const { return _base->lstat_size(); } private: cachingfsblobstore::DirBlobRef *_base; DISALLOW_COPY_AND_ASSIGN(DirBlobRef); }; } } #endif src/cryfs/filesystem/parallelaccessfsblobstore/FileBlobRef.cpp000066400000000000000000000000311300002025200251730ustar00rootroot00000000000000#include "FileBlobRef.h" src/cryfs/filesystem/parallelaccessfsblobstore/FileBlobRef.h000066400000000000000000000021501300002025200246440ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_PARALLELACCESSFSBLOBSTORE_FILEBLOBREF_H #define MESSMER_CRYFS_FILESYSTEM_PARALLELACCESSFSBLOBSTORE_FILEBLOBREF_H #include "FsBlobRef.h" #include "../cachingfsblobstore/FileBlobRef.h" namespace cryfs { namespace parallelaccessfsblobstore { class FileBlobRef final: public FsBlobRef { public: FileBlobRef(cachingfsblobstore::FileBlobRef *base) : _base(base) {} void resize(off_t size) { return _base->resize(size); } off_t size() const { return _base->size(); } ssize_t read(void *target, uint64_t offset, uint64_t count) const { return _base->read(target, offset, count); } void write(const void *source, uint64_t offset, uint64_t count) { return _base->write(source, offset, count); } void flush() { return _base->flush(); } const blockstore::Key &key() const { return _base->key(); } off_t lstat_size() const { return _base->lstat_size(); } private: cachingfsblobstore::FileBlobRef *_base; DISALLOW_COPY_AND_ASSIGN(FileBlobRef); }; } } #endif src/cryfs/filesystem/parallelaccessfsblobstore/FsBlobRef.cpp000066400000000000000000000000271300002025200246710ustar00rootroot00000000000000#include "FsBlobRef.h" src/cryfs/filesystem/parallelaccessfsblobstore/FsBlobRef.h000066400000000000000000000012531300002025200243400ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_PARALLELACCESSFSBLOBSTORE_FSBLOBREF_H #define MESSMER_CRYFS_FILESYSTEM_PARALLELACCESSFSBLOBSTORE_FSBLOBREF_H #include #include "../cachingfsblobstore/FsBlobRef.h" namespace cryfs { namespace parallelaccessfsblobstore { class FsBlobRef: public parallelaccessstore::ParallelAccessStore::ResourceRefBase { public: virtual ~FsBlobRef() {} virtual const blockstore::Key &key() const = 0; virtual off_t lstat_size() const = 0; protected: FsBlobRef() {} private: DISALLOW_COPY_AND_ASSIGN(FsBlobRef); }; } } #endif src/cryfs/filesystem/parallelaccessfsblobstore/ParallelAccessFsBlobStore.cpp000066400000000000000000000057661300002025200300670ustar00rootroot00000000000000#include "ParallelAccessFsBlobStore.h" #include "ParallelAccessFsBlobStoreAdapter.h" #include "../fsblobstore/FsBlobStore.h" namespace bf = boost::filesystem; using cryfs::cachingfsblobstore::CachingFsBlobStore; using cryfs::fsblobstore::FsBlob; using cryfs::fsblobstore::FileBlob; using cryfs::fsblobstore::DirBlob; using cryfs::fsblobstore::SymlinkBlob; using cpputils::unique_ref; using cpputils::make_unique_ref; using boost::optional; using boost::none; using blockstore::Key; namespace cryfs { namespace parallelaccessfsblobstore { optional> ParallelAccessFsBlobStore::load(const Key &key) { return _parallelAccessStore.load(key, [this] (cachingfsblobstore::FsBlobRef *blob) { cachingfsblobstore::FileBlobRef *fileBlob = dynamic_cast(blob); if (fileBlob != nullptr) { return unique_ref(make_unique_ref(fileBlob)); } cachingfsblobstore::DirBlobRef *dirBlob = dynamic_cast(blob); if (dirBlob != nullptr) { dirBlob->setLstatSizeGetter(_getLstatSize()); return unique_ref(make_unique_ref(dirBlob)); } cachingfsblobstore::SymlinkBlobRef *symlinkBlob = dynamic_cast(blob); if (symlinkBlob != nullptr) { return unique_ref(make_unique_ref(symlinkBlob)); } ASSERT(false, "Unknown blob type loaded"); }); } unique_ref ParallelAccessFsBlobStore::createDirBlob() { auto blob = _baseBlobStore->createDirBlob(); blob->setLstatSizeGetter(_getLstatSize()); Key key = blob->key(); return _parallelAccessStore.add(key, std::move(blob), [] (cachingfsblobstore::FsBlobRef *resource) { auto dirBlob = dynamic_cast(resource); ASSERT(dirBlob != nullptr, "Wrong resource given"); return make_unique_ref(dirBlob); }); } unique_ref ParallelAccessFsBlobStore::createFileBlob() { auto blob = _baseBlobStore->createFileBlob(); Key key = blob->key(); return _parallelAccessStore.add(key, std::move(blob), [] (cachingfsblobstore::FsBlobRef *resource) { auto fileBlob = dynamic_cast(resource); ASSERT(fileBlob != nullptr, "Wrong resource given"); return make_unique_ref(fileBlob); }); } unique_ref ParallelAccessFsBlobStore::createSymlinkBlob(const bf::path &target) { auto blob = _baseBlobStore->createSymlinkBlob(target); Key key = blob->key(); return _parallelAccessStore.add(key, std::move(blob), [] (cachingfsblobstore::FsBlobRef *resource) { auto symlinkBlob = dynamic_cast(resource); ASSERT(symlinkBlob != nullptr, "Wrong resource given"); return make_unique_ref(symlinkBlob); }); } } } src/cryfs/filesystem/parallelaccessfsblobstore/ParallelAccessFsBlobStore.h000066400000000000000000000063761300002025200275320ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_PARALLELACCESSFSBLOBSTORE_PARALLELACCESSFSBLOBSTORE_H #define MESSMER_CRYFS_FILESYSTEM_PARALLELACCESSFSBLOBSTORE_PARALLELACCESSFSBLOBSTORE_H #include #include "FileBlobRef.h" #include "DirBlobRef.h" #include "SymlinkBlobRef.h" #include "../cachingfsblobstore/CachingFsBlobStore.h" #include "ParallelAccessFsBlobStoreAdapter.h" namespace cryfs { namespace parallelaccessfsblobstore { //TODO Test classes in parallelaccessfsblobstore //TODO Race condition: Thread 1 destructs CachingFsBlobStore element from ParallelAccessFsBlobStore, but // it didn't get written into cache yet, when Thread 2 requests it. // Same race condition in Caching/ParallelAccessBlockStore? class ParallelAccessFsBlobStore final { public: ParallelAccessFsBlobStore(cpputils::unique_ref baseBlobStore); cpputils::unique_ref createFileBlob(); cpputils::unique_ref createDirBlob(); cpputils::unique_ref createSymlinkBlob(const boost::filesystem::path &target); boost::optional> load(const blockstore::Key &key); void remove(cpputils::unique_ref blob); uint64_t virtualBlocksizeBytes() const; uint64_t numBlocks() const; uint64_t estimateSpaceForNumBlocksLeft() const; private: cpputils::unique_ref _baseBlobStore; parallelaccessstore::ParallelAccessStore _parallelAccessStore; std::function _getLstatSize(); DISALLOW_COPY_AND_ASSIGN(ParallelAccessFsBlobStore); }; inline ParallelAccessFsBlobStore::ParallelAccessFsBlobStore(cpputils::unique_ref baseBlobStore) : _baseBlobStore(std::move(baseBlobStore)), _parallelAccessStore(cpputils::make_unique_ref(_baseBlobStore.get())) { } inline void ParallelAccessFsBlobStore::remove(cpputils::unique_ref blob) { blockstore::Key key = blob->key(); return _parallelAccessStore.remove(key, std::move(blob)); } inline std::function ParallelAccessFsBlobStore::_getLstatSize() { return [this] (const blockstore::Key &key) { auto blob = load(key); ASSERT(blob != boost::none, "Blob not found"); return (*blob)->lstat_size(); }; } inline uint64_t ParallelAccessFsBlobStore::virtualBlocksizeBytes() const { return _baseBlobStore->virtualBlocksizeBytes(); } inline uint64_t ParallelAccessFsBlobStore::numBlocks() const { return _baseBlobStore->numBlocks(); } inline uint64_t ParallelAccessFsBlobStore::estimateSpaceForNumBlocksLeft() const { return _baseBlobStore->estimateSpaceForNumBlocksLeft(); } } } #endif src/cryfs/filesystem/parallelaccessfsblobstore/ParallelAccessFsBlobStoreAdapter.cpp000066400000000000000000000000561300002025200313530ustar00rootroot00000000000000#include "ParallelAccessFsBlobStoreAdapter.h" src/cryfs/filesystem/parallelaccessfsblobstore/ParallelAccessFsBlobStoreAdapter.h000066400000000000000000000022331300002025200310170ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_PARALLELACCESSFSBLOBSTORE_PARALLELACCESSFSBLOBSTOREADAPTER_H_ #define MESSMER_CRYFS_FILESYSTEM_PARALLELACCESSFSBLOBSTORE_PARALLELACCESSFSBLOBSTOREADAPTER_H_ #include #include #include "../cachingfsblobstore/CachingFsBlobStore.h" namespace cryfs { namespace parallelaccessfsblobstore { class ParallelAccessFsBlobStoreAdapter final: public parallelaccessstore::ParallelAccessBaseStore { public: explicit ParallelAccessFsBlobStoreAdapter(cachingfsblobstore::CachingFsBlobStore *baseBlockStore) :_baseBlockStore(std::move(baseBlockStore)) { } boost::optional> loadFromBaseStore(const blockstore::Key &key) override { return _baseBlockStore->load(key); } void removeFromBaseStore(cpputils::unique_ref block) override { return _baseBlockStore->remove(std::move(block)); } private: cachingfsblobstore::CachingFsBlobStore *_baseBlockStore; DISALLOW_COPY_AND_ASSIGN(ParallelAccessFsBlobStoreAdapter); }; } } #endif src/cryfs/filesystem/parallelaccessfsblobstore/SymlinkBlobRef.cpp000066400000000000000000000000341300002025200257450ustar00rootroot00000000000000#include "SymlinkBlobRef.h" src/cryfs/filesystem/parallelaccessfsblobstore/SymlinkBlobRef.h000066400000000000000000000014301300002025200254130ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_FILESYSTEM_PARALLELACCESSFSBLOBSTORE_SYMLINKBLOBREF_H #define MESSMER_CRYFS_FILESYSTEM_PARALLELACCESSFSBLOBSTORE_SYMLINKBLOBREF_H #include "FsBlobRef.h" #include "../cachingfsblobstore/SymlinkBlobRef.h" namespace cryfs { namespace parallelaccessfsblobstore { class SymlinkBlobRef final: public FsBlobRef { public: SymlinkBlobRef(cachingfsblobstore::SymlinkBlobRef *base) : _base(base) {} const boost::filesystem::path &target() const { return _base->target(); } const blockstore::Key &key() const { return _base->key(); } off_t lstat_size() const { return _base->lstat_size(); } private: cachingfsblobstore::SymlinkBlobRef *_base; DISALLOW_COPY_AND_ASSIGN(SymlinkBlobRef); }; } } #endif src/fspp/000077500000000000000000000000001300002025200125755ustar00rootroot00000000000000src/fspp/CMakeLists.txt000066400000000000000000000013701300002025200153360ustar00rootroot00000000000000project (fspp) set(SOURCES impl/FilesystemImpl.cpp impl/Profiler.cpp fuse/Fuse.cpp ) add_library(${PROJECT_NAME} STATIC ${SOURCES}) target_compile_definitions(${PROJECT_NAME} PUBLIC _FILE_OFFSET_BITS=64) target_link_libraries(${PROJECT_NAME} PUBLIC cpp-utils) target_add_boost(${PROJECT_NAME} filesystem system thread chrono) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin") set(CMAKE_FIND_FRAMEWORK LAST) set(FUSE_LIB_NAME "osxfuse") else(${CMAKE_SYSTEM_NAME} MATCHES "Darwin") set(FUSE_LIB_NAME "fuse") endif(${CMAKE_SYSTEM_NAME} MATCHES "Darwin") find_library_with_path(FUSE ${FUSE_LIB_NAME} FUSE_LIB_PATH) target_link_libraries(${PROJECT_NAME} PUBLIC ${FUSE}) src/fspp/fs_interface/000077500000000000000000000000001300002025200152255ustar00rootroot00000000000000src/fspp/fs_interface/Device.h000066400000000000000000000007371300002025200166040ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSINTERFACE_DEVICE_H_ #define MESSMER_FSPP_FSINTERFACE_DEVICE_H_ #include #include #include namespace fspp { class Node; class Device { public: virtual ~Device() {} virtual void statfs(const boost::filesystem::path &path, struct ::statvfs *fsstat) = 0; virtual boost::optional> Load(const boost::filesystem::path &path) = 0; }; } #endif src/fspp/fs_interface/Dir.h000066400000000000000000000021271300002025200161160ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSINTERFACE_DIR_H_ #define MESSMER_FSPP_FSINTERFACE_DIR_H_ #include "Node.h" #include #include namespace fspp { class Device; class OpenFile; class Dir: public virtual Node { public: virtual ~Dir() {} enum class EntryType: uint8_t { DIR = 0x00, FILE = 0x01, SYMLINK = 0x02 }; struct Entry { Entry(EntryType type_, const std::string &name_): type(type_), name(name_) {} EntryType type; std::string name; }; virtual cpputils::unique_ref createAndOpenFile(const std::string &name, mode_t mode, uid_t uid, gid_t gid) = 0; virtual void createDir(const std::string &name, mode_t mode, uid_t uid, gid_t gid) = 0; virtual void createSymlink(const std::string &name, const boost::filesystem::path &target, uid_t uid, gid_t gid) = 0; //TODO Allow alternative implementation returning only children names without more information //virtual std::unique_ptr> children() const = 0; virtual cpputils::unique_ref> children() = 0; }; } #endif src/fspp/fs_interface/File.h000066400000000000000000000006021300002025200162530ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSINTERFACE_FILE_H_ #define MESSMER_FSPP_FSINTERFACE_FILE_H_ #include "Node.h" #include namespace fspp { class Device; class OpenFile; class File: public virtual Node { public: virtual ~File() {} virtual cpputils::unique_ref open(int flags) = 0; virtual void truncate(off_t size) = 0; }; } #endif src/fspp/fs_interface/Node.h000066400000000000000000000011761300002025200162700ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSINTERFACE_NODE_H_ #define MESSMER_FSPP_FSINTERFACE_NODE_H_ #include #include namespace fspp { class Node { public: virtual ~Node() {} virtual void stat(struct ::stat *result) const = 0; virtual void chmod(mode_t mode) = 0; virtual void chown(uid_t uid, gid_t gid) = 0; virtual void access(int mask) const = 0; virtual void rename(const boost::filesystem::path &to) = 0; // 'to' will always be an absolute path virtual void utimens(const timespec lastAccessTime, const timespec lastModificationTime) = 0; virtual void remove() = 0; }; } #endif src/fspp/fs_interface/OpenFile.h000066400000000000000000000011141300002025200170740ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSINTERFACE_OPENFILE_H_ #define MESSMER_FSPP_FSINTERFACE_OPENFILE_H_ #include #include namespace fspp { class Device; class OpenFile { public: virtual ~OpenFile() {} virtual void stat(struct ::stat *result) const = 0; virtual void truncate(off_t size) const = 0; virtual size_t read(void *buf, size_t count, off_t offset) const = 0; virtual void write(const void *buf, size_t count, off_t offset) = 0; virtual void flush() = 0; virtual void fsync() = 0; virtual void fdatasync() = 0; }; } #endif src/fspp/fs_interface/Symlink.h000066400000000000000000000005311300002025200170230ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSINTERFACE_SYMLINK_H_ #define MESSMER_FSPP_FSINTERFACE_SYMLINK_H_ #include "Node.h" #include #include namespace fspp { class Device; class Symlink: public virtual Node { public: virtual ~Symlink() {} virtual boost::filesystem::path target() = 0; }; } #endif src/fspp/fstest/000077500000000000000000000000001300002025200141055ustar00rootroot00000000000000src/fspp/fstest/FsTest.h000066400000000000000000000040451300002025200154710ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSTEST_H_ #define MESSMER_FSPP_FSTEST_FSTEST_H_ #include "testutils/FileSystemTest.h" #include "FsppDeviceTest.h" #include "FsppDirTest.h" #include "FsppFileTest.h" #include "FsppSymlinkTest.h" #include "FsppNodeTest_Rename.h" #include "FsppNodeTest_Stat.h" #include "FsppOpenFileTest.h" #include "FsppDeviceTest_Timestamps.h" #include "FsppNodeTest_Timestamps.h" #include "FsppDirTest_Timestamps.h" #include "FsppSymlinkTest_Timestamps.h" #include "FsppFileTest_Timestamps.h" #include "FsppOpenFileTest_Timestamps.h" #define FSPP_ADD_FILESYTEM_TESTS(FS_NAME, FIXTURE) \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, FsppDeviceTest, FIXTURE); \ INSTANTIATE_NODE_TEST_CASE( FS_NAME, FsppDeviceTest_Timestamps, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, FsppDirTest, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, FsppDirTest_Timestamps, FIXTURE); \ INSTANTIATE_NODE_TEST_CASE( FS_NAME, FsppDirTest_Timestamps_Entries, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, FsppFileTest, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, FsppFileTest_Timestamps, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, FsppSymlinkTest, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, FsppSymlinkTest_Timestamps, FIXTURE); \ INSTANTIATE_NODE_TEST_CASE( FS_NAME, FsppNodeTest_Rename, FIXTURE); \ INSTANTIATE_NODE_TEST_CASE( FS_NAME, FsppNodeTest_Stat, FIXTURE); \ INSTANTIATE_NODE_TEST_CASE( FS_NAME, FsppNodeTest_Timestamps, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, FsppNodeTest_Stat_FileOnly, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, FsppNodeTest_Stat_DirOnly, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, FsppNodeTest_Stat_SymlinkOnly, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, FsppOpenFileTest, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, FsppOpenFileTest_Timestamps, FIXTURE); \ #endif src/fspp/fstest/FsppDeviceTest.h000066400000000000000000000062021300002025200171460ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPDEVICETEST_H_ #define MESSMER_FSPP_FSTEST_FSPPDEVICETEST_H_ template class FsppDeviceTest: public FileSystemTest { public: void InitDirStructure() { this->LoadDir("/")->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); this->LoadDir("/")->createDir("mydir", this->MODE_PUBLIC, 0, 0); this->LoadDir("/")->createDir("myemptydir", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir")->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir")->createAndOpenFile("myfile2", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir")->createDir("mysubdir", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir/mysubdir")->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir/mysubdir")->createDir("mysubsubdir", this->MODE_PUBLIC, 0, 0); } }; TYPED_TEST_CASE_P(FsppDeviceTest); TYPED_TEST_P(FsppDeviceTest, InitFilesystem) { //fixture->createDevice() is called in the FileSystemTest constructor } TYPED_TEST_P(FsppDeviceTest, LoadRootDir) { this->LoadDir("/"); } TYPED_TEST_P(FsppDeviceTest, LoadFileFromRootDir) { this->InitDirStructure(); this->LoadFile("/myfile"); } TYPED_TEST_P(FsppDeviceTest, LoadDirFromRootDir) { this->InitDirStructure(); this->LoadDir("/mydir"); } TYPED_TEST_P(FsppDeviceTest, LoadNonexistingFromEmptyRootDir) { EXPECT_EQ(boost::none, this->device->Load("/nonexisting")); } TYPED_TEST_P(FsppDeviceTest, LoadNonexistingFromRootDir) { this->InitDirStructure(); EXPECT_EQ(boost::none, this->device->Load("/nonexisting")); } TYPED_TEST_P(FsppDeviceTest, LoadNonexistingFromNonexistingDir) { this->InitDirStructure(); //TODO Change as soon as we have a concept of how to handle filesystem errors in the interface EXPECT_ANY_THROW( this->device->Load("/nonexisting/nonexisting2") ); } TYPED_TEST_P(FsppDeviceTest, LoadNonexistingFromExistingDir) { this->InitDirStructure(); EXPECT_EQ(boost::none, this->device->Load("/mydir/nonexisting")); } TYPED_TEST_P(FsppDeviceTest, LoadNonexistingFromExistingEmptyDir) { this->InitDirStructure(); EXPECT_EQ(boost::none, this->device->Load("/myemptydir/nonexisting")); } TYPED_TEST_P(FsppDeviceTest, LoadFileFromDir_Nesting1) { this->InitDirStructure(); this->LoadFile("/mydir/myfile"); } TYPED_TEST_P(FsppDeviceTest, LoadDirFromDir_Nesting1) { this->InitDirStructure(); this->LoadDir("/mydir/mysubdir"); } TYPED_TEST_P(FsppDeviceTest, LoadFileFromDir_Nesting2) { this->InitDirStructure(); this->LoadFile("/mydir/mysubdir/myfile"); } TYPED_TEST_P(FsppDeviceTest, LoadDirFromDir_Nesting2) { this->InitDirStructure(); this->LoadDir("/mydir/mysubdir/mysubsubdir"); } //TODO Test statfs REGISTER_TYPED_TEST_CASE_P(FsppDeviceTest, InitFilesystem, LoadRootDir, LoadFileFromRootDir, LoadDirFromRootDir, LoadNonexistingFromEmptyRootDir, LoadNonexistingFromRootDir, LoadNonexistingFromNonexistingDir, LoadNonexistingFromExistingDir, LoadNonexistingFromExistingEmptyDir, LoadFileFromDir_Nesting1, LoadDirFromDir_Nesting1, LoadFileFromDir_Nesting2, LoadDirFromDir_Nesting2 ); #endif src/fspp/fstest/FsppDeviceTest_Timestamps.h000066400000000000000000000023501300002025200213540ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPDEVICETEST_TIMESTAMPS_H_ #define MESSMER_FSPP_FSTEST_FSPPDEVICETEST_TIMESTAMPS_H_ #include "testutils/TimestampTestUtils.h" template class FsppDeviceTest_Timestamps: public FsppNodeTest, public TimestampTestUtils { public: void Test_Load_While_Loaded() { auto node = this->CreateNode("/mynode"); auto operation = [this, &node] () { this->device->Load("/mynode"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAnyTimestamps}); } void Test_Load_While_Not_Loaded() { struct stat oldStat; { auto node = this->CreateNode("/mynode"); oldStat = stat(*node); this->ensureNodeTimestampsAreOld(oldStat); } this->device->Load("/myfile"); auto node = this->device->Load("/mynode"); //Test that timestamps didn't change struct stat newStat = stat(*node.value()); EXPECT_EQ(oldStat.st_atim, newStat.st_atim); EXPECT_EQ(oldStat.st_mtim, newStat.st_mtim); EXPECT_EQ(oldStat.st_ctim, newStat.st_ctim); } }; REGISTER_NODE_TEST_CASE(FsppDeviceTest_Timestamps, Load_While_Loaded, Load_While_Not_Loaded ); #endif src/fspp/fstest/FsppDirTest.h000066400000000000000000000222441300002025200164710ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPDIRTEST_H_ #define MESSMER_FSPP_FSTEST_FSPPDIRTEST_H_ template class FsppDirTest: public FileSystemTest { public: void InitDirStructure() { this->LoadDir("/")->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); this->LoadDir("/")->createDir("mydir", this->MODE_PUBLIC, 0, 0); this->LoadDir("/")->createDir("myemptydir", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir")->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir")->createAndOpenFile("myfile2", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir")->createDir("mysubdir", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir/mysubdir")->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir/mysubdir")->createDir("mysubsubdir", this->MODE_PUBLIC, 0, 0); } void EXPECT_CHILDREN_ARE(const boost::filesystem::path &path, const std::initializer_list expected) { EXPECT_CHILDREN_ARE(this->LoadDir(path).get(), expected); } void EXPECT_CHILDREN_ARE(fspp::Dir *dir, const std::initializer_list expected) { std::vector expectedChildren = expected; expectedChildren.push_back(fspp::Dir::Entry(fspp::Dir::EntryType::DIR, ".")); expectedChildren.push_back(fspp::Dir::Entry(fspp::Dir::EntryType::DIR, "..")); EXPECT_UNORDERED_EQ(expectedChildren, *dir->children()); } template void EXPECT_UNORDERED_EQ(const std::vector &expected, std::vector actual) { EXPECT_EQ(expected.size(), actual.size()); for (const Entry &expectedEntry : expected) { removeOne(&actual, expectedEntry); } } template void removeOne(std::vector *entries, const Entry &toRemove) { for (auto iter = entries->begin(); iter != entries->end(); ++iter) { if (iter->type == toRemove.type && iter->name == toRemove.name) { entries->erase(iter); return; } } EXPECT_TRUE(false); } }; TYPED_TEST_CASE_P(FsppDirTest); fspp::Dir::Entry DirEntry(const std::string &name) { return fspp::Dir::Entry(fspp::Dir::EntryType::DIR, name); } fspp::Dir::Entry FileEntry(const std::string &name) { return fspp::Dir::Entry(fspp::Dir::EntryType::FILE, name); } TYPED_TEST_P(FsppDirTest, Children_RootDir_Empty) { this->EXPECT_CHILDREN_ARE("/", {}); } TYPED_TEST_P(FsppDirTest, Children_RootDir_OneFile_Directly) { auto rootdir = this->LoadDir("/"); rootdir->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE(rootdir.get(), { FileEntry("myfile") }); } TYPED_TEST_P(FsppDirTest, Children_RootDir_OneFile_AfterReloadingDir) { this->LoadDir("/")->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE("/", { FileEntry("myfile") }); } TYPED_TEST_P(FsppDirTest, Children_RootDir_OneDir_Directly) { auto rootdir = this->LoadDir("/"); rootdir->createDir("mydir", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE(rootdir.get(), { DirEntry("mydir") }); } TYPED_TEST_P(FsppDirTest, Children_RootDir_OneDir_AfterReloadingDir) { this->LoadDir("/")->createDir("mydir", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE("/", { DirEntry("mydir") }); } TYPED_TEST_P(FsppDirTest, Children_RootDir_LargerStructure) { this->InitDirStructure(); this->EXPECT_CHILDREN_ARE("/", { FileEntry("myfile"), DirEntry("mydir"), DirEntry("myemptydir") }); } TYPED_TEST_P(FsppDirTest, Children_Nested_Empty) { this->LoadDir("/")->createDir("myemptydir", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE("/myemptydir", {}); } TYPED_TEST_P(FsppDirTest, Children_Nested_OneFile_Directly) { this->LoadDir("/")->createDir("mydir", this->MODE_PUBLIC, 0, 0); auto dir = this->LoadDir("/mydir"); dir->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE(dir.get(), { FileEntry("myfile") }); } TYPED_TEST_P(FsppDirTest, Children_Nested_OneFile_AfterReloadingDir) { this->LoadDir("/")->createDir("mydir", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir")->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE("/mydir", { FileEntry("myfile") }); } TYPED_TEST_P(FsppDirTest, Children_Nested_OneDir_Directly) { this->LoadDir("/")->createDir("mydir", this->MODE_PUBLIC, 0, 0); auto dir = this->LoadDir("/mydir"); dir->createDir("mysubdir", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE(dir.get(), { DirEntry("mysubdir") }); } TYPED_TEST_P(FsppDirTest, Children_Nested_OneDir_AfterReloadingDir) { this->LoadDir("/")->createDir("mydir", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir")->createDir("mysubdir", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE("/mydir", { DirEntry("mysubdir") }); } TYPED_TEST_P(FsppDirTest, Children_Nested_LargerStructure_Empty) { this->InitDirStructure(); this->EXPECT_CHILDREN_ARE("/myemptydir", {}); } TYPED_TEST_P(FsppDirTest, Children_Nested_LargerStructure) { this->InitDirStructure(); this->EXPECT_CHILDREN_ARE("/mydir", { FileEntry("myfile"), FileEntry("myfile2"), DirEntry("mysubdir") }); } TYPED_TEST_P(FsppDirTest, Children_Nested2_LargerStructure) { this->InitDirStructure(); this->EXPECT_CHILDREN_ARE("/mydir/mysubdir", { FileEntry("myfile"), DirEntry("mysubsubdir") }); } TYPED_TEST_P(FsppDirTest, CreateAndOpenFile_InEmptyRoot) { this->LoadDir("/")->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); this->LoadFile("/myfile"); } TYPED_TEST_P(FsppDirTest, CreateAndOpenFile_InNonemptyRoot) { this->InitDirStructure(); this->LoadDir("/")->createAndOpenFile("mynewfile", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE("/", { FileEntry("myfile"), DirEntry("mydir"), DirEntry("myemptydir"), FileEntry("mynewfile") }); } TYPED_TEST_P(FsppDirTest, CreateAndOpenFile_InEmptyNestedDir) { this->InitDirStructure(); this->LoadDir("/myemptydir")->createAndOpenFile("mynewfile", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE("/myemptydir", { FileEntry("mynewfile") }); } TYPED_TEST_P(FsppDirTest, CreateAndOpenFile_InNonemptyNestedDir) { this->InitDirStructure(); this->LoadDir("/mydir")->createAndOpenFile("mynewfile", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE("/mydir", { FileEntry("myfile"), FileEntry("myfile2"), DirEntry("mysubdir"), FileEntry("mynewfile") }); } TYPED_TEST_P(FsppDirTest, CreateAndOpenFile_AlreadyExisting) { this->LoadDir("/")->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); //TODO Change, once we know which way of error reporting we want for such errors EXPECT_ANY_THROW( this->LoadDir("/")->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); ); } TYPED_TEST_P(FsppDirTest, CreateDir_InEmptyRoot) { this->LoadDir("/")->createDir("mydir", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir"); } TYPED_TEST_P(FsppDirTest, CreateDir_InNonemptyRoot) { this->InitDirStructure(); this->LoadDir("/")->createDir("mynewdir", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE("/", { FileEntry("myfile"), DirEntry("mydir"), DirEntry("myemptydir"), DirEntry("mynewdir") }); } TYPED_TEST_P(FsppDirTest, CreateDir_InEmptyNestedDir) { this->InitDirStructure(); this->LoadDir("/myemptydir")->createDir("mynewdir", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE("/myemptydir", { DirEntry("mynewdir") }); } TYPED_TEST_P(FsppDirTest, CreateDir_InNonemptyNestedDir) { this->InitDirStructure(); this->LoadDir("/mydir")->createDir("mynewdir", this->MODE_PUBLIC, 0, 0); this->EXPECT_CHILDREN_ARE("/mydir", { FileEntry("myfile"), FileEntry("myfile2"), DirEntry("mysubdir"), DirEntry("mynewdir") }); } TYPED_TEST_P(FsppDirTest, CreateDir_AlreadyExisting) { this->LoadDir("/")->createDir("mydir", this->MODE_PUBLIC, 0, 0); //TODO Change, once we know which way of error reporting we want for such errors EXPECT_ANY_THROW( this->LoadDir("/")->createDir("mydir", this->MODE_PUBLIC, 0, 0); ); } REGISTER_TYPED_TEST_CASE_P(FsppDirTest, Children_RootDir_Empty, Children_RootDir_OneFile_Directly, Children_RootDir_OneFile_AfterReloadingDir, Children_RootDir_OneDir_Directly, Children_RootDir_OneDir_AfterReloadingDir, Children_RootDir_LargerStructure, Children_Nested_Empty, Children_Nested_OneFile_Directly, Children_Nested_OneFile_AfterReloadingDir, Children_Nested_OneDir_Directly, Children_Nested_OneDir_AfterReloadingDir, Children_Nested_LargerStructure, Children_Nested_LargerStructure_Empty, Children_Nested2_LargerStructure, CreateAndOpenFile_InEmptyRoot, CreateAndOpenFile_InNonemptyRoot, CreateAndOpenFile_InEmptyNestedDir, CreateAndOpenFile_InNonemptyNestedDir, CreateAndOpenFile_AlreadyExisting, CreateDir_InEmptyRoot, CreateDir_InNonemptyRoot, CreateDir_InEmptyNestedDir, CreateDir_InNonemptyNestedDir, CreateDir_AlreadyExisting ); //TODO rmdir (also test that deleting a non-empty dir returns ENOTEMPTY, because otherwise there might not be any unlink syscalls for the entries issued) //TODO mkdir with uid/gid //TODO createAndOpenFile: all stat values correctly set (1. in the OpenFile instance returned from createAndOpenFile and 2. on an lstat on the file object afterwards) //TODO Test all operations do (or don't) affect dir timestamps correctly #endif src/fspp/fstest/FsppDirTest_Timestamps.h000066400000000000000000000262511300002025200207010ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPDIRTEST_TIMESTAMPS_H_ #define MESSMER_FSPP_FSTEST_FSPPDIRTEST_TIMESTAMPS_H_ #include "testutils/TimestampTestUtils.h" template class FsppDirTest_Timestamps: public FileSystemTest, public TimestampTestUtils { public: }; TYPED_TEST_CASE_P(FsppDirTest_Timestamps); TYPED_TEST_P(FsppDirTest_Timestamps, createAndOpenFile) { auto dir = this->CreateDir("/mydir"); auto operation = [&dir] () { dir->createAndOpenFile("childname", S_IFREG, 1000, 1000); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } /* TODO Re-enable this test once the root dir handles timestamps correctly TYPED_TEST_P(FsppDirTest_Timestamps, createAndOpenFile_inRootDir) { auto dir = this->LoadDir("/"); auto operation = [&dir] () { dir->createAndOpenFile("childname", S_IFREG, 1000, 1000); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); }*/ TYPED_TEST_P(FsppDirTest_Timestamps, createAndOpenFile_TimestampsOfCreatedFile) { auto dir = this->CreateDir("/mydir"); timespec lowerBound = now(); dir->createAndOpenFile("childname", S_IFREG, 1000, 1000); timespec upperBound = now(); auto child = this->LoadFile("/mydir/childname"); this->EXPECT_ACCESS_TIMESTAMP_BETWEEN (lowerBound, upperBound, *child); this->EXPECT_MODIFICATION_TIMESTAMP_BETWEEN (lowerBound, upperBound, *child); this->EXPECT_METADATACHANGE_TIMESTAMP_BETWEEN(lowerBound, upperBound, *child); } TYPED_TEST_P(FsppDirTest_Timestamps, createDir) { auto dir = this->CreateDir("/mydir"); auto operation = [&dir] () { dir->createDir("childname", S_IFDIR, 1000, 1000); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } /* TODO Re-enable this test once the root dir handles timestamps correctly TYPED_TEST_P(FsppDirTest_Timestamps, createDir_inRootDir) { auto dir = this->LoadDir("/"); auto operation = [&dir] () { dir->createDir("childname", S_IFDIR, 1000, 1000); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); }*/ TYPED_TEST_P(FsppDirTest_Timestamps, createDir_TimestampsOfCreatedDir) { auto dir = this->CreateDir("/mydir"); timespec lowerBound = now(); dir->createDir("childname", S_IFDIR, 1000, 1000); timespec upperBound = now(); auto child = this->LoadDir("/mydir/childname"); this->EXPECT_ACCESS_TIMESTAMP_BETWEEN (lowerBound, upperBound, *child); this->EXPECT_MODIFICATION_TIMESTAMP_BETWEEN (lowerBound, upperBound, *child); this->EXPECT_METADATACHANGE_TIMESTAMP_BETWEEN(lowerBound, upperBound, *child); } TYPED_TEST_P(FsppDirTest_Timestamps, createSymlink) { auto dir = this->CreateDir("/mydir"); auto operation = [&dir] () { dir->createSymlink("childname", "/target", 1000, 1000); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } /* TODO Re-enable this test once the root dir handles timestamps correctly TYPED_TEST_P(FsppDirTest_Timestamps, createSymlink_inRootDir) { auto dir = this->LoadDir("/"); auto operation = [&dir] () { dir->createSymlink("childname", "/target", 1000, 1000); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); }*/ TYPED_TEST_P(FsppDirTest_Timestamps, createSymlink_TimestampsOfCreatedSymlink) { auto dir = this->CreateDir("/mydir"); timespec lowerBound = now(); dir->createSymlink("childname", "/target", 1000, 1000); timespec upperBound = now(); auto child = this->LoadSymlink("/mydir/childname"); this->EXPECT_ACCESS_TIMESTAMP_BETWEEN (lowerBound, upperBound, *child); this->EXPECT_MODIFICATION_TIMESTAMP_BETWEEN (lowerBound, upperBound, *child); this->EXPECT_METADATACHANGE_TIMESTAMP_BETWEEN(lowerBound, upperBound, *child); } TYPED_TEST_P(FsppDirTest_Timestamps, children_empty) { auto dir = this->CreateDir("/mydir"); auto operation = [&dir] () { dir->children(); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectUpdatesAccessTimestamp, this->ExpectDoesntUpdateModificationTimestamp, this->ExpectDoesntUpdateMetadataTimestamp}); } /* TODO Re-enable this test once the root dir handles timestamps correctly TYPED_TEST_P(FsppDirTest_Timestamps, children_empty_inRootDir) { auto dir = this->LoadDir("/"); auto operation = [&dir] () { dir->children(); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectUpdatesAccessTimestamp, this->ExpectDoesntUpdateModificationTimestamp, this->ExpectDoesntUpdateMetadataTimestamp}); }*/ TYPED_TEST_P(FsppDirTest_Timestamps, children_nonempty) { auto dir = this->CreateDir("/mydir"); dir->createAndOpenFile("filename", S_IFREG, 1000, 1000); auto operation = [&dir] () { dir->children(); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectUpdatesAccessTimestamp, this->ExpectDoesntUpdateModificationTimestamp, this->ExpectDoesntUpdateMetadataTimestamp}); } /* TODO Re-enable this test once the root dir handles timestamps correctly TYPED_TEST_P(FsppDirTest_Timestamps, children_nonempty_inRootDir) { auto dir = this->LoadDir("/"); dir->createAndOpenFile("filename", S_IFREG, 1000, 1000); auto operation = [&dir] () { dir->children(); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectUpdatesAccessTimestamp, this->ExpectDoesntUpdateModificationTimestamp, this->ExpectDoesntUpdateMetadataTimestamp}); }*/ template class FsppDirTest_Timestamps_Entries: public FsppNodeTest, public TimestampTestUtils { public: void Test_deleteChild() { auto dir = this->CreateDir("/mydir"); auto child = this->CreateNode("/mydir/childname"); auto operation = [&child]() { child->remove(); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } /* TODO Re-enable this test once the root dir handles timestamps correctly void Test_deleteChild_inRootDir() { auto dir = this->LoadDir("/"); auto child = this->CreateNode("/childname"); auto operation = [&child] () { child->remove(); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); }*/ void Test_renameChild() { auto dir = this->CreateDir("/mydir"); auto child = this->CreateNode("/mydir/childname"); auto operation = [&child]() { child->rename("/mydir/mychild"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } /* TODO Re-enable this test once the root dir handles timestamps correctly void Test_renameChild_inRootDir() { auto dir = this->LoadDir("/"); auto child = this->CreateNode("/childname"); auto operation = [&child] () { child->rename("/mydir/mychild"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); }*/ void Test_moveChildIn() { auto sourceDir = this->CreateDir("/sourcedir"); auto child = this->CreateNode("/sourcedir/childname"); auto dir = this->CreateDir("/mydir"); auto operation = [&child]() { child->rename("/mydir/mychild"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } /* TODO Re-enable this test once the root dir handles timestamps correctly void Test_moveChildIn_inRootDir() { auto sourceDir = this->CreateDir("/sourcedir"); auto child = this->CreateNode("/sourcedir/childname"); auto dir = this->LoadDir("/"); auto operation = [&child] () { child->rename("/mychild"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); }*/ void Test_moveChildOut() { auto dir = this->CreateDir("/mydir"); auto child = this->CreateNode("/mydir/childname"); this->CreateDir("/targetdir"); auto operation = [&child]() { child->rename("/targetdir/mychild"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } /* TODO Re-enable this test once the root dir handles timestamps correctly void Test_moveChildOut_inRootDir() { auto dir = this->LoadDir("/"); auto child = this->CreateNode("/childname"); this->CreateDir("/targetdir"); auto operation = [&child] () { child->rename("/targetdir/mychild"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*dir, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); }*/ }; REGISTER_TYPED_TEST_CASE_P(FsppDirTest_Timestamps, createAndOpenFile, createAndOpenFile_TimestampsOfCreatedFile, createDir, createDir_TimestampsOfCreatedDir, createSymlink, createSymlink_TimestampsOfCreatedSymlink, children_empty, children_nonempty ); REGISTER_NODE_TEST_CASE(FsppDirTest_Timestamps_Entries, deleteChild, renameChild, moveChildIn, moveChildOut ); #endif src/fspp/fstest/FsppFileTest.h000066400000000000000000000133721300002025200166340ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPFILETEST_H_ #define MESSMER_FSPP_FSTEST_FSPPFILETEST_H_ #include #include #include "testutils/FileTest.h" template class FsppFileTest: public FileTest { public: void Test_Open_RDONLY(fspp::File *file) { file->open(O_RDONLY); } void Test_Open_WRONLY(fspp::File *file) { file->open(O_WRONLY); } void Test_Open_RDWR(fspp::File *file) { file->open(O_RDONLY); } void Test_Truncate_DontChange1(fspp::File *file) { file->truncate(0); this->EXPECT_SIZE(0, file); } void Test_Truncate_GrowTo1(fspp::File *file) { file->truncate(1); this->EXPECT_SIZE(1, file); } void Test_Truncate_Grow(fspp::File *file) { file->truncate(10*1024*1024); this->EXPECT_SIZE(10*1024*1024, file); } void Test_Truncate_DontChange2(fspp::File *file) { file->truncate(10*1024*1024); file->truncate(10*1024*1024); this->EXPECT_SIZE(10*1024*1024, file); } void Test_Truncate_Shrink(fspp::File *file) { file->truncate(10*1024*1024); file->truncate(5*1024*1024); this->EXPECT_SIZE(5*1024*1024, file); } void Test_Truncate_ShrinkTo0(fspp::File *file) { file->truncate(10*1024*1024); file->truncate(0); this->EXPECT_SIZE(0, file); } void Test_Chown_Uid(fspp::File *file) { file->chown(100, 200); this->IN_STAT(file, [] (struct stat st){ EXPECT_EQ(100u, st.st_uid); }); } void Test_Chown_Gid(fspp::File *file) { file->chown(100, 200); this->IN_STAT(file, [] (struct stat st){ EXPECT_EQ(200u, st.st_gid); }); } void Test_Chmod(fspp::File *file) { file->chmod(S_IFREG | S_IRUSR | S_IWOTH); this->IN_STAT(file, [] (struct stat st){ EXPECT_EQ((mode_t)(S_IFREG | S_IRUSR | S_IWOTH), st.st_mode); }); } void Test_Utimens(fspp::File *file) { struct timespec ATIME; ATIME.tv_sec = 1458086400; ATIME.tv_nsec = 34525; struct timespec MTIME; MTIME.tv_sec = 1458086300; MTIME.tv_nsec = 48293; file->utimens(ATIME, MTIME); this->IN_STAT(file, [this, ATIME, MTIME] (struct stat st) { this->EXPECT_ATIME_EQ(ATIME, st); this->EXPECT_MTIME_EQ(MTIME, st); }); } }; TYPED_TEST_CASE_P(FsppFileTest); TYPED_TEST_P(FsppFileTest, Open_RDONLY) { this->Test_Open_RDONLY(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Open_RDONLY_Nested) { this->Test_Open_RDONLY(this->file_nested.get()); } TYPED_TEST_P(FsppFileTest, Open_WRONLY) { this->Test_Open_WRONLY(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Open_WRONLY_Nested) { this->Test_Open_WRONLY(this->file_nested.get()); } TYPED_TEST_P(FsppFileTest, Open_RDWR) { this->Test_Open_RDWR(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Open_RDWR_Nested) { this->Test_Open_RDWR(this->file_nested.get()); } TYPED_TEST_P(FsppFileTest, Truncate_DontChange1) { this->Test_Truncate_DontChange1(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Truncate_DontChange1_Nested) { this->Test_Truncate_DontChange1(this->file_nested.get()); } TYPED_TEST_P(FsppFileTest, Truncate_GrowTo1) { this->Test_Truncate_GrowTo1(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Truncate_GrowTo1_Nested) { this->Test_Truncate_GrowTo1(this->file_nested.get()); } TYPED_TEST_P(FsppFileTest, Truncate_Grow) { this->Test_Truncate_Grow(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Truncate_Grow_Nested) { this->Test_Truncate_Grow(this->file_nested.get()); } TYPED_TEST_P(FsppFileTest, Truncate_DontChange2) { this->Test_Truncate_DontChange2(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Truncate_DontChange2_Nested) { this->Test_Truncate_DontChange2(this->file_nested.get()); } TYPED_TEST_P(FsppFileTest, Truncate_Shrink) { this->Test_Truncate_Shrink(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Truncate_Shrink_Nested) { this->Test_Truncate_Shrink(this->file_nested.get()); } TYPED_TEST_P(FsppFileTest, Truncate_ShrinkTo0) { this->Test_Truncate_ShrinkTo0(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Truncate_ShrinkTo0_Nested) { this->Test_Truncate_ShrinkTo0(this->file_nested.get()); } TYPED_TEST_P(FsppFileTest, Chown_Uid) { this->Test_Chown_Uid(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Chown_Uid_Nested) { this->Test_Chown_Uid(this->file_nested.get()); } TYPED_TEST_P(FsppFileTest, Chown_Gid) { this->Test_Chown_Gid(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Chown_Gid_Nested) { this->Test_Chown_Gid(this->file_nested.get()); } TYPED_TEST_P(FsppFileTest, Chmod) { this->Test_Chmod(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Chmod_Nested) { this->Test_Chmod(this->file_nested.get()); } TYPED_TEST_P(FsppFileTest, Utimens) { this->Test_Utimens(this->file_root.get()); } TYPED_TEST_P(FsppFileTest, Utimens_Nested) { this->Test_Utimens(this->file_nested.get()); } REGISTER_TYPED_TEST_CASE_P(FsppFileTest, Open_RDONLY, Open_RDONLY_Nested, Open_WRONLY, Open_WRONLY_Nested, Open_RDWR, Open_RDWR_Nested, Truncate_DontChange1, Truncate_DontChange1_Nested, Truncate_GrowTo1, Truncate_GrowTo1_Nested, Truncate_Grow, Truncate_Grow_Nested, Truncate_DontChange2, Truncate_DontChange2_Nested, Truncate_Shrink, Truncate_Shrink_Nested, Truncate_ShrinkTo0, Truncate_ShrinkTo0_Nested, Chown_Uid, Chown_Uid_Nested, Chown_Gid, Chown_Gid_Nested, Chmod, Chmod_Nested, Utimens, Utimens_Nested ); //TODO access //TODO unlink //TODO Test all operations do (or don't) affect file timestamps correctly (including rename, which shouldn't modify access/modify time, but inode change time) //TODO Move applicable test cases to new instances of FsppNodeTest (like FsppNodeTest_Rename) (e.g. utimens, chmod, ...) //TODO access //TODO utimens //TODO chmod //TODO chown #endif src/fspp/fstest/FsppFileTest_Timestamps.h000066400000000000000000000076411300002025200210440ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPFILETEST_TIMESTAMPS_H_ #define MESSMER_FSPP_FSTEST_FSPPFILETEST_TIMESTAMPS_H_ #include "testutils/TimestampTestUtils.h" template class FsppFileTest_Timestamps: public FileSystemTest, public TimestampTestUtils { public: cpputils::unique_ref CreateFileWithSize(const boost::filesystem::path &path, off_t size) { auto file = this->CreateFile(path); file->truncate(size); assert(stat(*file).st_size == size); return file; } }; TYPED_TEST_CASE_P(FsppFileTest_Timestamps); TYPED_TEST_P(FsppFileTest_Timestamps, open_nomode) { auto file = this->CreateFile("/myfile"); auto operation = [&file] () { file->open(0); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*file, operation, {this->ExpectDoesntUpdateAnyTimestamps}); } TYPED_TEST_P(FsppFileTest_Timestamps, open_rdonly) { auto file = this->CreateFile("/myfile"); auto operation = [&file] () { file->open(O_RDONLY); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*file, operation, {this->ExpectDoesntUpdateAnyTimestamps}); } TYPED_TEST_P(FsppFileTest_Timestamps, open_wronly) { auto file = this->CreateFile("/myfile"); auto operation = [&file] () { file->open(O_WRONLY); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*file, operation, {this->ExpectDoesntUpdateAnyTimestamps}); } TYPED_TEST_P(FsppFileTest_Timestamps, open_rdwr) { auto file = this->CreateFile("/myfile"); auto operation = [&file] () { file->open(O_RDWR); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*file, operation, {this->ExpectDoesntUpdateAnyTimestamps}); } TYPED_TEST_P(FsppFileTest_Timestamps, truncate_empty_to_empty) { auto file = this->CreateFileWithSize("/myfile", 0); auto operation = [&file] () { file->truncate(0); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*file, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } TYPED_TEST_P(FsppFileTest_Timestamps, truncate_empty_to_nonempty) { auto file = this->CreateFileWithSize("/myfile", 0); auto operation = [&file] () { file->truncate(10); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*file, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } TYPED_TEST_P(FsppFileTest_Timestamps, truncate_nonempty_to_empty) { auto file = this->CreateFileWithSize("/myfile", 10); auto operation = [&file] () { file->truncate(0); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*file, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } TYPED_TEST_P(FsppFileTest_Timestamps, truncate_nonempty_to_nonempty_shrink) { auto file = this->CreateFileWithSize("/myfile", 10); auto operation = [&file] () { file->truncate(5); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*file, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } TYPED_TEST_P(FsppFileTest_Timestamps, truncate_nonempty_to_nonempty_grow) { auto file = this->CreateFileWithSize("/myfile", 10); auto operation = [&file] () { file->truncate(20); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*file, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } REGISTER_TYPED_TEST_CASE_P(FsppFileTest_Timestamps, open_nomode, open_rdonly, open_wronly, open_rdwr, truncate_empty_to_empty, truncate_empty_to_nonempty, truncate_nonempty_to_empty, truncate_nonempty_to_nonempty_shrink, truncate_nonempty_to_nonempty_grow ); #endif src/fspp/fstest/FsppNodeTest_Rename.h000066400000000000000000000216521300002025200201310ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPNODETEST_RENAME_H_ #define MESSMER_FSPP_FSTEST_FSPPNODETEST_RENAME_H_ #include "testutils/FsppNodeTest.h" #include "../fuse/FuseErrnoException.h" template class FsppNodeTest_Rename: public FsppNodeTest { public: void Test_Error_TargetParentDirDoesntExist() { auto node = this->CreateNode("/oldname"); try { node->rename("/notexistingdir/newname"); EXPECT_TRUE(false); // Expect it throws an exception } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(ENOENT, e.getErrno()); } //Old file should still exist EXPECT_NE(boost::none, this->device->Load("/oldname")); } void Test_Error_TargetParentDirIsFile() { auto node = this->CreateNode("/oldname"); this->CreateFile("/somefile"); try { node->rename("/somefile/newname"); EXPECT_TRUE(false); // Expect it throws an exception } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(ENOTDIR, e.getErrno()); } //Files should still exist EXPECT_NE(boost::none, this->device->Load("/oldname")); EXPECT_NE(boost::none, this->device->Load("/somefile")); } void Test_Error_RootDir() { auto root = this->LoadDir("/"); try { root->rename("/newname"); EXPECT_TRUE(false); // expect throws } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(EBUSY, e.getErrno()); } } void Test_InRoot() { auto node = this->CreateNode("/oldname"); node->rename("/newname"); EXPECT_EQ(boost::none, this->device->Load("/oldname")); EXPECT_NE(boost::none, this->device->Load("/newname")); } void Test_InNested() { this->CreateDir("/mydir"); auto node = this->CreateNode("/mydir/oldname"); node->rename("/mydir/newname"); EXPECT_EQ(boost::none, this->device->Load("/mydir/oldname")); EXPECT_NE(boost::none, this->device->Load("/mydir/newname")); } void Test_RootToNested_SameName() { this->CreateDir("/mydir"); auto node = this->CreateNode("/oldname"); node->rename("/mydir/oldname"); EXPECT_EQ(boost::none, this->device->Load("/oldname")); EXPECT_NE(boost::none, this->device->Load("/mydir/oldname")); } void Test_RootToNested_NewName() { this->CreateDir("/mydir"); auto node = this->CreateNode("/oldname"); node->rename("/mydir/newname"); EXPECT_EQ(boost::none, this->device->Load("/oldname")); EXPECT_NE(boost::none, this->device->Load("/mydir/newname")); } void Test_NestedToRoot_SameName() { this->CreateDir("/mydir"); auto node = this->CreateNode("/mydir/oldname"); node->rename("/oldname"); EXPECT_EQ(boost::none, this->device->Load("/mydir/oldname")); EXPECT_NE(boost::none, this->device->Load("/oldname")); } void Test_NestedToRoot_NewName() { this->CreateDir("/mydir"); auto node = this->CreateNode("/mydir/oldname"); node->rename("/newname"); EXPECT_EQ(boost::none, this->device->Load("/mydir/oldname")); EXPECT_NE(boost::none, this->device->Load("/newname")); } void Test_NestedToNested_SameName() { this->CreateDir("/mydir"); this->CreateDir("/mydir2"); auto node = this->CreateNode("/mydir/oldname"); node->rename("/mydir2/oldname"); EXPECT_EQ(boost::none, this->device->Load("/mydir/oldname")); EXPECT_NE(boost::none, this->device->Load("/mydir2/oldname")); } void Test_NestedToNested_NewName() { this->CreateDir("/mydir"); this->CreateDir("/mydir2"); auto node = this->CreateNode("/mydir/oldname"); node->rename("/mydir2/newname"); EXPECT_EQ(boost::none, this->device->Load("/mydir/oldname")); EXPECT_NE(boost::none, this->device->Load("/mydir2/newname")); } void Test_ToItself() { auto node = this->CreateNode("/oldname"); node->rename("/oldname"); EXPECT_NE(boost::none, this->device->Load("/oldname")); } void Test_Overwrite_InSameDir() { auto node = this->CreateNode("/oldname"); this->CreateNode("/newname"); node->rename("/newname"); EXPECT_EQ(boost::none, this->device->Load("/oldname")); EXPECT_NE(boost::none, this->device->Load("/newname")); } void Test_Overwrite_InDifferentDir() { this->CreateDir("/parent1"); this->CreateDir("/parent2"); auto node = this->CreateNode("/parent1/oldname"); this->CreateNode("/parent2/newname"); node->rename("/parent2/newname"); EXPECT_EQ(boost::none, this->device->Load("/parent1/oldname")); EXPECT_NE(boost::none, this->device->Load("/parent2/newname")); } void Test_Overwrite_DoesntHaveSameEntryTwice() { auto node = this->CreateNode("/oldname"); this->CreateNode("/newname"); EXPECT_EQ(4u, this->LoadDir("/")->children()->size()); // 4, because of '.' and '..' node->rename("/newname"); EXPECT_EQ(3u, this->LoadDir("/")->children()->size()); // 3, because of '.' and '..' } void Test_Overwrite_Error_DirWithFile_InSameDir() { auto file = this->CreateFile("/oldname"); this->CreateDir("/newname"); try { file->rename("/newname"); EXPECT_TRUE(false); // expect throw } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(EISDIR, e.getErrno()); } EXPECT_NE(boost::none, this->device->Load("/oldname")); EXPECT_NE(boost::none, this->device->Load("/newname")); } void Test_Overwrite_Error_DirWithFile_InDifferentDir() { this->CreateDir("/parent1"); this->CreateDir("/parent2"); auto file = this->CreateFile("/parent1/oldname"); this->CreateDir("/parent2/newname"); try { file->rename("/parent2/newname"); EXPECT_TRUE(false); // expect throw } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(EISDIR, e.getErrno()); } EXPECT_NE(boost::none, this->device->Load("/parent1/oldname")); EXPECT_NE(boost::none, this->device->Load("/parent2/newname")); } void Test_Overwrite_Error_FileWithDir_InSameDir() { auto dir = this->CreateDir("/oldname"); this->CreateFile("/newname"); try { dir->rename("/newname"); EXPECT_TRUE(false); // expect throw } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(ENOTDIR, e.getErrno()); } EXPECT_NE(boost::none, this->device->Load("/oldname")); EXPECT_NE(boost::none, this->device->Load("/newname")); } void Test_Overwrite_Error_FileWithDir_InDifferentDir() { this->CreateDir("/parent1"); this->CreateDir("/parent2"); auto dir = this->CreateDir("/parent1/oldname"); this->CreateFile("/parent2/newname"); try { dir->rename("/parent2/newname"); EXPECT_TRUE(false); // expect throw } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(ENOTDIR, e.getErrno()); } EXPECT_NE(boost::none, this->device->Load("/parent1/oldname")); EXPECT_NE(boost::none, this->device->Load("/parent2/newname")); } void Test_CanRenameTwice() { // Test that the node object stays valid after a rename, even if it now points to an entry of a different parent directory. this->CreateDir("/mydir1"); this->CreateDir("/mydir2"); auto node = this->CreateNode("/oldname"); node->rename("/mydir1/newname"); node->rename("/mydir2/newname"); EXPECT_EQ(boost::none, this->device->Load("/oldname")); EXPECT_EQ(boost::none, this->device->Load("/mydir1/newname")); EXPECT_NE(boost::none, this->device->Load("/mydir2/newname")); } }; REGISTER_NODE_TEST_CASE(FsppNodeTest_Rename, Error_TargetParentDirDoesntExist, Error_TargetParentDirIsFile, Error_RootDir, InRoot, InNested, RootToNested_SameName, RootToNested_NewName, NestedToRoot_SameName, NestedToRoot_NewName, NestedToNested_SameName, NestedToNested_NewName, ToItself, Overwrite_InSameDir, Overwrite_InDifferentDir, Overwrite_DoesntHaveSameEntryTwice, Overwrite_Error_DirWithFile_InSameDir, Overwrite_Error_DirWithFile_InDifferentDir, Overwrite_Error_FileWithDir_InSameDir, Overwrite_Error_FileWithDir_InDifferentDir, CanRenameTwice ); #endif //TODO Test for rename (success AND error cases) that stat values stay unchanged (i.e. mode, uid, gid, access times, ...) //TODO Test for rename (success AND error cases) that contents stay unchanged (i.e. file contents, directory children, symlink target) //TODO (here and in other fstest operations): Test error paths src/fspp/fstest/FsppNodeTest_Stat.h000066400000000000000000000045451300002025200176370ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPNODETEST_STAT_H_ #define MESSMER_FSPP_FSTEST_FSPPNODETEST_STAT_H_ #include "testutils/FsppNodeTest.h" #include "../fuse/FuseErrnoException.h" template class FsppNodeTest_Stat: public FsppNodeTest { public: void Test_Nlink() { auto node = this->CreateNode("/mynode"); this->IN_STAT(node.get(), [] (struct stat st) { EXPECT_EQ(1u, st.st_nlink); }); } }; // Test cases only run for file nodes template class FsppNodeTest_Stat_FileOnly: public FileSystemTest, public FsppNodeTest_File_Helper {}; TYPED_TEST_CASE_P(FsppNodeTest_Stat_FileOnly); TYPED_TEST_P(FsppNodeTest_Stat_FileOnly, CreatedFileIsEmpty) { auto file = this->CreateFile("/myfile"); this->EXPECT_SIZE(0, file.get()); } TYPED_TEST_P(FsppNodeTest_Stat_FileOnly, FileIsFile) { auto file = this->CreateFile("/myfile"); this->IN_STAT(file.get(), [] (struct stat st) { EXPECT_TRUE(S_ISREG(st.st_mode)); }); } // Test cases only run for dir nodes template class FsppNodeTest_Stat_DirOnly: public FileSystemTest, public FsppNodeTest_Dir_Helper {}; TYPED_TEST_CASE_P(FsppNodeTest_Stat_DirOnly); TYPED_TEST_P(FsppNodeTest_Stat_DirOnly, DirIsDir) { auto file = this->CreateDir("/mydir"); this->IN_STAT(file.get(), [] (struct stat st) { EXPECT_TRUE(S_ISDIR(st.st_mode)); }); } // Test cases only run for symlink nodes template class FsppNodeTest_Stat_SymlinkOnly: public FileSystemTest, public FsppNodeTest_Symlink_Helper {}; TYPED_TEST_CASE_P(FsppNodeTest_Stat_SymlinkOnly); TYPED_TEST_P(FsppNodeTest_Stat_SymlinkOnly, SymlinkIsSymlink) { auto file = this->CreateSymlink("/mysymlink"); this->IN_STAT(file.get(), [] (struct stat st) { EXPECT_TRUE(S_ISLNK(st.st_mode)); }); } REGISTER_NODE_TEST_CASE(FsppNodeTest_Stat, Nlink ); REGISTER_TYPED_TEST_CASE_P(FsppNodeTest_Stat_FileOnly, CreatedFileIsEmpty, FileIsFile ); REGISTER_TYPED_TEST_CASE_P(FsppNodeTest_Stat_DirOnly, DirIsDir ); REGISTER_TYPED_TEST_CASE_P(FsppNodeTest_Stat_SymlinkOnly, SymlinkIsSymlink ); #endif //TODO More test cases src/fspp/fstest/FsppNodeTest_Timestamps.h000066400000000000000000000303431300002025200210450ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPNODETEST_TIMESTAMPS_H_ #define MESSMER_FSPP_FSTEST_FSPPNODETEST_TIMESTAMPS_H_ #include "testutils/FsppNodeTest.h" #include "../fuse/FuseErrnoException.h" #include "testutils/TimestampTestUtils.h" #include using namespace cpputils::time; using std::function; template class FsppNodeTest_Timestamps: public FsppNodeTest, public TimestampTestUtils { public: void Test_Create() { timespec lowerBound = now(); auto node = this->CreateNode("/mynode"); timespec upperBound = now(); EXPECT_ACCESS_TIMESTAMP_BETWEEN (lowerBound, upperBound, *node); EXPECT_MODIFICATION_TIMESTAMP_BETWEEN (lowerBound, upperBound, *node); EXPECT_METADATACHANGE_TIMESTAMP_BETWEEN(lowerBound, upperBound, *node); } void Test_Stat() { auto node = this->CreateNode("/mynode"); auto operation = [&node] () { struct stat st; node->stat(&st); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAnyTimestamps}); } void Test_Chmod() { auto node = this->CreateNode("/mynode"); mode_t mode = stat(*node).st_mode; auto operation = [&node, mode] () { node->chmod(mode); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Chown() { auto node = this->CreateNode("/mynode"); uid_t uid = stat(*node).st_uid; gid_t gid = stat(*node).st_gid; auto operation = [&node, uid, gid] () { node->chown(uid, gid); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Access() { auto node = this->CreateNode("/mynode"); auto operation = [&node] () { node->access(0); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAnyTimestamps}); } void Test_Rename_Error_TargetParentDirDoesntExist() { auto node = this->CreateNode("/oldname"); auto operation = [&node] () { try { node->rename("/notexistingdir/newname"); EXPECT_TRUE(false); // expect rename to fail } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(ENOENT, e.getErrno()); //Rename fails, everything is ok. } }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAnyTimestamps}); } void Test_Rename_Error_TargetParentDirIsFile() { auto node = this->CreateNode("/oldname"); this->CreateFile("/somefile"); auto operation = [&node] () { try { node->rename("/somefile/newname"); EXPECT_TRUE(false); // expect rename to fail } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(ENOTDIR, e.getErrno()); //Rename fails, everything is ok. } }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAnyTimestamps}); } void Test_Rename_Error_RootDir() { // TODO Re-enable this test once the root dir stores timestamps correctly /* auto root = this->LoadDir("/"); auto operation = [&root] () { try { root->rename("/newname"); EXPECT_TRUE(false); // expect throws } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(EBUSY, e.getErrno()); //Rename fails, everything is ok. } }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAnyTimestamps}); */ } void Test_Rename_InRoot() { auto node = this->CreateNode("/oldname"); auto operation = [&node] () { node->rename("/newname"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Rename_InNested() { this->CreateDir("/mydir"); auto node = this->CreateNode("/mydir/oldname"); auto operation = [&node] () { node->rename("/mydir/newname"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Rename_RootToNested_SameName() { this->CreateDir("/mydir"); auto node = this->CreateNode("/oldname"); auto operation = [&node] () { node->rename("/mydir/oldname"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Rename_RootToNested_NewName() { this->CreateDir("/mydir"); auto node = this->CreateNode("/oldname"); auto operation = [&node] () { node->rename("/mydir/newname"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Rename_NestedToRoot_SameName() { this->CreateDir("/mydir"); auto node = this->CreateNode("/mydir/oldname"); auto operation = [&node] () { node->rename("/oldname"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Rename_NestedToRoot_NewName() { this->CreateDir("/mydir"); auto node = this->CreateNode("/mydir/oldname"); auto operation = [&node] () { node->rename("/newname"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Rename_NestedToNested_SameName() { this->CreateDir("/mydir1"); this->CreateDir("/mydir2"); auto node = this->CreateNode("/mydir1/oldname"); auto operation = [&node] () { node->rename("/mydir2/oldname"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Rename_NestedToNested_NewName() { this->CreateDir("/mydir1"); this->CreateDir("/mydir2"); auto node = this->CreateNode("/mydir1/oldname"); auto operation = [&node] () { node->rename("/mydir2/newname"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Rename_ToItself() { auto node = this->CreateNode("/oldname"); auto operation = [&node] () { node->rename("/oldname"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Rename_Overwrite_InSameDir() { auto node = this->CreateNode("/oldname"); this->CreateNode("/newname"); auto operation = [&node] () { node->rename("/newname"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Rename_Overwrite_InDifferentDir() { this->CreateDir("/mydir1"); this->CreateDir("/mydir2"); this->CreateNode("/mydir2/newname"); auto node = this->CreateNode("/mydir1/oldname"); auto operation = [&node] () { node->rename("/mydir2/newname"); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAccessTimestamp, ExpectDoesntUpdateModificationTimestamp, ExpectUpdatesMetadataTimestamp}); } void Test_Rename_Overwrite_Error_DirWithFile_InSameDir() { auto node = this->CreateFile("/oldname"); this->CreateDir("/newname"); auto operation = [&node] () { try { node->rename("/newname"); EXPECT_TRUE(false); // expect rename to fail } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(EISDIR, e.getErrno()); //Rename fails, everything is ok. } }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAnyTimestamps}); } void Test_Rename_Overwrite_Error_DirWithFile_InDifferentDir() { this->CreateDir("/mydir1"); this->CreateDir("/mydir2"); auto node = this->CreateFile("/mydir1/oldname"); this->CreateDir("/mydir2/newname"); auto operation = [&node] () { try { node->rename("/mydir2/newname"); EXPECT_TRUE(false); // expect rename to fail } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(EISDIR, e.getErrno());//Rename fails, everything is ok. } }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAnyTimestamps}); } void Test_Rename_Overwrite_Error_FileWithDir_InSameDir() { auto node = this->CreateDir("/oldname"); this->CreateFile("/newname"); auto operation = [&node] () { try { node->rename("/newname"); EXPECT_TRUE(false); // expect rename to fail } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(ENOTDIR, e.getErrno()); //Rename fails, everything is ok. } }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAnyTimestamps}); } void Test_Rename_Overwrite_Error_FileWithDir_InDifferentDir() { this->CreateDir("/mydir1"); this->CreateDir("/mydir2"); auto node = this->CreateDir("/mydir1/oldname"); this->CreateFile("/mydir2/newname"); auto operation = [&node] () { try { node->rename("/mydir2/newname"); EXPECT_TRUE(false); // expect rename to fail } catch (const fspp::fuse::FuseErrnoException &e) { EXPECT_EQ(ENOTDIR, e.getErrno()); //Rename fails, everything is ok. } }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectDoesntUpdateAnyTimestamps}); } void Test_Utimens() { auto node = this->CreateNode("/mynode"); timespec atime = xSecondsAgo(100); timespec mtime = xSecondsAgo(200); auto operation = [&node, atime, mtime] () { node->utimens(atime, mtime); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*node, operation, {ExpectUpdatesMetadataTimestamp}); EXPECT_EQ(atime, stat(*node).st_atim); EXPECT_EQ(mtime, stat(*node).st_mtim); } }; REGISTER_NODE_TEST_CASE(FsppNodeTest_Timestamps, Create, Stat, Chmod, Chown, Access, Rename_Error_TargetParentDirDoesntExist, Rename_Error_TargetParentDirIsFile, Rename_Error_RootDir, Rename_InRoot, Rename_InNested, Rename_RootToNested_SameName, Rename_RootToNested_NewName, Rename_NestedToRoot_SameName, Rename_NestedToRoot_NewName, Rename_NestedToNested_SameName, Rename_NestedToNested_NewName, Rename_ToItself, Rename_Overwrite_InSameDir, Rename_Overwrite_InDifferentDir, Rename_Overwrite_Error_DirWithFile_InSameDir, Rename_Overwrite_Error_DirWithFile_InDifferentDir, Rename_Overwrite_Error_FileWithDir_InSameDir, Rename_Overwrite_Error_FileWithDir_InDifferentDir, Utimens ); #endif src/fspp/fstest/FsppOpenFileTest.h000066400000000000000000000013401300002025200174460ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPOPENFILETEST_H_ #define MESSMER_FSPP_FSTEST_FSPPOPENFILETEST_H_ #include "testutils/FileTest.h" template class FsppOpenFileTest: public FileTest { public: }; TYPED_TEST_CASE_P(FsppOpenFileTest); TYPED_TEST_P(FsppOpenFileTest, Bla) { //TODO } REGISTER_TYPED_TEST_CASE_P(FsppOpenFileTest, Bla ); //TODO Test stat //TODO Test truncate //TODO Test read //TODO Test write //TODO Test flush //TODO Test fsync //TODO Test fdatasync //TODO Test stat on file that was just created (i.e. the OpenFile instance returned by createAndOpenFile) //TODO Test all operations do (or don't) affect file timestamps correctly #endif src/fspp/fstest/FsppOpenFileTest_Timestamps.h000066400000000000000000000143601300002025200216620ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPOPENFILETEST_TIMESTAMPS_H_ #define MESSMER_FSPP_FSTEST_FSPPOPENFILETEST_TIMESTAMPS_H_ #include "testutils/TimestampTestUtils.h" template class FsppOpenFileTest_Timestamps: public FileSystemTest, public TimestampTestUtils { public: cpputils::unique_ref CreateAndOpenFile(const boost::filesystem::path &path) { return this->CreateFile(path)->open(O_RDWR); } cpputils::unique_ref CreateAndOpenFileWithSize(const boost::filesystem::path &path, off_t size) { auto file = this->CreateFile(path); file->truncate(size); auto openFile = file->open(O_RDWR); assert(stat(*openFile).st_size == size); return openFile; } }; TYPED_TEST_CASE_P(FsppOpenFileTest_Timestamps); TYPED_TEST_P(FsppOpenFileTest_Timestamps, stat) { auto openFile = this->CreateAndOpenFile("/mynode"); auto operation = [&openFile] () { struct ::stat st; openFile->stat(&st); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectDoesntUpdateAnyTimestamps}); } TYPED_TEST_P(FsppOpenFileTest_Timestamps, truncate_empty_to_empty) { auto openFile = this->CreateAndOpenFileWithSize("/myfile", 0); auto operation = [&openFile] () { openFile->truncate(0); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } TYPED_TEST_P(FsppOpenFileTest_Timestamps, truncate_empty_to_nonempty) { auto openFile = this->CreateAndOpenFileWithSize("/myfile", 0); auto operation = [&openFile] () { openFile->truncate(10); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } TYPED_TEST_P(FsppOpenFileTest_Timestamps, truncate_nonempty_to_empty) { auto openFile = this->CreateAndOpenFileWithSize("/myfile", 10); auto operation = [&openFile] () { openFile->truncate(0); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } TYPED_TEST_P(FsppOpenFileTest_Timestamps, truncate_nonempty_to_nonempty_shrink) { auto openFile = this->CreateAndOpenFileWithSize("/myfile", 10); auto operation = [&openFile] () { openFile->truncate(5); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } TYPED_TEST_P(FsppOpenFileTest_Timestamps, truncate_nonempty_to_nonempty_grow) { auto openFile = this->CreateAndOpenFileWithSize("/myfile", 10); auto operation = [&openFile] () { openFile->truncate(20); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } TYPED_TEST_P(FsppOpenFileTest_Timestamps, read_inbounds) { auto openFile = this->CreateAndOpenFileWithSize("/myfile", 10); auto operation = [&openFile] () { char buffer[5]; openFile->read(buffer, 5, 0); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectUpdatesAccessTimestamp, this->ExpectDoesntUpdateModificationTimestamp, this->ExpectDoesntUpdateMetadataTimestamp}); } TYPED_TEST_P(FsppOpenFileTest_Timestamps, read_outofbounds) { auto openFile = this->CreateAndOpenFileWithSize("/myfile", 0); auto operation = [&openFile] () { char buffer[5]; openFile->read(buffer, 5, 2); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectUpdatesAccessTimestamp, this->ExpectDoesntUpdateModificationTimestamp, this->ExpectDoesntUpdateMetadataTimestamp}); } TYPED_TEST_P(FsppOpenFileTest_Timestamps, write_inbounds) { auto openFile = this->CreateAndOpenFileWithSize("/myfile", 10); auto operation = [&openFile] () { openFile->write("content", 7, 0); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } TYPED_TEST_P(FsppOpenFileTest_Timestamps, write_outofbounds) { auto openFile = this->CreateAndOpenFileWithSize("/myfile", 0); auto operation = [&openFile] () { openFile->write("content", 7, 2); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectDoesntUpdateAccessTimestamp, this->ExpectUpdatesModificationTimestamp, this->ExpectUpdatesMetadataTimestamp}); } TYPED_TEST_P(FsppOpenFileTest_Timestamps, flush) { auto openFile = this->CreateAndOpenFileWithSize("/myfile", 10); openFile->write("content", 7, 0); auto operation = [&openFile] () { openFile->flush(); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectDoesntUpdateAnyTimestamps}); } TYPED_TEST_P(FsppOpenFileTest_Timestamps, fsync) { auto openFile = this->CreateAndOpenFileWithSize("/myfile", 10); openFile->write("content", 7, 0); auto operation = [&openFile] () { openFile->fsync(); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectDoesntUpdateAnyTimestamps}); } TYPED_TEST_P(FsppOpenFileTest_Timestamps, fdatasync) { auto openFile = this->CreateAndOpenFileWithSize("/myfile", 10); openFile->write("content", 7, 0); auto operation = [&openFile] () { openFile->fdatasync(); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*openFile, operation, {this->ExpectDoesntUpdateAnyTimestamps}); } REGISTER_TYPED_TEST_CASE_P(FsppOpenFileTest_Timestamps, stat, truncate_empty_to_empty, truncate_empty_to_nonempty, truncate_nonempty_to_empty, truncate_nonempty_to_nonempty_shrink, truncate_nonempty_to_nonempty_grow, read_inbounds, read_outofbounds, write_inbounds, write_outofbounds, flush, fsync, fdatasync ); #endif src/fspp/fstest/FsppSymlinkTest.h000066400000000000000000000031111300002025200173710ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPSYMLINKTEST_H_ #define MESSMER_FSPP_FSTEST_FSPPSYMLINKTEST_H_ #include #include #include "testutils/FileSystemTest.h" template class FsppSymlinkTest: public FileSystemTest { public: void CreateSymlink(const std::string &source, const boost::filesystem::path &target) { this->LoadDir("/")->createSymlink(source, target, 0, 0); } }; TYPED_TEST_CASE_P(FsppSymlinkTest); TYPED_TEST_P(FsppSymlinkTest, Create_AbsolutePath) { this->CreateSymlink("mysymlink", "/my/symlink/target"); } TYPED_TEST_P(FsppSymlinkTest, Create_RelativePath) { this->CreateSymlink("mysymlink", "../target"); } TYPED_TEST_P(FsppSymlinkTest, Read_AbsolutePath) { this->CreateSymlink("mysymlink", "/my/symlink/target"); EXPECT_EQ("/my/symlink/target", this->LoadSymlink("/mysymlink")->target()); } TYPED_TEST_P(FsppSymlinkTest, Read_RelativePath) { this->CreateSymlink("mysymlink", "../target"); EXPECT_EQ("../target", this->LoadSymlink("/mysymlink")->target()); } TYPED_TEST_P(FsppSymlinkTest, Delete) { this->CreateSymlink("mysymlink", "/my/symlink/target"); EXPECT_NE(boost::none, this->device->Load("/mysymlink")); this->LoadSymlink("/mysymlink")->remove(); EXPECT_EQ(boost::none, this->device->Load("/mysymlink")); } REGISTER_TYPED_TEST_CASE_P(FsppSymlinkTest, Create_AbsolutePath, Create_RelativePath, Read_AbsolutePath, Read_RelativePath, Delete ); //TODO Other tests? //TODO Test all operations do (or don't) affect timestamps correctly #endif src/fspp/fstest/FsppSymlinkTest_Timestamps.h000066400000000000000000000015201300002025200216010ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_FSPPSYMLINKTEST_TIMESTAMPS_H_ #define MESSMER_FSPP_FSTEST_FSPPSYMLINKTEST_TIMESTAMPS_H_ #include "testutils/TimestampTestUtils.h" template class FsppSymlinkTest_Timestamps: public FileSystemTest, public TimestampTestUtils { public: }; TYPED_TEST_CASE_P(FsppSymlinkTest_Timestamps); TYPED_TEST_P(FsppSymlinkTest_Timestamps, target) { auto symlink = this->CreateSymlink("/mysymlink"); auto operation = [&symlink] () { symlink->target(); }; this->EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(*symlink, operation, {this->ExpectUpdatesAccessTimestamp, this->ExpectDoesntUpdateModificationTimestamp, this->ExpectDoesntUpdateMetadataTimestamp}); } REGISTER_TYPED_TEST_CASE_P(FsppSymlinkTest_Timestamps, target ); #endif src/fspp/fstest/testutils/000077500000000000000000000000001300002025200161455ustar00rootroot00000000000000src/fspp/fstest/testutils/FileSystemTest.h000066400000000000000000000054571300002025200212550ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_TESTUTILS_FILESYSTEMTEST_H_ #define MESSMER_FSPP_FSTEST_TESTUTILS_FILESYSTEMTEST_H_ #include #include #include #include #include #include "../../fs_interface/Device.h" #include "../../fs_interface/Dir.h" #include "../../fs_interface/File.h" #include "../../fs_interface/Symlink.h" #include "../../fs_interface/OpenFile.h" class FileSystemTestFixture { public: virtual ~FileSystemTestFixture() {} virtual cpputils::unique_ref createDevice() = 0; }; template class FileSystemTest: public ::testing::Test { public: BOOST_STATIC_ASSERT_MSG( (std::is_base_of::value), "Given test fixture for instantiating the (type parameterized) FileSystemTest must inherit from FileSystemTestFixture" ); FileSystemTest(): fixture(), device(fixture.createDevice()) {} ConcreteFileSystemTestFixture fixture; cpputils::unique_ref device; static constexpr mode_t MODE_PUBLIC = S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH | S_IWOTH | S_IXOTH; cpputils::unique_ref LoadDir(const boost::filesystem::path &path) { auto loaded = device->Load(path); EXPECT_NE(boost::none, loaded); auto dir = cpputils::dynamic_pointer_move(*loaded); EXPECT_NE(boost::none, dir); return std::move(*dir); } cpputils::unique_ref LoadFile(const boost::filesystem::path &path) { auto loaded = device->Load(path); EXPECT_NE(boost::none, loaded); auto file = cpputils::dynamic_pointer_move(*loaded); EXPECT_NE(boost::none, file); return std::move(*file); } cpputils::unique_ref LoadSymlink(const boost::filesystem::path &path) { auto loaded = device->Load(path); EXPECT_NE(boost::none, loaded); auto symlink = cpputils::dynamic_pointer_move(*loaded); EXPECT_NE(boost::none, symlink); return std::move(*symlink); } cpputils::unique_ref CreateDir(const boost::filesystem::path &path) { this->LoadDir(path.parent_path())->createDir(path.filename().native(), this->MODE_PUBLIC, 0, 0); return this->LoadDir(path); } cpputils::unique_ref CreateFile(const boost::filesystem::path &path) { this->LoadDir(path.parent_path())->createAndOpenFile(path.filename().native(), this->MODE_PUBLIC, 0, 0); return this->LoadFile(path); } cpputils::unique_ref CreateSymlink(const boost::filesystem::path &path) { this->LoadDir(path.parent_path())->createSymlink(path.filename().native(), "/my/symlink/target", 0, 0); return this->LoadSymlink(path); } }; #endif src/fspp/fstest/testutils/FileTest.h000066400000000000000000000042161300002025200200400ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_TESTUTILS_FILETEST_H_ #define MESSMER_FSPP_FSTEST_TESTUTILS_FILETEST_H_ #include "FileSystemTest.h" #include #include #include template class FileTest: public FileSystemTest { public: FileTest(): file_root(), file_nested() { this->LoadDir("/")->createAndOpenFile("myfile", this->MODE_PUBLIC, 0, 0); file_root = cpputils::to_unique_ptr(this->LoadFile("/myfile")); this->LoadDir("/")->createDir("mydir", this->MODE_PUBLIC, 0, 0); this->LoadDir("/mydir")->createAndOpenFile("mynestedfile", this->MODE_PUBLIC, 0, 0); file_nested = cpputils::to_unique_ptr(this->LoadFile("/mydir/mynestedfile")); this->LoadDir("/")->createDir("mydir2", this->MODE_PUBLIC, 0, 0); } std::unique_ptr file_root; std::unique_ptr file_nested; //TODO IN_STAT still needed after moving it to FsppNodeTest? void IN_STAT(fspp::File *file, std::function callback) { struct stat st1, st2; file->stat(&st1); callback(st1); file->open(O_RDONLY)->stat(&st2); callback(st2); } void EXPECT_SIZE(uint64_t expectedSize, fspp::File *file) { IN_STAT(file, [expectedSize] (struct stat st) { EXPECT_EQ(expectedSize, (uint64_t)st.st_size); }); EXPECT_NUMBYTES_READABLE(expectedSize, file); } void EXPECT_NUMBYTES_READABLE(uint64_t expectedSize, fspp::File *file) { auto openFile = file->open(O_RDONLY); cpputils::Data data(expectedSize); //Try to read one byte more than the expected size ssize_t readBytes = openFile->read(data.data(), expectedSize+1, 0); //and check that it only read the expected size (but also not less) EXPECT_EQ(expectedSize, (uint64_t)readBytes); } void EXPECT_ATIME_EQ(struct timespec expected, struct stat st) { EXPECT_EQ(expected.tv_sec, st.st_atim.tv_sec); EXPECT_EQ(expected.tv_nsec, st.st_atim.tv_nsec); } void EXPECT_MTIME_EQ(struct timespec expected, struct stat st) { EXPECT_EQ(expected.tv_sec, st.st_mtim.tv_sec); EXPECT_EQ(expected.tv_nsec, st.st_mtim.tv_nsec); } }; #endif src/fspp/fstest/testutils/FsppNodeTest.h000066400000000000000000000212351300002025200206770ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_TESTUTILS_FSPPNODETEST_H_ #define MESSMER_FSPP_FSTEST_TESTUTILS_FSPPNODETEST_H_ #include "FileSystemTest.h" #include #include #include class FsppNodeTestBase { public: virtual void IN_STAT(fspp::Node *node, std::function callback) = 0; virtual void EXPECT_SIZE(uint64_t expectedSize, fspp::Node *node) = 0; }; /** * Inherit your fixture from this class to write a test case that is run on nodes, i.e. files, directories and symlinks. * You can use this->CreateNode() to create a node and then call fspp::Node functions on it. * Add your test cases as void Test_xxx() functions to your fixture and register/instantiate them using * REGISTER_NODE_TEST_CASE and INSTANTIATE_NODE_TEST_CASE. * It will then automatically create a test case for each node type (file, directory, symlink). * See FsppNodeTest_Rename for an example. */ template class FsppNodeTest: public virtual FsppNodeTestBase, public FileSystemTest { public: virtual cpputils::unique_ref CreateNode(const boost::filesystem::path &path) = 0; }; class FsppNodeTest_File_Helper: public virtual FsppNodeTestBase { public: void IN_STAT(fspp::Node *file, std::function callback) override { struct stat st1, st2; file->stat(&st1); callback(st1); dynamic_cast(*file).open(O_RDONLY)->stat(&st2); callback(st2); } void EXPECT_SIZE(uint64_t expectedSize, fspp::Node *node) override { IN_STAT(node, [expectedSize] (struct stat st) { EXPECT_EQ(expectedSize, (uint64_t)st.st_size); }); fspp::File* fileNode = dynamic_cast(node); ASSERT(fileNode != nullptr, "Is not a file node"); EXPECT_NUMBYTES_READABLE(expectedSize, fileNode); } void EXPECT_NUMBYTES_READABLE(uint64_t expectedSize, fspp::File *file) { auto openFile = file->open(O_RDONLY); cpputils::Data data(expectedSize); //Try to read one byte more than the expected size ssize_t readBytes = openFile->read(data.data(), expectedSize+1, 0); //and check that it only read the expected size (but also not less) EXPECT_EQ(expectedSize, (uint64_t)readBytes); } }; class FsppNodeTest_Dir_Helper: public virtual FsppNodeTestBase { public: void IN_STAT(fspp::Node *file, std::function callback) override { struct stat st; file->stat(&st); callback(st); } void EXPECT_SIZE(uint64_t expectedSize, fspp::Node *node) override { IN_STAT(node, [expectedSize] (struct stat st) { EXPECT_EQ(expectedSize, (uint64_t)st.st_size); }); } }; class FsppNodeTest_Symlink_Helper: public virtual FsppNodeTestBase { public: void IN_STAT(fspp::Node *file, std::function callback) override { struct stat st; file->stat(&st); callback(st); } void EXPECT_SIZE(uint64_t expectedSize, fspp::Node *node) override { IN_STAT(node, [expectedSize] (struct stat st) { EXPECT_EQ(expectedSize, (uint64_t)st.st_size); }); } }; #define _REGISTER_SINGLE_NODE_TEST_CASE(r, Class, Name) \ TYPED_TEST_P(Class, Name) { \ this->BOOST_PP_CAT(Test_,Name)(); \ } \ #define _REGISTER_NODE_TEST_CASES_FOR_CLASS(Class, ...) \ BOOST_PP_SEQ_FOR_EACH(_REGISTER_SINGLE_NODE_TEST_CASE, Class, BOOST_PP_VARIADIC_TO_SEQ(__VA_ARGS__)); \ REGISTER_TYPED_TEST_CASE_P(Class, __VA_ARGS__); \ #define _REGISTER_FILE_TEST_CASE(Class, ...) \ template \ class Class##_FileNode: public Class, public FsppNodeTest_File_Helper { \ public: \ cpputils::unique_ref CreateNode(const boost::filesystem::path &path) override { \ return this->CreateFile(path); \ } \ }; \ TYPED_TEST_CASE_P(Class##_FileNode); \ _REGISTER_NODE_TEST_CASES_FOR_CLASS(Class##_FileNode, __VA_ARGS__); \ #define _REGISTER_DIR_TEST_CASE(Class, ...) \ template \ class Class##_DirNode: public Class, public FsppNodeTest_Dir_Helper { \ public: \ cpputils::unique_ref CreateNode(const boost::filesystem::path &path) override { \ return this->CreateDir(path); \ } \ }; \ TYPED_TEST_CASE_P(Class##_DirNode); \ _REGISTER_NODE_TEST_CASES_FOR_CLASS(Class##_DirNode, __VA_ARGS__); \ #define _REGISTER_SYMLINK_TEST_CASE(Class, ...) \ template \ class Class##_SymlinkNode: public Class, public FsppNodeTest_Symlink_Helper { \ public: \ cpputils::unique_ref CreateNode(const boost::filesystem::path &path) override { \ return this->CreateSymlink(path); \ } \ }; \ TYPED_TEST_CASE_P(Class##_SymlinkNode); \ _REGISTER_NODE_TEST_CASES_FOR_CLASS(Class##_SymlinkNode, __VA_ARGS__); \ #define REGISTER_NODE_TEST_CASE(Class, ...) \ _REGISTER_FILE_TEST_CASE(Class, __VA_ARGS__); \ _REGISTER_DIR_TEST_CASE(Class, __VA_ARGS__); \ _REGISTER_SYMLINK_TEST_CASE(Class, __VA_ARGS__); \ #define INSTANTIATE_NODE_TEST_CASE(FS_NAME, Class, FIXTURE) \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, Class##_FileNode, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, Class##_DirNode, FIXTURE); \ INSTANTIATE_TYPED_TEST_CASE_P(FS_NAME, Class##_SymlinkNode, FIXTURE); \ #endif src/fspp/fstest/testutils/TimestampTestUtils.h000066400000000000000000000136501300002025200221470ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FSTEST_TESTUTILS_TIMESTAMPTESTUTILS_H_ #define MESSMER_FSPP_FSTEST_TESTUTILS_TIMESTAMPTESTUTILS_H_ #include #include class TimestampTestUtils { public: using TimestampUpdateBehavior = std::function; TimestampUpdateBehavior ExpectUpdatesAccessTimestamp = [] (struct stat statBeforeOperation, struct stat statAfterOperation, timespec timeBeforeOperation, timespec timeAfterOperation) { UNUSED(statBeforeOperation); UNUSED(timeBeforeOperation); UNUSED(timeAfterOperation); EXPECT_LE(timeBeforeOperation, statAfterOperation.st_atim); EXPECT_GE(timeAfterOperation, statAfterOperation.st_atim); }; TimestampUpdateBehavior ExpectDoesntUpdateAccessTimestamp = [] (struct stat statBeforeOperation, struct stat statAfterOperation, timespec timeBeforeOperation, timespec timeAfterOperation) { UNUSED(timeBeforeOperation); UNUSED(timeAfterOperation); EXPECT_EQ(statBeforeOperation.st_atim, statAfterOperation.st_atim); }; TimestampUpdateBehavior ExpectUpdatesModificationTimestamp = [] (struct stat statBeforeOperation, struct stat statAfterOperation, timespec timeBeforeOperation, timespec timeAfterOperation) { UNUSED(statBeforeOperation); EXPECT_LE(timeBeforeOperation, statAfterOperation.st_mtim); EXPECT_GE(timeAfterOperation, statAfterOperation.st_mtim); }; TimestampUpdateBehavior ExpectDoesntUpdateModificationTimestamp = [] (struct stat statBeforeOperation, struct stat statAfterOperation, timespec timeBeforeOperation, timespec timeAfterOperation) { UNUSED(timeBeforeOperation); UNUSED(timeAfterOperation); EXPECT_EQ(statBeforeOperation.st_mtim, statAfterOperation.st_mtim); }; TimestampUpdateBehavior ExpectUpdatesMetadataTimestamp = [] (struct stat statBeforeOperation, struct stat statAfterOperation, timespec timeBeforeOperation, timespec timeAfterOperation) { UNUSED(statBeforeOperation); EXPECT_LE(timeBeforeOperation, statAfterOperation.st_ctim); EXPECT_GE(timeAfterOperation, statAfterOperation.st_ctim); }; TimestampUpdateBehavior ExpectDoesntUpdateMetadataTimestamp = [] (struct stat statBeforeOperation, struct stat statAfterOperation, timespec timeBeforeOperation, timespec timeAfterOperation) { UNUSED(timeBeforeOperation); UNUSED(timeAfterOperation); EXPECT_EQ(statBeforeOperation.st_ctim, statAfterOperation.st_ctim); }; TimestampUpdateBehavior ExpectDoesntUpdateAnyTimestamps = [this] (struct stat statBeforeOperation, struct stat statAfterOperation, timespec timeBeforeOperation, timespec timeAfterOperation) { ExpectDoesntUpdateAccessTimestamp(statBeforeOperation, statAfterOperation, timeBeforeOperation, timeAfterOperation); ExpectDoesntUpdateModificationTimestamp(statBeforeOperation, statAfterOperation, timeBeforeOperation, timeAfterOperation); ExpectDoesntUpdateMetadataTimestamp(statBeforeOperation, statAfterOperation, timeBeforeOperation, timeAfterOperation); }; void EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(std::function stat, std::function operation, std::initializer_list behaviorChecks) { struct stat oldStat = stat(); ensureNodeTimestampsAreOld(oldStat); timespec timeBeforeOperation = cpputils::time::now(); operation(); timespec timeAfterOperation = cpputils::time::now(); struct stat newStat = stat(); for (auto behaviorCheck : behaviorChecks) { behaviorCheck(oldStat, newStat, timeBeforeOperation, timeAfterOperation); } } void EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(const fspp::OpenFile &node, std::function operation, std::initializer_list behaviorChecks) { return EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS([&node](){return stat(node);}, operation, behaviorChecks); } void EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS(const fspp::Node &node, std::function operation, std::initializer_list behaviorChecks) { return EXPECT_OPERATION_UPDATES_TIMESTAMPS_AS([&node](){return stat(node);}, operation, behaviorChecks); } template void EXPECT_ACCESS_TIMESTAMP_BETWEEN(timespec lowerBound, timespec upperBound, const NodeType &node) { EXPECT_LE(lowerBound, stat(node).st_atim); EXPECT_GE(upperBound, stat(node).st_atim); } template void EXPECT_MODIFICATION_TIMESTAMP_BETWEEN(timespec lowerBound, timespec upperBound, const NodeType &node) { EXPECT_LE(lowerBound, stat(node).st_mtim); EXPECT_GE(upperBound, stat(node).st_mtim); } template void EXPECT_METADATACHANGE_TIMESTAMP_BETWEEN(timespec lowerBound, timespec upperBound, const NodeType &node) { EXPECT_LE(lowerBound, stat(node).st_ctim); EXPECT_GE(upperBound, stat(node).st_ctim); } template static struct stat stat(const NodeType &node) { struct stat st; node.stat(&st); return st; } timespec xSecondsAgo(int sec) { timespec result = cpputils::time::now(); result.tv_sec -= sec; return result; } void ensureNodeTimestampsAreOld(const struct stat &nodeStat) { waitUntilClockProgresses(); EXPECT_LT(nodeStat.st_atim, cpputils::time::now()); EXPECT_LT(nodeStat.st_mtim, cpputils::time::now()); EXPECT_LT(nodeStat.st_ctim, cpputils::time::now()); } private: void waitUntilClockProgresses() { auto start = cpputils::time::now(); while (start == cpputils::time::now()) { // busy waiting is the fastest, we only have to wait for a nanosecond increment. } } }; #endif src/fspp/fuse/000077500000000000000000000000001300002025200135375ustar00rootroot00000000000000src/fspp/fuse/Filesystem.h000066400000000000000000000047311300002025200160410ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FUSE_FILESYSTEM_H_ #define MESSMER_FSPP_FUSE_FILESYSTEM_H_ #include #include #include #include #include "../fs_interface/Dir.h" namespace fspp { namespace fuse { class Filesystem { public: virtual ~Filesystem() {} //TODO Test uid/gid parameters of createAndOpenFile virtual int createAndOpenFile(const boost::filesystem::path &path, mode_t mode, uid_t uid, gid_t gid) = 0; virtual int openFile(const boost::filesystem::path &path, int flags) = 0; virtual void flush(int descriptor) = 0; virtual void closeFile(int descriptor) = 0; virtual void lstat(const boost::filesystem::path &path, struct ::stat *stbuf) = 0; virtual void fstat(int descriptor, struct ::stat *stbuf) = 0; //TODO Test chmod virtual void chmod(const boost::filesystem::path &path, mode_t mode) = 0; //TODO Test chown virtual void chown(const boost::filesystem::path &path, uid_t uid, gid_t gid) = 0; virtual void truncate(const boost::filesystem::path &path, off_t size) = 0; virtual void ftruncate(int descriptor, off_t size) = 0; virtual size_t read(int descriptor, void *buf, size_t count, off_t offset) = 0; virtual void write(int descriptor, const void *buf, size_t count, off_t offset) = 0; virtual void fsync(int descriptor) = 0; virtual void fdatasync(int descriptor) = 0; virtual void access(const boost::filesystem::path &path, int mask) = 0; //TODO Test uid/gid parameters of mkdir virtual void mkdir(const boost::filesystem::path &path, mode_t mode, uid_t uid, gid_t gid) = 0; virtual void rmdir(const boost::filesystem::path &path) = 0; virtual void unlink(const boost::filesystem::path &path) = 0; virtual void rename(const boost::filesystem::path &from, const boost::filesystem::path &to) = 0; virtual void utimens(const boost::filesystem::path &path, timespec lastAccessTime, timespec lastModificationTime) = 0; virtual void statfs(const boost::filesystem::path &path, struct statvfs *fsstat) = 0; //TODO We shouldn't use Dir::Entry here, that's in another layer virtual cpputils::unique_ref> readDir(const boost::filesystem::path &path) = 0; //TODO Test createSymlink virtual void createSymlink(const boost::filesystem::path &to, const boost::filesystem::path &from, uid_t uid, gid_t gid) = 0; //TODO Test readSymlink virtual void readSymlink(const boost::filesystem::path &path, char *buf, size_t size) = 0; }; } } #endif src/fspp/fuse/Fuse.cpp000066400000000000000000000623541300002025200151570ustar00rootroot00000000000000#include "Fuse.h" #include #include #include "FuseErrnoException.h" #include "Filesystem.h" #include #include #include #include using std::vector; using std::string; namespace bf = boost::filesystem; using namespace cpputils::logging; using namespace fspp::fuse; #define FUSE_OBJ ((Fuse *) fuse_get_context()->private_data) // Remove the following line, if you don't want to output each fuse operation on the console //#define FSPP_LOG 1 namespace { int fusepp_getattr(const char *path, struct stat *stbuf) { int rs = FUSE_OBJ->getattr(bf::path(path), stbuf); return rs; } int fusepp_fgetattr(const char *path, struct stat *stbuf, fuse_file_info *fileinfo) { return FUSE_OBJ->fgetattr(bf::path(path), stbuf, fileinfo); } int fusepp_readlink(const char *path, char *buf, size_t size) { return FUSE_OBJ->readlink(bf::path(path), buf, size); } int fusepp_mknod(const char *path, mode_t mode, dev_t rdev) { return FUSE_OBJ->mknod(bf::path(path), mode, rdev); } int fusepp_mkdir(const char *path, mode_t mode) { return FUSE_OBJ->mkdir(bf::path(path), mode); } int fusepp_unlink(const char *path) { return FUSE_OBJ->unlink(bf::path(path)); } int fusepp_rmdir(const char *path) { return FUSE_OBJ->rmdir(bf::path(path)); } int fusepp_symlink(const char *to, const char *from) { return FUSE_OBJ->symlink(bf::path(to), bf::path(from)); } int fusepp_rename(const char *from, const char *to) { return FUSE_OBJ->rename(bf::path(from), bf::path(to)); } int fusepp_link(const char *from, const char *to) { return FUSE_OBJ->link(bf::path(from), bf::path(to)); } int fusepp_chmod(const char *path, mode_t mode) { return FUSE_OBJ->chmod(bf::path(path), mode); } int fusepp_chown(const char *path, uid_t uid, gid_t gid) { return FUSE_OBJ->chown(bf::path(path), uid, gid); } int fusepp_truncate(const char *path, off_t size) { return FUSE_OBJ->truncate(bf::path(path), size); } int fusepp_ftruncate(const char *path, off_t size, fuse_file_info *fileinfo) { return FUSE_OBJ->ftruncate(bf::path(path), size, fileinfo); } int fusepp_utimens(const char *path, const timespec times[2]) { return FUSE_OBJ->utimens(bf::path(path), times); } int fusepp_open(const char *path, fuse_file_info *fileinfo) { return FUSE_OBJ->open(bf::path(path), fileinfo); } int fusepp_release(const char *path, fuse_file_info *fileinfo) { return FUSE_OBJ->release(bf::path(path), fileinfo); } int fusepp_read(const char *path, char *buf, size_t size, off_t offset, fuse_file_info *fileinfo) { return FUSE_OBJ->read(bf::path(path), buf, size, offset, fileinfo); } int fusepp_write(const char *path, const char *buf, size_t size, off_t offset, fuse_file_info *fileinfo) { return FUSE_OBJ->write(bf::path(path), buf, size, offset, fileinfo); } int fusepp_statfs(const char *path, struct statvfs *fsstat) { return FUSE_OBJ->statfs(bf::path(path), fsstat); } int fusepp_flush(const char *path, fuse_file_info *fileinfo) { return FUSE_OBJ->flush(bf::path(path), fileinfo); } int fusepp_fsync(const char *path, int datasync, fuse_file_info *fileinfo) { return FUSE_OBJ->fsync(bf::path(path), datasync, fileinfo); } //int fusepp_setxattr(const char*, const char*, const char*, size_t, int) //int fusepp_getxattr(const char*, const char*, char*, size_t) //int fusepp_listxattr(const char*, char*, size_t) //int fusepp_removexattr(const char*, const char*) int fusepp_opendir(const char *path, fuse_file_info *fileinfo) { return FUSE_OBJ->opendir(bf::path(path), fileinfo); } int fusepp_readdir(const char *path, void *buf, fuse_fill_dir_t filler, off_t offset, fuse_file_info *fileinfo) { return FUSE_OBJ->readdir(bf::path(path), buf, filler, offset, fileinfo); } int fusepp_releasedir(const char *path, fuse_file_info *fileinfo) { return FUSE_OBJ->releasedir(bf::path(path), fileinfo); } int fusepp_fsyncdir(const char *path, int datasync, fuse_file_info *fileinfo) { return FUSE_OBJ->fsyncdir(bf::path(path), datasync, fileinfo); } void* fusepp_init(fuse_conn_info *conn) { auto f = FUSE_OBJ; f->init(conn); return f; } void fusepp_destroy(void *userdata) { auto f = FUSE_OBJ; ASSERT(userdata == f, "Wrong userdata set"); UNUSED(userdata); //In case the assert is disabled f->destroy(); } int fusepp_access(const char *path, int mask) { return FUSE_OBJ->access(bf::path(path), mask); } int fusepp_create(const char *path, mode_t mode, fuse_file_info *fileinfo) { return FUSE_OBJ->create(bf::path(path), mode, fileinfo); } /*int fusepp_lock(const char*, fuse_file_info*, int cmd, flock*) int fusepp_bmap(const char*, size_t blocksize, uint64_t *idx) int fusepp_ioctl(const char*, int cmd, void *arg, fuse_file_info*, unsigned int flags, void *data) int fusepp_poll(const char*, fuse_file_info*, fuse_pollhandle *ph, unsigned *reventsp) int fusepp_write_buf(const char*, fuse_bufvec *buf, off_t off, fuse_file_info*) int fusepp_read_buf(const chas*, struct fuse_bufvec **bufp, size_t size, off_T off, fuse_file_info*) int fusepp_flock(const char*, fuse_file_info*, int op) int fusepp_fallocate(const char*, int, off_t, off_t, fuse_file_info*)*/ fuse_operations *operations() { static std::unique_ptr singleton(nullptr); if (!singleton) { singleton = std::make_unique(); singleton->getattr = &fusepp_getattr; singleton->fgetattr = &fusepp_fgetattr; singleton->readlink = &fusepp_readlink; singleton->mknod = &fusepp_mknod; singleton->mkdir = &fusepp_mkdir; singleton->unlink = &fusepp_unlink; singleton->rmdir = &fusepp_rmdir; singleton->symlink = &fusepp_symlink; singleton->rename = &fusepp_rename; singleton->link = &fusepp_link; singleton->chmod = &fusepp_chmod; singleton->chown = &fusepp_chown; singleton->truncate = &fusepp_truncate; singleton->utimens = &fusepp_utimens; singleton->open = &fusepp_open; singleton->read = &fusepp_read; singleton->write = &fusepp_write; singleton->statfs = &fusepp_statfs; singleton->flush = &fusepp_flush; singleton->release = &fusepp_release; singleton->fsync = &fusepp_fsync; /*#ifdef HAVE_SYS_XATTR_H singleton->setxattr = &fusepp_setxattr; singleton->getxattr = &fusepp_getxattr; singleton->listxattr = &fusepp_listxattr; singleton->removexattr = &fusepp_removexattr; #endif*/ singleton->opendir = &fusepp_opendir; singleton->readdir = &fusepp_readdir; singleton->releasedir = &fusepp_releasedir; singleton->fsyncdir = &fusepp_fsyncdir; singleton->init = &fusepp_init; singleton->destroy = &fusepp_destroy; singleton->access = &fusepp_access; singleton->create = &fusepp_create; singleton->ftruncate = &fusepp_ftruncate; } return singleton.get(); } } Fuse::~Fuse() { for(char *arg : _argv) { delete arg; arg = nullptr; } _argv.clear(); } Fuse::Fuse(Filesystem *fs, const std::string &fstype, const boost::optional &fsname) :_fs(fs), _mountdir(), _running(false), _fstype(fstype), _fsname(fsname) { } void Fuse::_logException(const std::exception &e) { LOG(ERROR) << "Exception thrown: " << e.what(); } void Fuse::_logUnknownException() { LOG(ERROR) << "Unknown exception thrown"; } void Fuse::run(const bf::path &mountdir, const vector &fuseOptions) { _mountdir = mountdir; ASSERT(_argv.size() == 0, "Filesystem already started"); _argv = _build_argv(mountdir, fuseOptions); fuse_main(_argv.size(), _argv.data(), operations(), (void*)this); } vector Fuse::_build_argv(const bf::path &mountdir, const vector &fuseOptions) { vector argv; argv.reserve(6 + fuseOptions.size()); // fuseOptions + executable name + mountdir + 2x fuse options (subtype, fsname), each taking 2 entries ("-o", "key=value"). argv.push_back(_create_c_string(_fstype)); // The first argument (executable name) is the file system type argv.push_back(_create_c_string(mountdir.native())); // The second argument is the mountdir for (const string &option : fuseOptions) { argv.push_back(_create_c_string(option)); } _add_fuse_option_if_not_exists(&argv, "subtype", _fstype); _add_fuse_option_if_not_exists(&argv, "fsname", _fsname.get_value_or(_fstype)); return argv; } void Fuse::_add_fuse_option_if_not_exists(vector *argv, const string &key, const string &value) { if(!_has_option(*argv, key)) { argv->push_back(_create_c_string("-o")); argv->push_back(_create_c_string(key + "=" + value)); } } bool Fuse::_has_option(const vector &vec, const string &key) { // The fuse option can either be present as "-okey=value" or as "-o key=value", we have to check both. return _has_entry_with_prefix(key + "=", vec) || _has_entry_with_prefix("-o" + key + "=", vec); } bool Fuse::_has_entry_with_prefix(const string &prefix, const vector &vec) { auto found = std::find_if(vec.begin(), vec.end(), [&prefix](const char *entry) { return 0 == std::strncmp(prefix.c_str(), entry, prefix.size()); }); return found != vec.end(); } char *Fuse::_create_c_string(const string &str) { // The memory allocated here is destroyed in the destructor of the Fuse class. char *c_str = new char[str.size()+1]; std::memcpy(c_str, str.c_str(), str.size()+1); return c_str; } bool Fuse::running() const { return _running; } void Fuse::stop() { //TODO Find better way to unmount (i.e. don't use external fusermount). Unmounting by kill(getpid(), SIGINT) worked, but left the mount directory transport endpoint as not connected. #ifdef __APPLE__ int ret = system(("umount " + _mountdir.native()).c_str()); #else int ret = system(("fusermount -z -u " + _mountdir.native()).c_str()); // "-z" takes care that if the filesystem can't be unmounted right now because something is opened, it will be unmounted as soon as it can be. #endif if (ret != 0) { LOG(ERROR) << "Could not unmount filesystem"; } } int Fuse::getattr(const bf::path &path, struct stat *stbuf) { #ifdef FSPP_LOG LOG(DEBUG) << "getattr(" << path << ", _, _)"; #endif try { _fs->lstat(path, stbuf); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::getattr: " << e.what(); return -EIO; } catch(fspp::fuse::FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::fgetattr(const bf::path &path, struct stat *stbuf, fuse_file_info *fileinfo) { #ifdef FSPP_LOG LOG(DEBUG) << "fgetattr(" << path << ", _, _)\n"; #endif // On FreeBSD, trying to do anything with the mountpoint ends up // opening it, and then using the FD for an fgetattr. So in the // special case of a path of "/", I need to do a getattr on the // underlying base directory instead of doing the fgetattr(). // TODO Check if necessary if (path.native() == "/") { return getattr(path, stbuf); } try { _fs->fstat(fileinfo->fh, stbuf); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::fgetattr: " << e.what(); return -EIO; } catch(fspp::fuse::FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::readlink(const bf::path &path, char *buf, size_t size) { #ifdef FSPP_LOG LOG(DEBUG) << "readlink(" << path << ", _, " << size << ")"; #endif try { _fs->readSymlink(path, buf, size); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::readlink: " << e.what(); return -EIO; } catch (fspp::fuse::FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::mknod(const bf::path &path, mode_t mode, dev_t rdev) { UNUSED(rdev); UNUSED(mode); UNUSED(path); LOG(WARN) << "Called non-implemented mknod(" << path << ", " << mode << ", _)"; return ENOSYS; } int Fuse::mkdir(const bf::path &path, mode_t mode) { #ifdef FSPP_LOG LOG(DEBUG) << "mkdir(" << path << ", " << mode << ")"; #endif try { auto context = fuse_get_context(); _fs->mkdir(path, mode, context->uid, context->gid); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::mkdir: " << e.what(); return -EIO; } catch(fspp::fuse::FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::unlink(const bf::path &path) { #ifdef FSPP_LOG LOG(DEBUG) << "unlink(" << path << ")"; #endif try { _fs->unlink(path); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::unlink: " << e.what(); return -EIO; } catch(fspp::fuse::FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::rmdir(const bf::path &path) { #ifdef FSPP_LOG LOG(DEBUG) << "rmdir(" << path << ")"; #endif try { _fs->rmdir(path); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::rmdir: " << e.what(); return -EIO; } catch(fspp::fuse::FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::symlink(const bf::path &from, const bf::path &to) { #ifdef FSPP_LOG LOG(DEBUG) << "symlink(" << from << ", " << to << ")"; #endif try { auto context = fuse_get_context(); _fs->createSymlink(from, to, context->uid, context->gid); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::symlink: " << e.what(); return -EIO; } catch(fspp::fuse::FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::rename(const bf::path &from, const bf::path &to) { #ifdef FSPP_LOG LOG(DEBUG) << "rename(" << from << ", " << to << ")"; #endif try { ASSERT(from.is_absolute(), "from has to be an absolute path"); ASSERT(to.is_absolute(), "rename target has to be an absolute path. If this assert throws, we have to add code here that makes the path absolute."); _fs->rename(from, to); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::rename: " << e.what(); return -EIO; } catch(fspp::fuse::FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } //TODO int Fuse::link(const bf::path &from, const bf::path &to) { LOG(WARN) << "NOT IMPLEMENTED: link(" << from << ", " << to << ")"; //auto real_from = _impl->RootDir() / from; //auto real_to = _impl->RootDir() / to; //int retstat = ::link(real_from.c_str(), real_to.c_str()); //return errcode_map(retstat); return ENOSYS; } int Fuse::chmod(const bf::path &path, mode_t mode) { #ifdef FSPP_LOG LOG(DEBUG) << "chmod(" << path << ", " << mode << ")"; #endif try { _fs->chmod(path, mode); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::chmod: " << e.what(); return -EIO; } catch (fspp::fuse::FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::chown(const bf::path &path, uid_t uid, gid_t gid) { #ifdef FSPP_LOG LOG(DEBUG) << "chown(" << path << ", " << uid << ", " << gid << ")"; #endif try { _fs->chown(path, uid, gid); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::chown: " << e.what(); return -EIO; } catch (fspp::fuse::FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::truncate(const bf::path &path, off_t size) { #ifdef FSPP_LOG LOG(DEBUG) << "truncate(" << path << ", " << size << ")"; #endif try { _fs->truncate(path, size); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::truncate: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::ftruncate(const bf::path &path, off_t size, fuse_file_info *fileinfo) { #ifdef FSPP_LOG LOG(DEBUG) << "ftruncate(" << path << ", " << size << ")"; #endif UNUSED(path); try { _fs->ftruncate(fileinfo->fh, size); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::ftruncate: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::utimens(const bf::path &path, const timespec times[2]) { #ifdef FSPP_LOG LOG(DEBUG) << "utimens(" << path << ", _)"; #endif try { _fs->utimens(path, times[0], times[1]); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::utimens: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::open(const bf::path &path, fuse_file_info *fileinfo) { #ifdef FSPP_LOG LOG(DEBUG) << "open(" << path << ", _)"; #endif try { fileinfo->fh = _fs->openFile(path, fileinfo->flags); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::open: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::release(const bf::path &path, fuse_file_info *fileinfo) { #ifdef FSPP_LOG LOG(DEBUG) << "release(" << path << ", _)"; #endif UNUSED(path); try { _fs->closeFile(fileinfo->fh); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::release: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::read(const bf::path &path, char *buf, size_t size, off_t offset, fuse_file_info *fileinfo) { #ifdef FSPP_LOG LOG(DEBUG) << "read(" << path << ", _, " << size << ", " << offset << ", _ )"; #endif UNUSED(path); try { return _fs->read(fileinfo->fh, buf, size, offset); } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::read: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::write(const bf::path &path, const char *buf, size_t size, off_t offset, fuse_file_info *fileinfo) { #ifdef FSPP_LOG LOG(DEBUG) << "write(" << path << ", _, " << size << ", " << offset << ", _)"; #endif UNUSED(path); try { _fs->write(fileinfo->fh, buf, size, offset); return size; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::write: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } //TODO int Fuse::statfs(const bf::path &path, struct statvfs *fsstat) { #ifdef FSPP_LOG LOG(DEBUG) << "statfs(" << path << ", _)"; #endif try { _fs->statfs(path, fsstat); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::statfs: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::flush(const bf::path &path, fuse_file_info *fileinfo) { #ifdef FSPP_LOG LOG(WARN) << "flush(" << path << ", _)"; #endif UNUSED(path); try { _fs->flush(fileinfo->fh); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::flush: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::fsync(const bf::path &path, int datasync, fuse_file_info *fileinfo) { #ifdef FSPP_LOG LOG(DEBUG) << "fsync(" << path << ", " << datasync << ", _)"; #endif UNUSED(path); try { if (datasync) { _fs->fdatasync(fileinfo->fh); } else { _fs->fsync(fileinfo->fh); } return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::fsync: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::opendir(const bf::path &path, fuse_file_info *fileinfo) { UNUSED(path); UNUSED(fileinfo); //LOG(DEBUG) << "opendir(" << path << ", _)"; //We don't need opendir, because readdir works directly on the path return 0; } int Fuse::readdir(const bf::path &path, void *buf, fuse_fill_dir_t filler, off_t offset, fuse_file_info *fileinfo) { #ifdef FSPP_LOG LOG(DEBUG) << "readdir(" << path << ", _, _, " << offset << ", _)"; #endif UNUSED(fileinfo); UNUSED(offset); try { auto entries = _fs->readDir(path); struct stat stbuf; for (const auto &entry : *entries) { //We could pass more file metadata to filler() in its third parameter, //but it doesn't help performance since fuse ignores everything in stbuf //except for file-type bits in st_mode and (if used) st_ino. //It does getattr() calls on all entries nevertheless. if (entry.type == Dir::EntryType::DIR) { stbuf.st_mode = S_IFDIR; } else if (entry.type == Dir::EntryType::FILE) { stbuf.st_mode = S_IFREG; } else if (entry.type == Dir::EntryType::SYMLINK) { stbuf.st_mode = S_IFLNK; } else { ASSERT(false, "Unknown entry type"); } if (filler(buf, entry.name.c_str(), &stbuf, 0) != 0) { return -ENOMEM; } } return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::readdir: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::releasedir(const bf::path &path, fuse_file_info *fileinfo) { UNUSED(path); UNUSED(fileinfo); //LOG(DEBUG) << "releasedir(" << path << ", _)"; //We don't need releasedir, because readdir works directly on the path return 0; } //TODO int Fuse::fsyncdir(const bf::path &path, int datasync, fuse_file_info *fileinfo) { UNUSED(fileinfo); UNUSED(datasync); UNUSED(path); //LOG(WARN) << "Called non-implemented fsyncdir(" << path << ", " << datasync << ", _)"; return 0; } void Fuse::init(fuse_conn_info *conn) { UNUSED(conn); LOG(INFO) << "Filesystem started."; _running = true; #ifdef FSPP_LOG cpputils::logging::setLevel(DEBUG); #endif } void Fuse::destroy() { LOG(INFO) << "Filesystem stopped."; _running = false; } int Fuse::access(const bf::path &path, int mask) { #ifdef FSPP_LOG LOG(DEBUG) << "access(" << path << ", " << mask << ")"; #endif try { _fs->access(path, mask); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::access: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } int Fuse::create(const bf::path &path, mode_t mode, fuse_file_info *fileinfo) { #ifdef FSPP_LOG LOG(DEBUG) << "create(" << path << ", " << mode << ", _)"; #endif try { auto context = fuse_get_context(); fileinfo->fh = _fs->createAndOpenFile(path, mode, context->uid, context->gid); return 0; } catch(const cpputils::AssertFailed &e) { LOG(ERROR) << "AssertFailed in Fuse::create: " << e.what(); return -EIO; } catch (FuseErrnoException &e) { return -e.getErrno(); } catch(const std::exception &e) { _logException(e); return -EIO; } catch(...) { _logUnknownException(); return -EIO; } } src/fspp/fuse/Fuse.h000066400000000000000000000072231300002025200146160ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FUSE_FUSE_H_ #define MESSMER_FSPP_FUSE_FUSE_H_ #include "params.h" #include #include #include #include #include #include #include namespace fspp { class Device; namespace fuse { class Filesystem; class Fuse final { public: explicit Fuse(Filesystem *fs, const std::string &fstype, const boost::optional &fsname); ~Fuse(); void run(const boost::filesystem::path &mountdir, const std::vector &fuseOptions); bool running() const; void stop(); int getattr(const boost::filesystem::path &path, struct stat *stbuf); int fgetattr(const boost::filesystem::path &path, struct stat *stbuf, fuse_file_info *fileinfo); int readlink(const boost::filesystem::path &path, char *buf, size_t size); int mknod(const boost::filesystem::path &path, mode_t mode, dev_t rdev); int mkdir(const boost::filesystem::path &path, mode_t mode); int unlink(const boost::filesystem::path &path); int rmdir(const boost::filesystem::path &path); int symlink(const boost::filesystem::path &from, const boost::filesystem::path &to); int rename(const boost::filesystem::path &from, const boost::filesystem::path &to); int link(const boost::filesystem::path &from, const boost::filesystem::path &to); int chmod(const boost::filesystem::path &path, mode_t mode); int chown(const boost::filesystem::path &path, uid_t uid, gid_t gid); int truncate(const boost::filesystem::path &path, off_t size); int ftruncate(const boost::filesystem::path &path, off_t size, fuse_file_info *fileinfo); int utimens(const boost::filesystem::path &path, const timespec times[2]); int open(const boost::filesystem::path &path, fuse_file_info *fileinfo); int release(const boost::filesystem::path &path, fuse_file_info *fileinfo); int read(const boost::filesystem::path &path, char *buf, size_t size, off_t offset, fuse_file_info *fileinfo); int write(const boost::filesystem::path &path, const char *buf, size_t size, off_t offset, fuse_file_info *fileinfo); int statfs(const boost::filesystem::path &path, struct statvfs *fsstat); int flush(const boost::filesystem::path &path, fuse_file_info *fileinfo); int fsync(const boost::filesystem::path &path, int flags, fuse_file_info *fileinfo); int opendir(const boost::filesystem::path &path, fuse_file_info *fileinfo); int readdir(const boost::filesystem::path &path, void *buf, fuse_fill_dir_t filler, off_t offset, fuse_file_info *fileinfo); int releasedir(const boost::filesystem::path &path, fuse_file_info *fileinfo); int fsyncdir(const boost::filesystem::path &path, int datasync, fuse_file_info *fileinfo); void init(fuse_conn_info *conn); void destroy(); int access(const boost::filesystem::path &path, int mask); int create(const boost::filesystem::path &path, mode_t mode, fuse_file_info *fileinfo); private: static void _logException(const std::exception &e); static void _logUnknownException(); static char *_create_c_string(const std::string &str); static bool _has_option(const std::vector &vec, const std::string &key); static bool _has_entry_with_prefix(const std::string &prefix, const std::vector &vec); std::vector _build_argv(const boost::filesystem::path &mountdir, const std::vector &fuseOptions); void _add_fuse_option_if_not_exists(std::vector *argv, const std::string &key, const std::string &value); Filesystem *_fs; boost::filesystem::path _mountdir; std::vector _argv; bool _running; std::string _fstype; boost::optional _fsname; DISALLOW_COPY_AND_ASSIGN(Fuse); }; } } #endif src/fspp/fuse/FuseErrnoException.h000066400000000000000000000013361300002025200175020ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FUSE_FUSEERRNOEXCEPTION_H_ #define MESSMER_FSPP_FUSE_FUSEERRNOEXCEPTION_H_ #include #include #include namespace fspp { namespace fuse{ class FuseErrnoException final: public std::runtime_error { public: explicit FuseErrnoException(int errno_); int getErrno() const; private: int _errno; }; inline void CHECK_RETVAL(int retval) { if (retval < 0) { throw FuseErrnoException(errno); } } inline FuseErrnoException::FuseErrnoException(int errno_) :runtime_error(strerror(errno_)), _errno(errno_) { ASSERT(_errno != 0, "Errno shouldn't be zero"); } inline int FuseErrnoException::getErrno() const { return _errno; } } } #endif src/fspp/fuse/params.h000066400000000000000000000003601300002025200151720ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_FUSE_PARAMS_H_ #define MESSMER_FSPP_FUSE_PARAMS_H_ #define FUSE_USE_VERSION 26 #ifdef __linux__ #include #elif __APPLE__ #include #else #error System not supported #endif #endif src/fspp/impl/000077500000000000000000000000001300002025200135365ustar00rootroot00000000000000src/fspp/impl/FilesystemImpl.cpp000066400000000000000000000272331300002025200172170ustar00rootroot00000000000000#include "FilesystemImpl.h" #include #include "../fs_interface/Device.h" #include "../fs_interface/Dir.h" #include "../fs_interface/Symlink.h" #include "../fuse/FuseErrnoException.h" #include "../fs_interface/File.h" #include #include #include using namespace fspp; using cpputils::dynamic_pointer_move; using cpputils::unique_ref; using cpputils::make_unique_ref; using std::vector; using std::string; using boost::none; namespace bf = boost::filesystem; using namespace cpputils::logging; #ifdef FSPP_PROFILE #include "Profiler.h" #include #include #define PROFILE(name) Profiler profiler_##name(&name); #else #define PROFILE(name) #endif FilesystemImpl::FilesystemImpl(Device *device) : #ifdef FSPP_PROFILE _loadFileNanosec(0), _loadDirNanosec(0), _loadSymlinkNanosec(0), _openFileNanosec(0), _flushNanosec(0), _closeFileNanosec(0), _lstatNanosec(0), _fstatNanosec(0), _chmodNanosec(0), _chownNanosec(0), _truncateNanosec(0), _ftruncateNanosec(0), _readNanosec(0), _writeNanosec(0), _fsyncNanosec(0), _fdatasyncNanosec(0), _accessNanosec(0), _createAndOpenFileNanosec(0), _createAndOpenFileNanosec_withoutLoading(0), _mkdirNanosec(0), _mkdirNanosec_withoutLoading(0), _rmdirNanosec(0), _rmdirNanosec_withoutLoading(0), _unlinkNanosec(0), _unlinkNanosec_withoutLoading(0), _renameNanosec(0), _readDirNanosec(0), _readDirNanosec_withoutLoading(0), _utimensNanosec(0), _statfsNanosec(0), _createSymlinkNanosec(0), _createSymlinkNanosec_withoutLoading(0), _readSymlinkNanosec(0), _readSymlinkNanosec_withoutLoading(0), #endif _device(device), _open_files() { } FilesystemImpl::~FilesystemImpl() { #ifdef FSPP_PROFILE std::ostringstream profilerInformation; profilerInformation << "Profiler Information\n" << std::fixed << std::setprecision(6) << std::setw(40) << "LoadFile: " << static_cast(_loadFileNanosec)/1000000000 << "\n" << std::setw(40) << "LoadDir: " << static_cast(_loadDirNanosec)/1000000000 << "\n" << std::setw(40) << "LoadSymlink: " << static_cast(_loadSymlinkNanosec)/1000000000 << "\n" << std::setw(40) << "OpenFile: " << static_cast(_openFileNanosec)/1000000000 << "\n" << std::setw(40) << "Flush: " << static_cast(_flushNanosec)/1000000000 << "\n" << std::setw(40) << "CloseFile: " << static_cast(_closeFileNanosec)/1000000000 << "\n" << std::setw(40) << "Lstat: " << static_cast(_lstatNanosec)/1000000000 << "\n" << std::setw(40) << "Fstat: " << static_cast(_fstatNanosec)/1000000000 << "\n" << std::setw(40) << "Chmod: " << static_cast(_chmodNanosec)/1000000000 << "\n" << std::setw(40) << "Chown: " << static_cast(_chownNanosec)/1000000000 << "\n" << std::setw(40) << "Truncate: " << static_cast(_truncateNanosec)/1000000000 << "\n" << std::setw(40) << "Ftruncate: " << static_cast(_ftruncateNanosec)/1000000000 << "\n" << std::setw(40) << "Read: " << static_cast(_readNanosec)/1000000000 << "\n" << std::setw(40) << "Write: " << static_cast(_writeNanosec)/1000000000 << "\n" << std::setw(40) << "Fsync: " << static_cast(_fsyncNanosec)/1000000000 << "\n" << std::setw(40) << "Fdatasync: " << static_cast(_fdatasyncNanosec)/1000000000 << "\n" << std::setw(40) << "Access: " << static_cast(_accessNanosec)/1000000000 << "\n" << std::setw(40) << "CreateAndOpenFile: " << static_cast(_createAndOpenFileNanosec)/1000000000 << "\n" << std::setw(40) << "CreateAndOpenFile (without loading): " << static_cast(_createAndOpenFileNanosec_withoutLoading)/1000000000 << "\n" << std::setw(40) << "Mkdir: " << static_cast(_mkdirNanosec)/1000000000 << "\n" << std::setw(40) << "Mkdir (without loading): " << static_cast(_mkdirNanosec_withoutLoading)/1000000000 << "\n" << std::setw(40) << "Rmdir: " << static_cast(_rmdirNanosec)/1000000000 << "\n" << std::setw(40) << "Rmdir (without loading): " << static_cast(_rmdirNanosec_withoutLoading)/1000000000 << "\n" << std::setw(40) << "Unlink: " << static_cast(_unlinkNanosec)/1000000000 << "\n" << std::setw(40) << "Unlink (without loading): " << static_cast(_unlinkNanosec_withoutLoading)/1000000000 << "\n" << std::setw(40) << "Rename: " << static_cast(_renameNanosec)/1000000000 << "\n" << std::setw(40) << "ReadDir: " << static_cast(_readDirNanosec)/1000000000 << "\n" << std::setw(40) << "ReadDir (without loading): " << static_cast(_readDirNanosec_withoutLoading)/1000000000 << "\n" << std::setw(40) << "Utimens: " << static_cast(_utimensNanosec)/1000000000 << "\n" << std::setw(40) << "Statfs: " << static_cast(_statfsNanosec)/1000000000 << "\n" << std::setw(40) << "CreateSymlink: " << static_cast(_createSymlinkNanosec)/1000000000 << "\n" << std::setw(40) << "CreateSymlink (without loading): " << static_cast(_createSymlinkNanosec_withoutLoading)/1000000000 << "\n" << std::setw(40) << "ReadSymlink: " << static_cast(_readSymlinkNanosec)/1000000000 << "\n" << std::setw(40) << "ReadSymlink (without loading): " << static_cast(_readSymlinkNanosec_withoutLoading)/1000000000 << "\n"; LOG(INFO) << profilerInformation.str(); #endif } unique_ref FilesystemImpl::LoadFile(const bf::path &path) { PROFILE(_loadFileNanosec); auto node = _device->Load(path); if (node == none) { throw fuse::FuseErrnoException(EIO); } auto file = dynamic_pointer_move(*node); if (file == none) { throw fuse::FuseErrnoException(EISDIR); } return std::move(*file); } unique_ref FilesystemImpl::LoadDir(const bf::path &path) { PROFILE(_loadDirNanosec); auto node = _device->Load(path); if (node == none) { throw fuse::FuseErrnoException(EIO); } auto dir = dynamic_pointer_move(*node); if (dir == none) { throw fuse::FuseErrnoException(ENOTDIR); } return std::move(*dir); } unique_ref FilesystemImpl::LoadSymlink(const bf::path &path) { PROFILE(_loadSymlinkNanosec); auto node = _device->Load(path); if (node == none) { throw fuse::FuseErrnoException(EIO); } auto lnk = dynamic_pointer_move(*node); if (lnk == none) { throw fuse::FuseErrnoException(ENOTDIR); } return std::move(*lnk); } unique_ref FilesystemImpl::LoadFileOrSymlink(const bf::path &path) { PROFILE(_loadFileOrSymlinkNanosec); auto node = _device->Load(path); if (node == none) { throw fuse::FuseErrnoException(EIO); } auto file = dynamic_pointer_move(*node); if (file != none) { return std::move(*file); } auto symlink = dynamic_pointer_move(*node); if (symlink != none) { return std::move(*symlink); } throw fuse::FuseErrnoException(EISDIR); } int FilesystemImpl::openFile(const bf::path &path, int flags) { auto file = LoadFile(path); return openFile(file.get(), flags); } int FilesystemImpl::openFile(File *file, int flags) { PROFILE(_openFileNanosec); return _open_files.open(file->open(flags)); } void FilesystemImpl::flush(int descriptor) { PROFILE(_flushNanosec); _open_files.get(descriptor)->flush(); } void FilesystemImpl::closeFile(int descriptor) { PROFILE(_closeFileNanosec); _open_files.close(descriptor); } void FilesystemImpl::lstat(const bf::path &path, struct ::stat *stbuf) { PROFILE(_lstatNanosec); auto node = _device->Load(path); if(node == none) { throw fuse::FuseErrnoException(ENOENT); } else { (*node)->stat(stbuf); } } void FilesystemImpl::fstat(int descriptor, struct ::stat *stbuf) { PROFILE(_fstatNanosec); _open_files.get(descriptor)->stat(stbuf); } void FilesystemImpl::chmod(const boost::filesystem::path &path, mode_t mode) { PROFILE(_chmodNanosec); auto node = _device->Load(path); if(node == none) { throw fuse::FuseErrnoException(ENOENT); } else { (*node)->chmod(mode); } } void FilesystemImpl::chown(const boost::filesystem::path &path, uid_t uid, gid_t gid) { PROFILE(_chownNanosec); auto node = _device->Load(path); if(node == none) { throw fuse::FuseErrnoException(ENOENT); } else { (*node)->chown(uid, gid); } } void FilesystemImpl::truncate(const bf::path &path, off_t size) { PROFILE(_truncateNanosec); LoadFile(path)->truncate(size); } void FilesystemImpl::ftruncate(int descriptor, off_t size) { PROFILE(_ftruncateNanosec); _open_files.get(descriptor)->truncate(size); } size_t FilesystemImpl::read(int descriptor, void *buf, size_t count, off_t offset) { PROFILE(_readNanosec); return _open_files.get(descriptor)->read(buf, count, offset); } void FilesystemImpl::write(int descriptor, const void *buf, size_t count, off_t offset) { PROFILE(_writeNanosec); _open_files.get(descriptor)->write(buf, count, offset); } void FilesystemImpl::fsync(int descriptor) { PROFILE(_fsyncNanosec); _open_files.get(descriptor)->fsync(); } void FilesystemImpl::fdatasync(int descriptor) { PROFILE(_fdatasyncNanosec); _open_files.get(descriptor)->fdatasync(); } void FilesystemImpl::access(const bf::path &path, int mask) { PROFILE(_accessNanosec); auto node = _device->Load(path); if(node == none) { throw fuse::FuseErrnoException(ENOENT); } else { (*node)->access(mask); } } int FilesystemImpl::createAndOpenFile(const bf::path &path, mode_t mode, uid_t uid, gid_t gid) { PROFILE(_createAndOpenFileNanosec); auto dir = LoadDir(path.parent_path()); PROFILE(_createAndOpenFileNanosec_withoutLoading); auto file = dir->createAndOpenFile(path.filename().native(), mode, uid, gid); return _open_files.open(std::move(file)); } void FilesystemImpl::mkdir(const bf::path &path, mode_t mode, uid_t uid, gid_t gid) { PROFILE(_mkdirNanosec); auto dir = LoadDir(path.parent_path()); PROFILE(_mkdirNanosec_withoutLoading); dir->createDir(path.filename().native(), mode, uid, gid); } void FilesystemImpl::rmdir(const bf::path &path) { PROFILE(_rmdirNanosec); auto dir = LoadDir(path); PROFILE(_rmdirNanosec_withoutLoading); dir->remove(); } void FilesystemImpl::unlink(const bf::path &path) { PROFILE(_unlinkNanosec); auto node = LoadFileOrSymlink(path); PROFILE(_unlinkNanosec_withoutLoading); node->remove(); } void FilesystemImpl::rename(const bf::path &from, const bf::path &to) { PROFILE(_renameNanosec); auto node = _device->Load(from); if(node == none) { throw fuse::FuseErrnoException(ENOENT); } else { (*node)->rename(to); } } unique_ref> FilesystemImpl::readDir(const bf::path &path) { PROFILE(_readDirNanosec); auto dir = LoadDir(path); PROFILE(_readDirNanosec_withoutLoading); return dir->children(); } void FilesystemImpl::utimens(const bf::path &path, timespec lastAccessTime, timespec lastModificationTime) { PROFILE(_utimensNanosec); auto node = _device->Load(path); if(node == none) { throw fuse::FuseErrnoException(ENOENT); } else { (*node)->utimens(lastAccessTime, lastModificationTime); } } void FilesystemImpl::statfs(const bf::path &path, struct statvfs *fsstat) { PROFILE(_statfsNanosec); _device->statfs(path, fsstat); } void FilesystemImpl::createSymlink(const bf::path &to, const bf::path &from, uid_t uid, gid_t gid) { PROFILE(_createSymlinkNanosec); auto parent = LoadDir(from.parent_path()); PROFILE(_createSymlinkNanosec_withoutLoading); parent->createSymlink(from.filename().native(), to, uid, gid); } void FilesystemImpl::readSymlink(const bf::path &path, char *buf, size_t size) { PROFILE(_readSymlinkNanosec); string target = LoadSymlink(path)->target().native(); PROFILE(_readSymlinkNanosec_withoutLoading); std::memcpy(buf, target.c_str(), std::min(target.size()+1, size)); buf[size-1] = '\0'; } src/fspp/impl/FilesystemImpl.h000066400000000000000000000106001300002025200166520ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_IMPL_FILESYSTEMIMPL_H_ #define MESSMER_FSPP_IMPL_FILESYSTEMIMPL_H_ #include "FuseOpenFileList.h" #include "../fuse/Filesystem.h" #include #include //Remove this line if you don't want profiling //#define FSPP_PROFILE 1 //TODO Test namespace fspp { class Node; class File; class Symlink; class OpenFile; class FilesystemImpl final: public fuse::Filesystem { public: explicit FilesystemImpl(Device *device); virtual ~FilesystemImpl(); int openFile(const boost::filesystem::path &path, int flags) override; void flush(int descriptor) override; void closeFile(int descriptor) override; void lstat(const boost::filesystem::path &path, struct ::stat *stbuf) override; void fstat(int descriptor, struct ::stat *stbuf) override; void chmod(const boost::filesystem::path &path, mode_t mode) override; void chown(const boost::filesystem::path &path, uid_t uid, gid_t gid) override; void truncate(const boost::filesystem::path &path, off_t size) override; void ftruncate(int descriptor, off_t size) override; size_t read(int descriptor, void *buf, size_t count, off_t offset) override; void write(int descriptor, const void *buf, size_t count, off_t offset) override; void fsync(int descriptor) override; void fdatasync(int descriptor) override; void access(const boost::filesystem::path &path, int mask) override; int createAndOpenFile(const boost::filesystem::path &path, mode_t mode, uid_t uid, gid_t gid) override; void mkdir(const boost::filesystem::path &path, mode_t mode, uid_t uid, gid_t gid) override; void rmdir(const boost::filesystem::path &path) override; void unlink(const boost::filesystem::path &path) override; void rename(const boost::filesystem::path &from, const boost::filesystem::path &to) override; cpputils::unique_ref> readDir(const boost::filesystem::path &path) override; void utimens(const boost::filesystem::path &path, timespec lastAccessTime, timespec lastModificationTime) override; void statfs(const boost::filesystem::path &path, struct statvfs *fsstat) override; void createSymlink(const boost::filesystem::path &to, const boost::filesystem::path &from, uid_t uid, gid_t gid) override; void readSymlink(const boost::filesystem::path &path, char *buf, size_t size) override; private: cpputils::unique_ref LoadFile(const boost::filesystem::path &path); cpputils::unique_ref LoadDir(const boost::filesystem::path &path); cpputils::unique_ref LoadSymlink(const boost::filesystem::path &path); cpputils::unique_ref LoadFileOrSymlink(const boost::filesystem::path &path); int openFile(File *file, int flags); #ifdef FSPP_PROFILE std::atomic _loadFileNanosec; std::atomic _loadDirNanosec; std::atomic _loadSymlinkNanosec; std::atomic _loadFileOrSymlinkNanosec; std::atomic _openFileNanosec; std::atomic _flushNanosec; std::atomic _closeFileNanosec; std::atomic _lstatNanosec; std::atomic _fstatNanosec; std::atomic _chmodNanosec; std::atomic _chownNanosec; std::atomic _truncateNanosec; std::atomic _ftruncateNanosec; std::atomic _readNanosec; std::atomic _writeNanosec; std::atomic _fsyncNanosec; std::atomic _fdatasyncNanosec; std::atomic _accessNanosec; std::atomic _createAndOpenFileNanosec; std::atomic _createAndOpenFileNanosec_withoutLoading; std::atomic _mkdirNanosec; std::atomic _mkdirNanosec_withoutLoading; std::atomic _rmdirNanosec; std::atomic _rmdirNanosec_withoutLoading; std::atomic _unlinkNanosec; std::atomic _unlinkNanosec_withoutLoading; std::atomic _renameNanosec; std::atomic _readDirNanosec; std::atomic _readDirNanosec_withoutLoading; std::atomic _utimensNanosec; std::atomic _statfsNanosec; std::atomic _createSymlinkNanosec; std::atomic _createSymlinkNanosec_withoutLoading; std::atomic _readSymlinkNanosec; std::atomic _readSymlinkNanosec_withoutLoading; #endif Device *_device; FuseOpenFileList _open_files; DISALLOW_COPY_AND_ASSIGN(FilesystemImpl); }; } #endif src/fspp/impl/FuseOpenFileList.h000066400000000000000000000020111300002025200170610ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_IMPL_FUSEOPENFILELIST_H_ #define MESSMER_FSPP_IMPL_FUSEOPENFILELIST_H_ #include "../fs_interface/File.h" #include "../fs_interface/OpenFile.h" #include #include "IdList.h" namespace fspp { class FuseOpenFileList final { public: FuseOpenFileList(); ~FuseOpenFileList(); int open(cpputils::unique_ref file); OpenFile *get(int descriptor); void close(int descriptor); private: IdList _open_files; DISALLOW_COPY_AND_ASSIGN(FuseOpenFileList); }; inline FuseOpenFileList::FuseOpenFileList() :_open_files() { } inline FuseOpenFileList::~FuseOpenFileList() { } inline int FuseOpenFileList::open(cpputils::unique_ref file) { return _open_files.add(std::move(file)); } inline OpenFile *FuseOpenFileList::get(int descriptor) { return _open_files.get(descriptor); } inline void FuseOpenFileList::close(int descriptor) { //The destructor of the stored FuseOpenFile closes the file _open_files.remove(descriptor); } } #endif src/fspp/impl/IdList.h000066400000000000000000000031141300002025200150760ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_IMPL_IDLIST_H_ #define MESSMER_FSPP_IMPL_IDLIST_H_ #include #include #include #include namespace fspp { template class IdList final { public: IdList(); virtual ~IdList(); int add(cpputils::unique_ref entry); Entry *get(int id); const Entry *get(int id) const; void remove(int id); private: std::map> _entries; int _id_counter; mutable std::mutex _mutex; DISALLOW_COPY_AND_ASSIGN(IdList); }; template IdList::IdList() : _entries(), _id_counter(0), _mutex() { } template IdList::~IdList() { } template int IdList::add(cpputils::unique_ref entry) { std::lock_guard lock(_mutex); //TODO Reuse IDs (ids = descriptors) int new_id = ++_id_counter; _entries.insert(std::make_pair(new_id, std::move(entry))); return new_id; } template Entry *IdList::get(int id) { return const_cast(const_cast*>(this)->get(id)); } template const Entry *IdList::get(int id) const { std::lock_guard lock(_mutex); const Entry *result = _entries.at(id).get(); return result; } template void IdList::remove(int id) { std::lock_guard lock(_mutex); auto found_iter = _entries.find(id); if (found_iter == _entries.end()) { throw std::out_of_range("Called IdList::remove() with an invalid ID"); } _entries.erase(found_iter); } } #endif src/fspp/impl/Profiler.cpp000066400000000000000000000000261300002025200160220ustar00rootroot00000000000000#include "Profiler.h" src/fspp/impl/Profiler.h000066400000000000000000000016611300002025200154750ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_IMPL_PROFILER_H #define MESSMER_FSPP_IMPL_PROFILER_H #include #include #include namespace fspp { class Profiler final { public: Profiler(std::atomic_uint_fast64_t *targetForAddingNanosec); ~Profiler(); private: std::atomic_uint_fast64_t *_targetForAddingNanosec; std::chrono::high_resolution_clock::time_point _beginTime; DISALLOW_COPY_AND_ASSIGN(Profiler); }; inline Profiler::Profiler(std::atomic_uint_fast64_t *targetForAddingNanosec) : _targetForAddingNanosec(targetForAddingNanosec), _beginTime(std::chrono::high_resolution_clock::now()) { } inline Profiler::~Profiler() { uint64_t timeDiff = std::chrono::duration_cast(std::chrono::high_resolution_clock::now() - _beginTime).count(); *_targetForAddingNanosec += timeDiff; } } #endif src/gitversion/000077500000000000000000000000001300002025200140165ustar00rootroot00000000000000src/gitversion/.gitattributes000066400000000000000000000000711300002025200167070ustar00rootroot00000000000000_version_source.py export-subst _version.py export-subst src/gitversion/CMakeLists.txt000066400000000000000000000007211300002025200165560ustar00rootroot00000000000000project (gitversion) include(gitversion.cmake) get_git_version(GIT_VERSION) set(SOURCES gitversion.cpp versionstring.cpp parser.cpp VersionCompare.cpp ) add_library(${PROJECT_NAME} STATIC ${SOURCES}) target_link_libraries(${PROJECT_NAME}) target_compile_definitions(${PROJECT_NAME} PRIVATE GIT_VERSION_STRING="${GIT_VERSION}") target_add_boost(${PROJECT_NAME}) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) src/gitversion/MANIFEST.in000066400000000000000000000001051300002025200155500ustar00rootroot00000000000000include versioneer.py include _version_source.py include _version.py src/gitversion/VersionCompare.cpp000066400000000000000000000030201300002025200174510ustar00rootroot00000000000000#include "VersionCompare.h" #include "parser.h" #include #include using std::string; namespace gitversion { bool VersionCompare::isOlderThan(const string &v1Str, const string &v2Str) { VersionInfo v1 = Parser::parse(v1Str); VersionInfo v2 = Parser::parse(v2Str); unsigned long v1_major = std::stoul(v1.majorVersion); unsigned long v2_major = std::stoul(v2.majorVersion); unsigned long v1_minor = std::stoul(v1.minorVersion); unsigned long v2_minor = std::stoul(v2.minorVersion); unsigned long v1_hotfix = std::stoul(v1.hotfixVersion); unsigned long v2_hotfix = std::stoul(v2.hotfixVersion); int versionTagCompare = _versionTagCompare(v1.versionTag, v2.versionTag); return (v1_major < v2_major) || ((v1_major == v2_major) && ( (v1_minor < v2_minor) || ((v1_minor == v2_minor) && ( (v1_hotfix < v2_hotfix) || ((v1_hotfix == v2_hotfix) && ( (0 > versionTagCompare) || ((0 == versionTagCompare) && ( (v1.commitsSinceTag < v2.commitsSinceTag) )))))))); } int VersionCompare::_versionTagCompare(const string &tag1, const string &tag2) { if (tag1 == "") { if (tag2 == "") { return 0; } else { return 1; } } else { if (tag2 == "") { return -1; } else { return strcmp(tag1.c_str(), tag2.c_str()); } } } } src/gitversion/VersionCompare.h000066400000000000000000000005561300002025200171310ustar00rootroot00000000000000#pragma once #ifndef GITVERSION_VERSIONCOMPARE_H #define GITVERSION_VERSIONCOMPARE_H #include namespace gitversion { class VersionCompare { public: static bool isOlderThan(const std::string &v1, const std::string &v2); private: static int _versionTagCompare(const std::string &tag1, const std::string &tag2); }; } #endif src/gitversion/_version.py000066400000000000000000000410311300002025200162130ustar00rootroot00000000000000 # This file helps to compute a version number in source trees obtained from # git-archive tarball (such as those provided by githubs download-from-tag # feature). Distribution tarballs (built by setup.py sdist) and build # directories (produced by setup.py build) will contain a much shorter file # that just contains the computed version number. # This file is released into the public domain. Generated by # versioneer-0.15+dev (https://github.com/warner/python-versioneer) """Git implementation of _version.py.""" import errno import os import re import subprocess import sys def get_keywords(): """Get the keywords needed to look up the version information.""" # these strings will be replaced by git during git-archive. # setup.py/versioneer.py will grep for the variable names, so they must # each be defined on a line of their own. _version.py will just call # get_keywords(). git_refnames = " (HEAD -> develop, tag: 0.9.6)" git_full = "890d9de0bd3a306811ee6a472afa0592c1f48e82" keywords = {"refnames": git_refnames, "full": git_full} return keywords class VersioneerConfig: """Container for Versioneer configuration parameters.""" def get_config(): """Create, populate and return the VersioneerConfig() object.""" # these strings are filled in when 'setup.py versioneer' creates # _version.py cfg = VersioneerConfig() cfg.VCS = "git" cfg.style = "pep440" cfg.tag_prefix = "" cfg.parentdir_prefix = "cryfs-" cfg.versionfile_source = "_version.py" cfg.verbose = False return cfg class NotThisMethod(Exception): """Exception raised if a method is not valid for the current scenario.""" LONG_VERSION_PY = {} HANDLERS = {} def register_vcs_handler(vcs, method): # decorator """Decorator to mark a method as the handler for a particular VCS.""" def decorate(f): """Store f in HANDLERS[vcs][method].""" if vcs not in HANDLERS: HANDLERS[vcs] = {} HANDLERS[vcs][method] = f return f return decorate def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False): """Call the given command(s).""" assert isinstance(commands, list) p = None for c in commands: try: dispcmd = str([c] + args) # remember shell=False, so use git.cmd on windows, not just git p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE, stderr=(subprocess.PIPE if hide_stderr else None)) break except EnvironmentError: e = sys.exc_info()[1] if e.errno == errno.ENOENT: continue if verbose: print("unable to run %s" % dispcmd) print(e) return None else: if verbose: print("unable to find command, tried %s" % (commands,)) return None stdout = p.communicate()[0].strip() if sys.version_info[0] >= 3: stdout = stdout.decode() if p.returncode != 0: if verbose: print("unable to run %s (error)" % dispcmd) return None return stdout def versions_from_parentdir(parentdir_prefix, root, verbose): """Try to determine the version from the parent directory name. Source tarballs conventionally unpack into a directory that includes both the project name and a version string. """ # -- (MESSMER) CHANGED FOLLOWING LINE TO LOOK IN ../.. instead of . -- dirname = os.path.basename(os.path.abspath(os.path.join(os.path.join(root, '..'), '..'))) if not dirname.startswith(parentdir_prefix): if verbose: print("guessing rootdir is '%s', but '%s' doesn't start with " "prefix '%s'" % (root, dirname, parentdir_prefix)) raise NotThisMethod("rootdir doesn't start with parentdir_prefix") return {"version": dirname[len(parentdir_prefix):], "full-revisionid": None, "dirty": False, "error": None} @register_vcs_handler("git", "get_keywords") def git_get_keywords(versionfile_abs): """Extract version information from the given file.""" # the code embedded in _version.py can just fetch the value of these # keywords. When used from setup.py, we don't want to import _version.py, # so we do it with a regexp instead. This function is not used from # _version.py. keywords = {} try: f = open(versionfile_abs, "r") for line in f.readlines(): if line.strip().startswith("git_refnames ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["refnames"] = mo.group(1) if line.strip().startswith("git_full ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["full"] = mo.group(1) f.close() except EnvironmentError: pass return keywords @register_vcs_handler("git", "keywords") def git_versions_from_keywords(keywords, tag_prefix, verbose): """Get version information from git keywords.""" if not keywords: raise NotThisMethod("no keywords at all, weird") refnames = keywords["refnames"].strip() if refnames.startswith("$Format"): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") refs = set([r.strip() for r in refnames.strip("()").split(",")]) # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %d # expansion behaves like git log --decorate=short and strips out the # refs/heads/ and refs/tags/ prefixes that would let us distinguish # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". tags = set([r for r in refs if re.search(r'\d', r)]) if verbose: print("discarding '%s', no digits" % ",".join(refs-tags)) if verbose: print("likely tags: %s" % ",".join(sorted(tags))) for ref in sorted(tags): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix):] if verbose: print("picking %s" % r) return {"version": r, "full-revisionid": keywords["full"].strip(), "dirty": False, "error": None } # no suitable tags, so version is "0+unknown", but full hex is still there if verbose: print("no suitable tags, using unknown + full revision id") return {"version": "0+unknown", "full-revisionid": keywords["full"].strip(), "dirty": False, "error": "no suitable tags"} @register_vcs_handler("git", "pieces_from_vcs") def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* expanded, and _version.py hasn't already been rewritten with a short version string, meaning we're inside a checked out source tree. """ if not os.path.exists(os.path.join(root, ".git")): if verbose: print("no .git in %s" % root) raise NotThisMethod("no .git directory") GITS = ["git"] if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM) describe_out = run_command(GITS, ["describe", "--tags", "--dirty", "--always", "--long", "--match", "%s*" % tag_prefix], cwd=root) # --long was added in git-1.5.5 if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() full_out = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() pieces = {} pieces["long"] = full_out pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out # look for -dirty suffix dirty = git_describe.endswith("-dirty") pieces["dirty"] = dirty if dirty: git_describe = git_describe[:git_describe.rindex("-dirty")] # now we have TAG-NUM-gHEX or HEX if "-" in git_describe: # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: # unparseable. Maybe git-describe is misbehaving? pieces["error"] = ("unable to parse git-describe output: '%s'" % describe_out) return pieces # tag full_tag = mo.group(1) if not full_tag.startswith(tag_prefix): if verbose: fmt = "tag '%s' doesn't start with prefix '%s'" print(fmt % (full_tag, tag_prefix)) pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" % (full_tag, tag_prefix)) return pieces pieces["closest-tag"] = full_tag[len(tag_prefix):] # distance: number of commits since tag pieces["distance"] = int(mo.group(2)) # commit: short hex revision ID pieces["short"] = mo.group(3) else: # HEX: no tags pieces["closest-tag"] = None count_out = run_command(GITS, ["rev-list", "HEAD", "--count"], cwd=root) pieces["distance"] = int(count_out) # total number of commits return pieces def plus_or_dot(pieces): """Return a + if we don't already have one, else return a .""" if "+" in pieces.get("closest-tag", ""): return "." return "+" def render_pep440(pieces): """Build up version string, with post-release "local version identifier". Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty Exceptions: 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += plus_or_dot(pieces) rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" else: # exception #1 rendered = "0+untagged.%d.g%s" % (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" return rendered def render_pep440_pre(pieces): """TAG[.post.devDISTANCE] -- No -dirty. Exceptions: 1: no tags. 0.post.devDISTANCE """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += ".post.dev%d" % pieces["distance"] else: # exception #1 rendered = "0.post.dev%d" % pieces["distance"] return rendered def render_pep440_post(pieces): """TAG[.postDISTANCE[.dev0]+gHEX] . The ".dev0" means dirty. Note that .dev0 sorts backwards (a dirty tree will appear "older" than the corresponding clean one), but you shouldn't be releasing software with -dirty anyways. Exceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += plus_or_dot(pieces) rendered += "g%s" % pieces["short"] else: # exception #1 rendered = "0.post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += "+g%s" % pieces["short"] return rendered def render_pep440_old(pieces): """TAG[.postDISTANCE[.dev0]] . The ".dev0" means dirty. Eexceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" else: # exception #1 rendered = "0.post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" return rendered def render_git_describe(pieces): """TAG[-DISTANCE-gHEX][-dirty]. Like 'git describe --tags --dirty --always'. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def render_git_describe_long(pieces): """TAG-DISTANCE-gHEX[-dirty]. Like 'git describe --tags --dirty --always -long'. The distance/hash is unconditional. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def render(pieces, style): """Render the given version pieces into the requested style.""" if pieces["error"]: return {"version": "unknown", "full-revisionid": pieces.get("long"), "dirty": None, "error": pieces["error"]} if not style or style == "default": style = "pep440" # the default if style == "pep440": rendered = render_pep440(pieces) elif style == "pep440-pre": rendered = render_pep440_pre(pieces) elif style == "pep440-post": rendered = render_pep440_post(pieces) elif style == "pep440-old": rendered = render_pep440_old(pieces) elif style == "git-describe": rendered = render_git_describe(pieces) elif style == "git-describe-long": rendered = render_git_describe_long(pieces) else: raise ValueError("unknown style '%s'" % style) return {"version": rendered, "full-revisionid": pieces["long"], "dirty": pieces["dirty"], "error": None} def get_versions(): """Get version information or return default if unable to do so.""" # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have # __file__, we can work backwards from there to the root. Some # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which # case we can only use expanded keywords. cfg = get_config() verbose = cfg.verbose try: return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, verbose) except NotThisMethod: pass try: root = os.path.realpath(__file__) # versionfile_source is the relative path from the top of the source # tree (where the .git directory might live) to this file. Invert # this to find the root from __file__. for i in cfg.versionfile_source.split('/'): root = os.path.dirname(root) except NameError: return {"version": "0+unknown", "full-revisionid": None, "dirty": None, "error": "unable to find root of source tree"} try: pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) return render(pieces, cfg.style) except NotThisMethod: pass try: if cfg.parentdir_prefix: return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) except NotThisMethod: pass return {"version": "0+unknown", "full-revisionid": None, "dirty": None, "error": "unable to compute version"} src/gitversion/getversion.py000077500000000000000000000001121300002025200165520ustar00rootroot00000000000000#!/usr/bin/env python import versioneer print(versioneer.get_version()) src/gitversion/gitversion.cmake000066400000000000000000000015551300002025200172170ustar00rootroot00000000000000set(DIR_OF_GITVERSION_TOOL "${CMAKE_CURRENT_LIST_DIR}" CACHE INTERNAL "DIR_OF_GITVERSION_TOOL") function (get_git_version OUTPUT_VARIABLE) EXECUTE_PROCESS(COMMAND ${DIR_OF_GITVERSION_TOOL}/getversion.py OUTPUT_VARIABLE VERSION ERROR_VARIABLE error RESULT_VARIABLE result) STRING(STRIP "${VERSION}" STRIPPED_VERSION) SET(${OUTPUT_VARIABLE} "${STRIPPED_VERSION}" CACHE INTERNAL "${OUTPUT_VARIABLE}") MESSAGE(STATUS "Building version ${${OUTPUT_VARIABLE}}") IF(NOT ${result} EQUAL 0) MESSAGE(FATAL_ERROR "Error running versioneer. Return code is: ${result}, error message is: ${error}") ENDIF() IF("${STRIPPED_VERSION}" EQUAL "0+unknown") MESSAGE(FATAL_ERROR "Unable to find git version information. Please build directly from a git repository (i.e. after git clone).") ENDIF() endfunction(get_git_version) src/gitversion/gitversion.cpp000066400000000000000000000011171300002025200167130ustar00rootroot00000000000000#include "gitversion.h" #include "parser.h" using std::string; namespace gitversion { const VersionInfo &parse() { static VersionInfo versionInfo = Parser::parse(VersionString()); return versionInfo; } bool IsDevVersion() { return parse().isDevVersion; } bool IsStableVersion() { return parse().isStableVersion; } string GitCommitId() { return parse().gitCommitId; } string MajorVersion() { return parse().majorVersion; } string MinorVersion() { return parse().minorVersion; } } src/gitversion/gitversion.h000066400000000000000000000004371300002025200163640ustar00rootroot00000000000000#pragma once #ifndef GITVERSION_GITVERSION_H #define GITVERSION_GITVERSION_H #include "versionstring.h" namespace gitversion { bool IsDevVersion(); bool IsStableVersion(); std::string MajorVersion(); std::string MinorVersion(); std::string GitCommitId(); } #endif src/gitversion/parser.cpp000066400000000000000000000064511300002025200160240ustar00rootroot00000000000000#include "parser.h" #include using std::string; using std::pair; using std::tuple; using std::tie; using boost::optional; using boost::none; using std::istringstream; using std::getline; namespace gitversion { VersionInfo Parser::parse(const string &versionString) { VersionInfo result; string versionNumber; optional versionInfo; tie(versionNumber, versionInfo) = _splitAt(versionString, '+'); tie(result.majorVersion, result.minorVersion, result.hotfixVersion, result.versionTag) = _extractMajorMinorHotfixTag(versionNumber); result.isDevVersion = (versionInfo != none); result.isStableVersion = !result.isDevVersion && (result.versionTag == "" || result.versionTag == "stable"); if (versionInfo != none && *versionInfo != "unknown") { tie(result.gitCommitId, result.commitsSinceTag) = _extractGitCommitIdAndCommitsSinceTag(*versionInfo); } else { result.gitCommitId = ""; result.commitsSinceTag = 0; } return result; } pair> Parser::_splitAt(const string &versionString, char delimiter) { istringstream stream(versionString); string versionNumber; getline(stream, versionNumber, delimiter); if (!stream.good()) { return std::make_pair(versionNumber, none); } else { string versionInfo; getline(stream, versionInfo); return std::make_pair(versionNumber, versionInfo); } } tuple Parser::_extractMajorMinorHotfixTag(const string &versionNumber) { string majorMinorHotfix; optional versionTag; tie(majorMinorHotfix, versionTag) = _splitAt(versionNumber, '-'); string major, minor, hotfix; tie(major, minor, hotfix) = _extractMajorMinorHotfix(majorMinorHotfix); if (versionTag == none) { versionTag = ""; } return std::make_tuple(major, minor, hotfix, *versionTag); } tuple Parser::_extractMajorMinorHotfix(const string &versionNumber) { istringstream stream(versionNumber); string major, minor, hotfix; getline(stream, major, '.'); if (!stream.good()) { minor = "0"; } else { getline(stream, minor, '.'); } if (!stream.good()) { hotfix = "0"; } else { getline(stream, hotfix); } return std::make_tuple(major, minor, hotfix); }; std::tuple Parser::_extractGitCommitIdAndCommitsSinceTag(const string &versionInfo) { istringstream stream(versionInfo); string commitsSinceTag; getline(stream, commitsSinceTag, '.'); if (!stream.good()) { throw std::logic_error("Invalid version information: Missing delimiter after commitsSinceTag (versionInfo: "+versionInfo+")."); } string gitCommitId; getline(stream, gitCommitId, '.'); if (gitCommitId[0] != 'g') { throw std::logic_error("Invalid version information: Git commit id component doesn't start with 'g' (versionInfo: "+versionInfo+")."); } return std::make_tuple(gitCommitId.substr(1), std::stoul(commitsSinceTag)); } }src/gitversion/parser.h000066400000000000000000000021301300002025200154570ustar00rootroot00000000000000#pragma once #ifndef GITVERSION_PARSER_H #define GITVERSION_PARSER_H #include #include #include namespace gitversion { struct VersionInfo { bool isDevVersion; bool isStableVersion; std::string versionTag; std::string gitCommitId; std::string majorVersion; std::string minorVersion; std::string hotfixVersion; unsigned int commitsSinceTag; }; class Parser final { public: static VersionInfo parse(const std::string &versionString); private: static std::pair> _splitAt(const std::string &versionString, char delimiter); static std::tuple _extractMajorMinorHotfixTag(const std::string &versionNumber); static std::tuple _extractMajorMinorHotfix(const std::string &versionNumber); static std::tuple _extractGitCommitIdAndCommitsSinceTag(const std::string &versionInfo); }; } #endif src/gitversion/setup.cfg000066400000000000000000000004611300002025200156400ustar00rootroot00000000000000 # See the docstring in versioneer.py for instructions. Note that you must # re-run 'versioneer.py setup' after changing this section, and commit the # resulting files. [versioneer] VCS = git style = pep440 versionfile_source = _version.py versionfile_build = None tag_prefix = parentdir_prefix = cryfs- src/gitversion/setup.py000066400000000000000000000006171300002025200155340ustar00rootroot00000000000000#!/usr/bin/env python from setuptools import setup import versioneer setup(name='git-version', version=versioneer.get_version(), cmdclass=versioneer.get_cmdclass(), description='Make git version information (e.g. git tag name, git commit id, ...) available to C++ source files.', author='Sebastian Messmer', author_email='messmer@cryfs.org', license='LGPLv3' ) src/gitversion/versioneer.py000066400000000000000000002012501300002025200165510ustar00rootroot00000000000000 # Version: 0.15+dev """The Versioneer - like a rocketeer, but for versions. The Versioneer ============== * like a rocketeer, but for versions! * https://github.com/warner/python-versioneer * Brian Warner * License: Public Domain * Compatible With: python2.6, 2.7, 3.2, 3.3, 3.4, and pypy * [![Latest Version] (https://pypip.in/version/versioneer/badge.svg?style=flat) ](https://pypi.python.org/pypi/versioneer/) * [![Build Status] (https://travis-ci.org/warner/python-versioneer.png?branch=master) ](https://travis-ci.org/warner/python-versioneer) This is a tool for managing a recorded version number in distutils-based python projects. The goal is to remove the tedious and error-prone "update the embedded version string" step from your release process. Making a new release should be as easy as recording a new tag in your version-control system, and maybe making new tarballs. ## Quick Install * `pip install versioneer` to somewhere to your $PATH * add a `[versioneer]` section to your setup.cfg (see below) * run `versioneer install` in your source tree, commit the results ## Version Identifiers Source trees come from a variety of places: * a version-control system checkout (mostly used by developers) * a nightly tarball, produced by build automation * a snapshot tarball, produced by a web-based VCS browser, like github's "tarball from tag" feature * a release tarball, produced by "setup.py sdist", distributed through PyPI Within each source tree, the version identifier (either a string or a number, this tool is format-agnostic) can come from a variety of places: * ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows about recent "tags" and an absolute revision-id * the name of the directory into which the tarball was unpacked * an expanded VCS keyword ($Id$, etc) * a `_version.py` created by some earlier build step For released software, the version identifier is closely related to a VCS tag. Some projects use tag names that include more than just the version string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool needs to strip the tag prefix to extract the version identifier. For unreleased software (between tags), the version identifier should provide enough information to help developers recreate the same tree, while also giving them an idea of roughly how old the tree is (after version 1.2, before version 1.3). Many VCS systems can report a description that captures this, for example `git describe --tags --dirty --always` reports things like "0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the 0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has uncommitted changes. The version identifier is used for multiple purposes: * to allow the module to self-identify its version: `myproject.__version__` * to choose a name and prefix for a 'setup.py sdist' tarball ## Theory of Operation Versioneer works by adding a special `_version.py` file into your source tree, where your `__init__.py` can import it. This `_version.py` knows how to dynamically ask the VCS tool for version information at import time. `_version.py` also contains `$Revision$` markers, and the installation process marks `_version.py` to have this marker rewritten with a tag name during the `git archive` command. As a result, generated tarballs will contain enough information to get the proper version. To allow `setup.py` to compute a version too, a `versioneer.py` is added to the top level of your source tree, next to `setup.py` and the `setup.cfg` that configures it. This overrides several distutils/setuptools commands to compute the version when invoked, and changes `setup.py build` and `setup.py sdist` to replace `_version.py` with a small static file that contains just the generated version data. ## Installation First, decide on values for the following configuration variables: * `VCS`: the version control system you use. Currently accepts "git". * `style`: the style of version string to be produced. See "Styles" below for details. Defaults to "pep440", which looks like `TAG[+DISTANCE.gSHORTHASH[.dirty]]`. * `versionfile_source`: A project-relative pathname into which the generated version strings should be written. This is usually a `_version.py` next to your project's main `__init__.py` file, so it can be imported at runtime. If your project uses `src/myproject/__init__.py`, this should be `src/myproject/_version.py`. This file should be checked in to your VCS as usual: the copy created below by `setup.py setup_versioneer` will include code that parses expanded VCS keywords in generated tarballs. The 'build' and 'sdist' commands will replace it with a copy that has just the calculated version string. This must be set even if your project does not have any modules (and will therefore never import `_version.py`), since "setup.py sdist" -based trees still need somewhere to record the pre-calculated version strings. Anywhere in the source tree should do. If there is a `__init__.py` next to your `_version.py`, the `setup.py setup_versioneer` command (described below) will append some `__version__`-setting assignments, if they aren't already present. * `versionfile_build`: Like `versionfile_source`, but relative to the build directory instead of the source directory. These will differ when your setup.py uses 'package_dir='. If you have `package_dir={'myproject': 'src/myproject'}`, then you will probably have `versionfile_build='myproject/_version.py'` and `versionfile_source='src/myproject/_version.py'`. If this is set to None, then `setup.py build` will not attempt to rewrite any `_version.py` in the built tree. If your project does not have any libraries (e.g. if it only builds a script), then you should use `versionfile_build = None`. To actually use the computed version string, your `setup.py` will need to override `distutils.command.build_scripts` with a subclass that explicitly inserts a copy of `versioneer.get_version()` into your script file. See `test/demoapp-script-only/setup.py` for an example. * `tag_prefix`: a string, like 'PROJECTNAME-', which appears at the start of all VCS tags. If your tags look like 'myproject-1.2.0', then you should use tag_prefix='myproject-'. If you use unprefixed tags like '1.2.0', this should be an empty string, using either `tag_prefix=` or `tag_prefix=''`. * `parentdir_prefix`: a optional string, frequently the same as tag_prefix, which appears at the start of all unpacked tarball filenames. If your tarball unpacks into 'myproject-1.2.0', this should be 'myproject-'. To disable this feature, just omit the field from your `setup.cfg`. This tool provides one script, named `versioneer`. That script has one mode, "install", which writes a copy of `versioneer.py` into the current directory and runs `versioneer.py setup` to finish the installation. To versioneer-enable your project: * 1: Modify your `setup.cfg`, adding a section named `[versioneer]` and populating it with the configuration values you decided earlier (note that the option names are not case-sensitive): ```` [versioneer] VCS = git style = pep440 versionfile_source = src/myproject/_version.py versionfile_build = myproject/_version.py tag_prefix = parentdir_prefix = myproject- ```` * 2: Run `versioneer install`. This will do the following: * copy `versioneer.py` into the top of your source tree * create `_version.py` in the right place (`versionfile_source`) * modify your `__init__.py` (if one exists next to `_version.py`) to define `__version__` (by calling a function from `_version.py`) * modify your `MANIFEST.in` to include both `versioneer.py` and the generated `_version.py` in sdist tarballs `versioneer install` will complain about any problems it finds with your `setup.py` or `setup.cfg`. Run it multiple times until you have fixed all the problems. * 3: add a `import versioneer` to your setup.py, and add the following arguments to the setup() call: version=versioneer.get_version(), cmdclass=versioneer.get_cmdclass(), * 4: commit these changes to your VCS. To make sure you won't forget, `versioneer install` will mark everything it touched for addition using `git add`. Don't forget to add `setup.py` and `setup.cfg` too. ## Post-Installation Usage Once established, all uses of your tree from a VCS checkout should get the current version string. All generated tarballs should include an embedded version string (so users who unpack them will not need a VCS tool installed). If you distribute your project through PyPI, then the release process should boil down to two steps: * 1: git tag 1.0 * 2: python setup.py register sdist upload If you distribute it through github (i.e. users use github to generate tarballs with `git archive`), the process is: * 1: git tag 1.0 * 2: git push; git push --tags Versioneer will report "0+untagged.NUMCOMMITS.gHASH" until your tree has at least one tag in its history. ## Version-String Flavors Code which uses Versioneer can learn about its version string at runtime by importing `_version` from your main `__init__.py` file and running the `get_versions()` function. From the "outside" (e.g. in `setup.py`), you can import the top-level `versioneer.py` and run `get_versions()`. Both functions return a dictionary with different flavors of version information: * `['version']`: A condensed version string, rendered using the selected style. This is the most commonly used value for the project's version string. The default "pep440" style yields strings like `0.11`, `0.11+2.g1076c97`, or `0.11+2.g1076c97.dirty`. See the "Styles" section below for alternative styles. * `['full-revisionid']`: detailed revision identifier. For Git, this is the full SHA1 commit id, e.g. "1076c978a8d3cfc70f408fe5974aa6c092c949ac". * `['dirty']`: a boolean, True if the tree has uncommitted changes. Note that this is only accurate if run in a VCS checkout, otherwise it is likely to be False or None * `['error']`: if the version string could not be computed, this will be set to a string describing the problem, otherwise it will be None. It may be useful to throw an exception in setup.py if this is set, to avoid e.g. creating tarballs with a version string of "unknown". Some variants are more useful than others. Including `full-revisionid` in a bug report should allow developers to reconstruct the exact code being tested (or indicate the presence of local changes that should be shared with the developers). `version` is suitable for display in an "about" box or a CLI `--version` output: it can be easily compared against release notes and lists of bugs fixed in various releases. The installer adds the following text to your `__init__.py` to place a basic version in `YOURPROJECT.__version__`: from ._version import get_versions __version__ = get_versions()['version'] del get_versions ## Styles The setup.cfg `style=` configuration controls how the VCS information is rendered into a version string. The default style, "pep440", produces a PEP440-compliant string, equal to the un-prefixed tag name for actual releases, and containing an additional "local version" section with more detail for in-between builds. For Git, this is TAG[+DISTANCE.gHEX[.dirty]] , using information from `git describe --tags --dirty --always`. For example "0.11+2.g1076c97.dirty" indicates that the tree is like the "1076c97" commit but has uncommitted changes (".dirty"), and that this commit is two revisions ("+2") beyond the "0.11" tag. For released software (exactly equal to a known tag), the identifier will only contain the stripped tag, e.g. "0.11". Other styles are available. See details.md in the Versioneer source tree for descriptions. ## Debugging Versioneer tries to avoid fatal errors: if something goes wrong, it will tend to return a version of "0+unknown". To investigate the problem, run `setup.py version`, which will run the version-lookup code in a verbose mode, and will display the full contents of `get_versions()` (including the `error` string, which may help identify what went wrong). ## Updating Versioneer To upgrade your project to a new release of Versioneer, do the following: * install the new Versioneer (`pip install -U versioneer` or equivalent) * edit `setup.cfg`, if necessary, to include any new configuration settings indicated by the release notes * re-run `versioneer install` in your source tree, to replace `SRC/_version.py` * commit any changed files ### Upgrading to 0.15 Starting with this version, Versioneer is configured with a `[versioneer]` section in your `setup.cfg` file. Earlier versions required the `setup.py` to set attributes on the `versioneer` module immediately after import. The new version will refuse to run (raising an exception during import) until you have provided the necessary `setup.cfg` section. In addition, the Versioneer package provides an executable named `versioneer`, and the installation process is driven by running `versioneer install`. In 0.14 and earlier, the executable was named `versioneer-installer` and was run without an argument. ### Upgrading to 0.14 0.14 changes the format of the version string. 0.13 and earlier used hyphen-separated strings like "0.11-2-g1076c97-dirty". 0.14 and beyond use a plus-separated "local version" section strings, with dot-separated components, like "0.11+2.g1076c97". PEP440-strict tools did not like the old format, but should be ok with the new one. ### Upgrading from 0.11 to 0.12 Nothing special. ### Upgrading from 0.10 to 0.11 You must add a `versioneer.VCS = "git"` to your `setup.py` before re-running `setup.py setup_versioneer`. This will enable the use of additional version-control systems (SVN, etc) in the future. ## Future Directions This tool is designed to make it easily extended to other version-control systems: all VCS-specific components are in separate directories like src/git/ . The top-level `versioneer.py` script is assembled from these components by running make-versioneer.py . In the future, make-versioneer.py will take a VCS name as an argument, and will construct a version of `versioneer.py` that is specific to the given VCS. It might also take the configuration arguments that are currently provided manually during installation by editing setup.py . Alternatively, it might go the other direction and include code from all supported VCS systems, reducing the number of intermediate scripts. ## License To make Versioneer easier to embed, all its code is dedicated to the public domain. The `_version.py` that it creates is also in the public domain. Specifically, both are released under the Creative Commons "Public Domain Dedication" license (CC0-1.0), as described in https://creativecommons.org/publicdomain/zero/1.0/ . """ from __future__ import print_function try: import configparser except ImportError: import ConfigParser as configparser import errno import json import os import re import subprocess import sys class VersioneerConfig: """Container for Versioneer configuration parameters.""" def get_root(): """Get the project root directory. We require that all commands are run from the project root, i.e. the directory that contains setup.py, setup.cfg, and versioneer.py . """ root = os.path.realpath(os.path.abspath(os.getcwd())) setup_py = os.path.join(root, "setup.py") versioneer_py = os.path.join(root, "versioneer.py") if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): # allow 'python path/to/setup.py COMMAND' root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0]))) setup_py = os.path.join(root, "setup.py") versioneer_py = os.path.join(root, "versioneer.py") if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): err = ("Versioneer was unable to run the project root directory. " "Versioneer requires setup.py to be executed from " "its immediate directory (like 'python setup.py COMMAND'), " "or in a way that lets it use sys.argv[0] to find the root " "(like 'python path/to/setup.py COMMAND').") raise VersioneerBadRootError(err) try: # Certain runtime workflows (setup.py install/develop in a setuptools # tree) execute all dependencies in a single python process, so # "versioneer" may be imported multiple times, and python's shared # module-import table will cache the first one. So we can't use # os.path.dirname(__file__), as that will find whichever # versioneer.py was first imported, even in later projects. me = os.path.realpath(os.path.abspath(__file__)) if os.path.splitext(me)[0] != os.path.splitext(versioneer_py)[0]: # -- (MESSMER) changed this to output to stderr instead of stdout, since it caused problems on some systems -- print("Warning: build in %s is using versioneer.py from %s" % (os.path.dirname(me), versioneer_py), file=sys.stderr) except NameError: pass return root def get_config_from_root(root): """Read the project setup.cfg file to determine Versioneer config.""" # This might raise EnvironmentError (if setup.cfg is missing), or # configparser.NoSectionError (if it lacks a [versioneer] section), or # configparser.NoOptionError (if it lacks "VCS="). See the docstring at # the top of versioneer.py for instructions on writing your setup.cfg . setup_cfg = os.path.join(root, "setup.cfg") parser = configparser.SafeConfigParser() with open(setup_cfg, "r") as f: parser.readfp(f) VCS = parser.get("versioneer", "VCS") # mandatory def get(parser, name): if parser.has_option("versioneer", name): return parser.get("versioneer", name) return None cfg = VersioneerConfig() cfg.VCS = VCS cfg.style = get(parser, "style") or "" cfg.versionfile_source = get(parser, "versionfile_source") cfg.versionfile_build = get(parser, "versionfile_build") cfg.tag_prefix = get(parser, "tag_prefix") if cfg.tag_prefix in ("''", '""'): cfg.tag_prefix = "" cfg.parentdir_prefix = get(parser, "parentdir_prefix") cfg.verbose = get(parser, "verbose") return cfg class NotThisMethod(Exception): """Exception raised if a method is not valid for the current scenario.""" # these dictionaries contain VCS-specific tools LONG_VERSION_PY = {} HANDLERS = {} def register_vcs_handler(vcs, method): # decorator """Decorator to mark a method as the handler for a particular VCS.""" def decorate(f): """Store f in HANDLERS[vcs][method].""" if vcs not in HANDLERS: HANDLERS[vcs] = {} HANDLERS[vcs][method] = f return f return decorate def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False): """Call the given command(s).""" assert isinstance(commands, list) p = None for c in commands: try: dispcmd = str([c] + args) # remember shell=False, so use git.cmd on windows, not just git p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE, stderr=(subprocess.PIPE if hide_stderr else None)) break except EnvironmentError: e = sys.exc_info()[1] if e.errno == errno.ENOENT: continue if verbose: print("unable to run %s" % dispcmd) print(e) return None else: if verbose: print("unable to find command, tried %s" % (commands,)) return None stdout = p.communicate()[0].strip() if sys.version_info[0] >= 3: stdout = stdout.decode() if p.returncode != 0: if verbose: print("unable to run %s (error)" % dispcmd) return None return stdout LONG_VERSION_PY['git'] = ''' # This file helps to compute a version number in source trees obtained from # git-archive tarball (such as those provided by githubs download-from-tag # feature). Distribution tarballs (built by setup.py sdist) and build # directories (produced by setup.py build) will contain a much shorter file # that just contains the computed version number. # This file is released into the public domain. Generated by # versioneer-0.15+dev (https://github.com/warner/python-versioneer) """Git implementation of _version.py.""" import errno import os import re import subprocess import sys def get_keywords(): """Get the keywords needed to look up the version information.""" # these strings will be replaced by git during git-archive. # setup.py/versioneer.py will grep for the variable names, so they must # each be defined on a line of their own. _version.py will just call # get_keywords(). git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" keywords = {"refnames": git_refnames, "full": git_full} return keywords class VersioneerConfig: """Container for Versioneer configuration parameters.""" def get_config(): """Create, populate and return the VersioneerConfig() object.""" # these strings are filled in when 'setup.py versioneer' creates # _version.py cfg = VersioneerConfig() cfg.VCS = "git" cfg.style = "%(STYLE)s" cfg.tag_prefix = "%(TAG_PREFIX)s" cfg.parentdir_prefix = "%(PARENTDIR_PREFIX)s" cfg.versionfile_source = "%(VERSIONFILE_SOURCE)s" cfg.verbose = False return cfg class NotThisMethod(Exception): """Exception raised if a method is not valid for the current scenario.""" LONG_VERSION_PY = {} HANDLERS = {} def register_vcs_handler(vcs, method): # decorator """Decorator to mark a method as the handler for a particular VCS.""" def decorate(f): """Store f in HANDLERS[vcs][method].""" if vcs not in HANDLERS: HANDLERS[vcs] = {} HANDLERS[vcs][method] = f return f return decorate def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False): """Call the given command(s).""" assert isinstance(commands, list) p = None for c in commands: try: dispcmd = str([c] + args) # remember shell=False, so use git.cmd on windows, not just git p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE, stderr=(subprocess.PIPE if hide_stderr else None)) break except EnvironmentError: e = sys.exc_info()[1] if e.errno == errno.ENOENT: continue if verbose: print("unable to run %%s" %% dispcmd) print(e) return None else: if verbose: print("unable to find command, tried %%s" %% (commands,)) return None stdout = p.communicate()[0].strip() if sys.version_info[0] >= 3: stdout = stdout.decode() if p.returncode != 0: if verbose: print("unable to run %%s (error)" %% dispcmd) return None return stdout def versions_from_parentdir(parentdir_prefix, root, verbose): """Try to determine the version from the parent directory name. Source tarballs conventionally unpack into a directory that includes both the project name and a version string. """ # -- (MESSMER) CHANGED FOLLOWING LINE TO LOOK IN ../.. instead of . -- dirname = os.path.basename(os.path.abspath(os.path.join(os.path.join(root, '..'), '..'))) if not dirname.startswith(parentdir_prefix): if verbose: print("guessing rootdir is '%%s', but '%%s' doesn't start with " "prefix '%%s'" %% (root, dirname, parentdir_prefix)) raise NotThisMethod("rootdir doesn't start with parentdir_prefix") return {"version": dirname[len(parentdir_prefix):], "full-revisionid": None, "dirty": False, "error": None} @register_vcs_handler("git", "get_keywords") def git_get_keywords(versionfile_abs): """Extract version information from the given file.""" # the code embedded in _version.py can just fetch the value of these # keywords. When used from setup.py, we don't want to import _version.py, # so we do it with a regexp instead. This function is not used from # _version.py. keywords = {} try: f = open(versionfile_abs, "r") for line in f.readlines(): if line.strip().startswith("git_refnames ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["refnames"] = mo.group(1) if line.strip().startswith("git_full ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["full"] = mo.group(1) f.close() except EnvironmentError: pass return keywords @register_vcs_handler("git", "keywords") def git_versions_from_keywords(keywords, tag_prefix, verbose): """Get version information from git keywords.""" if not keywords: raise NotThisMethod("no keywords at all, weird") refnames = keywords["refnames"].strip() if refnames.startswith("$Format"): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") refs = set([r.strip() for r in refnames.strip("()").split(",")]) # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %%d # expansion behaves like git log --decorate=short and strips out the # refs/heads/ and refs/tags/ prefixes that would let us distinguish # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". tags = set([r for r in refs if re.search(r'\d', r)]) if verbose: print("discarding '%%s', no digits" %% ",".join(refs-tags)) if verbose: print("likely tags: %%s" %% ",".join(sorted(tags))) for ref in sorted(tags): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix):] if verbose: print("picking %%s" %% r) return {"version": r, "full-revisionid": keywords["full"].strip(), "dirty": False, "error": None } # no suitable tags, so version is "0+unknown", but full hex is still there if verbose: print("no suitable tags, using unknown + full revision id") return {"version": "0+unknown", "full-revisionid": keywords["full"].strip(), "dirty": False, "error": "no suitable tags"} @register_vcs_handler("git", "pieces_from_vcs") def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* expanded, and _version.py hasn't already been rewritten with a short version string, meaning we're inside a checked out source tree. """ if not os.path.exists(os.path.join(root, ".git")): if verbose: print("no .git in %%s" %% root) raise NotThisMethod("no .git directory") GITS = ["git"] if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM) describe_out = run_command(GITS, ["describe", "--tags", "--dirty", "--always", "--long", "--match", "%%s*" %% tag_prefix], cwd=root) # --long was added in git-1.5.5 if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() full_out = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() pieces = {} pieces["long"] = full_out pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out # look for -dirty suffix dirty = git_describe.endswith("-dirty") pieces["dirty"] = dirty if dirty: git_describe = git_describe[:git_describe.rindex("-dirty")] # now we have TAG-NUM-gHEX or HEX if "-" in git_describe: # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: # unparseable. Maybe git-describe is misbehaving? pieces["error"] = ("unable to parse git-describe output: '%%s'" %% describe_out) return pieces # tag full_tag = mo.group(1) if not full_tag.startswith(tag_prefix): if verbose: fmt = "tag '%%s' doesn't start with prefix '%%s'" print(fmt %% (full_tag, tag_prefix)) pieces["error"] = ("tag '%%s' doesn't start with prefix '%%s'" %% (full_tag, tag_prefix)) return pieces pieces["closest-tag"] = full_tag[len(tag_prefix):] # distance: number of commits since tag pieces["distance"] = int(mo.group(2)) # commit: short hex revision ID pieces["short"] = mo.group(3) else: # HEX: no tags pieces["closest-tag"] = None count_out = run_command(GITS, ["rev-list", "HEAD", "--count"], cwd=root) pieces["distance"] = int(count_out) # total number of commits return pieces def plus_or_dot(pieces): """Return a + if we don't already have one, else return a .""" if "+" in pieces.get("closest-tag", ""): return "." return "+" def render_pep440(pieces): """Build up version string, with post-release "local version identifier". Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty Exceptions: 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += plus_or_dot(pieces) rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" else: # exception #1 rendered = "0+untagged.%%d.g%%s" %% (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" return rendered def render_pep440_pre(pieces): """TAG[.post.devDISTANCE] -- No -dirty. Exceptions: 1: no tags. 0.post.devDISTANCE """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += ".post.dev%%d" %% pieces["distance"] else: # exception #1 rendered = "0.post.dev%%d" %% pieces["distance"] return rendered def render_pep440_post(pieces): """TAG[.postDISTANCE[.dev0]+gHEX] . The ".dev0" means dirty. Note that .dev0 sorts backwards (a dirty tree will appear "older" than the corresponding clean one), but you shouldn't be releasing software with -dirty anyways. Exceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%%d" %% pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += plus_or_dot(pieces) rendered += "g%%s" %% pieces["short"] else: # exception #1 rendered = "0.post%%d" %% pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += "+g%%s" %% pieces["short"] return rendered def render_pep440_old(pieces): """TAG[.postDISTANCE[.dev0]] . The ".dev0" means dirty. Eexceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%%d" %% pieces["distance"] if pieces["dirty"]: rendered += ".dev0" else: # exception #1 rendered = "0.post%%d" %% pieces["distance"] if pieces["dirty"]: rendered += ".dev0" return rendered def render_git_describe(pieces): """TAG[-DISTANCE-gHEX][-dirty]. Like 'git describe --tags --dirty --always'. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def render_git_describe_long(pieces): """TAG-DISTANCE-gHEX[-dirty]. Like 'git describe --tags --dirty --always -long'. The distance/hash is unconditional. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def render(pieces, style): """Render the given version pieces into the requested style.""" if pieces["error"]: return {"version": "unknown", "full-revisionid": pieces.get("long"), "dirty": None, "error": pieces["error"]} if not style or style == "default": style = "pep440" # the default if style == "pep440": rendered = render_pep440(pieces) elif style == "pep440-pre": rendered = render_pep440_pre(pieces) elif style == "pep440-post": rendered = render_pep440_post(pieces) elif style == "pep440-old": rendered = render_pep440_old(pieces) elif style == "git-describe": rendered = render_git_describe(pieces) elif style == "git-describe-long": rendered = render_git_describe_long(pieces) else: raise ValueError("unknown style '%%s'" %% style) return {"version": rendered, "full-revisionid": pieces["long"], "dirty": pieces["dirty"], "error": None} def get_versions(): """Get version information or return default if unable to do so.""" # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have # __file__, we can work backwards from there to the root. Some # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which # case we can only use expanded keywords. cfg = get_config() verbose = cfg.verbose try: return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, verbose) except NotThisMethod: pass try: root = os.path.realpath(__file__) # versionfile_source is the relative path from the top of the source # tree (where the .git directory might live) to this file. Invert # this to find the root from __file__. for i in cfg.versionfile_source.split('/'): root = os.path.dirname(root) except NameError: return {"version": "0+unknown", "full-revisionid": None, "dirty": None, "error": "unable to find root of source tree"} try: pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) return render(pieces, cfg.style) except NotThisMethod: pass try: if cfg.parentdir_prefix: return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) except NotThisMethod: pass return {"version": "0+unknown", "full-revisionid": None, "dirty": None, "error": "unable to compute version"} ''' @register_vcs_handler("git", "get_keywords") def git_get_keywords(versionfile_abs): """Extract version information from the given file.""" # the code embedded in _version.py can just fetch the value of these # keywords. When used from setup.py, we don't want to import _version.py, # so we do it with a regexp instead. This function is not used from # _version.py. keywords = {} try: f = open(versionfile_abs, "r") for line in f.readlines(): if line.strip().startswith("git_refnames ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["refnames"] = mo.group(1) if line.strip().startswith("git_full ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["full"] = mo.group(1) f.close() except EnvironmentError: pass return keywords @register_vcs_handler("git", "keywords") def git_versions_from_keywords(keywords, tag_prefix, verbose): """Get version information from git keywords.""" if not keywords: raise NotThisMethod("no keywords at all, weird") refnames = keywords["refnames"].strip() if refnames.startswith("$Format"): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") refs = set([r.strip() for r in refnames.strip("()").split(",")]) # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %d # expansion behaves like git log --decorate=short and strips out the # refs/heads/ and refs/tags/ prefixes that would let us distinguish # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". tags = set([r for r in refs if re.search(r'\d', r)]) if verbose: print("discarding '%s', no digits" % ",".join(refs-tags)) if verbose: print("likely tags: %s" % ",".join(sorted(tags))) for ref in sorted(tags): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix):] if verbose: print("picking %s" % r) return {"version": r, "full-revisionid": keywords["full"].strip(), "dirty": False, "error": None } # no suitable tags, so version is "0+unknown", but full hex is still there if verbose: print("no suitable tags, using unknown + full revision id") return {"version": "0+unknown", "full-revisionid": keywords["full"].strip(), "dirty": False, "error": "no suitable tags"} @register_vcs_handler("git", "pieces_from_vcs") def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* expanded, and _version.py hasn't already been rewritten with a short version string, meaning we're inside a checked out source tree. """ # -- (MESSMER) CHANGED FOLLOWING LINE TO LOOK FOR ../../.git instead of .git -- if not os.path.exists(os.path.join(root, "../../.git")): if verbose: print("no .git in %s" % root) raise NotThisMethod("no .git directory") GITS = ["git"] if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM) describe_out = run_command(GITS, ["describe", "--tags", "--dirty", "--always", "--long", "--match", "%s*" % tag_prefix], cwd=root) # --long was added in git-1.5.5 if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() full_out = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() pieces = {} pieces["long"] = full_out pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out # look for -dirty suffix dirty = git_describe.endswith("-dirty") pieces["dirty"] = dirty if dirty: git_describe = git_describe[:git_describe.rindex("-dirty")] # now we have TAG-NUM-gHEX or HEX if "-" in git_describe: # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: # unparseable. Maybe git-describe is misbehaving? pieces["error"] = ("unable to parse git-describe output: '%s'" % describe_out) return pieces # tag full_tag = mo.group(1) if not full_tag.startswith(tag_prefix): if verbose: fmt = "tag '%s' doesn't start with prefix '%s'" print(fmt % (full_tag, tag_prefix)) pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" % (full_tag, tag_prefix)) return pieces pieces["closest-tag"] = full_tag[len(tag_prefix):] # distance: number of commits since tag pieces["distance"] = int(mo.group(2)) # commit: short hex revision ID pieces["short"] = mo.group(3) else: # HEX: no tags pieces["closest-tag"] = None count_out = run_command(GITS, ["rev-list", "HEAD", "--count"], cwd=root) pieces["distance"] = int(count_out) # total number of commits return pieces def do_vcs_install(manifest_in, versionfile_source, ipy): """Git-specific installation logic for Versioneer. For Git, this means creating/changing .gitattributes to mark _version.py for export-time keyword substitution. """ GITS = ["git"] if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] files = [manifest_in, versionfile_source] if ipy: files.append(ipy) try: me = __file__ if me.endswith(".pyc") or me.endswith(".pyo"): me = os.path.splitext(me)[0] + ".py" versioneer_file = os.path.relpath(me) except NameError: versioneer_file = "versioneer.py" files.append(versioneer_file) present = False try: f = open(".gitattributes", "r") for line in f.readlines(): if line.strip().startswith(versionfile_source): if "export-subst" in line.strip().split()[1:]: present = True f.close() except EnvironmentError: pass if not present: f = open(".gitattributes", "a+") f.write("%s export-subst\n" % versionfile_source) f.close() files.append(".gitattributes") run_command(GITS, ["add", "--"] + files) def versions_from_parentdir(parentdir_prefix, root, verbose): """Try to determine the version from the parent directory name. Source tarballs conventionally unpack into a directory that includes both the project name and a version string. """ # -- (MESSMER) CHANGED FOLLOWING LINE TO LOOK IN ../.. instead of . -- dirname = os.path.basename(os.path.abspath(os.path.join(os.path.join(root, '..'), '..'))) if not dirname.startswith(parentdir_prefix): if verbose: print("guessing rootdir is '%s', but '%s' doesn't start with " "prefix '%s'" % (root, dirname, parentdir_prefix)) raise NotThisMethod("rootdir doesn't start with parentdir_prefix") return {"version": dirname[len(parentdir_prefix):], "full-revisionid": None, "dirty": False, "error": None} SHORT_VERSION_PY = """ # This file was generated by 'versioneer.py' (0.15+dev) from # revision-control system data, or from the parent directory name of an # unpacked source archive. Distribution tarballs contain a pre-generated copy # of this file. import json import sys version_json = ''' %s ''' # END VERSION_JSON def get_versions(): return json.loads(version_json) """ def versions_from_file(filename): """Try to determine the version from _version.py if present.""" try: with open(filename) as f: contents = f.read() except EnvironmentError: raise NotThisMethod("unable to read _version.py") mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", contents, re.M | re.S) if not mo: raise NotThisMethod("no version_json in _version.py") return json.loads(mo.group(1)) def write_to_version_file(filename, versions): """Write the given version number to the given _version.py file.""" os.unlink(filename) contents = json.dumps(versions, sort_keys=True, indent=1, separators=(",", ": ")) with open(filename, "w") as f: f.write(SHORT_VERSION_PY % contents) print("set %s to '%s'" % (filename, versions["version"])) def plus_or_dot(pieces): """Return a + if we don't already have one, else return a .""" if "+" in pieces.get("closest-tag", ""): return "." return "+" def render_pep440(pieces): """Build up version string, with post-release "local version identifier". Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty Exceptions: 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += plus_or_dot(pieces) rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" else: # exception #1 rendered = "0+untagged.%d.g%s" % (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" return rendered def render_pep440_pre(pieces): """TAG[.post.devDISTANCE] -- No -dirty. Exceptions: 1: no tags. 0.post.devDISTANCE """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += ".post.dev%d" % pieces["distance"] else: # exception #1 rendered = "0.post.dev%d" % pieces["distance"] return rendered def render_pep440_post(pieces): """TAG[.postDISTANCE[.dev0]+gHEX] . The ".dev0" means dirty. Note that .dev0 sorts backwards (a dirty tree will appear "older" than the corresponding clean one), but you shouldn't be releasing software with -dirty anyways. Exceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += plus_or_dot(pieces) rendered += "g%s" % pieces["short"] else: # exception #1 rendered = "0.post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += "+g%s" % pieces["short"] return rendered def render_pep440_old(pieces): """TAG[.postDISTANCE[.dev0]] . The ".dev0" means dirty. Eexceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" else: # exception #1 rendered = "0.post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" return rendered def render_git_describe(pieces): """TAG[-DISTANCE-gHEX][-dirty]. Like 'git describe --tags --dirty --always'. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def render_git_describe_long(pieces): """TAG-DISTANCE-gHEX[-dirty]. Like 'git describe --tags --dirty --always -long'. The distance/hash is unconditional. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def render(pieces, style): """Render the given version pieces into the requested style.""" if pieces["error"]: return {"version": "unknown", "full-revisionid": pieces.get("long"), "dirty": None, "error": pieces["error"]} if not style or style == "default": style = "pep440" # the default if style == "pep440": rendered = render_pep440(pieces) elif style == "pep440-pre": rendered = render_pep440_pre(pieces) elif style == "pep440-post": rendered = render_pep440_post(pieces) elif style == "pep440-old": rendered = render_pep440_old(pieces) elif style == "git-describe": rendered = render_git_describe(pieces) elif style == "git-describe-long": rendered = render_git_describe_long(pieces) else: raise ValueError("unknown style '%s'" % style) return {"version": rendered, "full-revisionid": pieces["long"], "dirty": pieces["dirty"], "error": None} class VersioneerBadRootError(Exception): """The project root directory is unknown or missing key files.""" def get_versions(verbose=False): """Get the project version from whatever source is available. Returns dict with two keys: 'version' and 'full'. """ if "versioneer" in sys.modules: # see the discussion in cmdclass.py:get_cmdclass() del sys.modules["versioneer"] root = get_root() cfg = get_config_from_root(root) assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg" handlers = HANDLERS.get(cfg.VCS) assert handlers, "unrecognized VCS '%s'" % cfg.VCS verbose = verbose or cfg.verbose assert cfg.versionfile_source is not None, \ "please set versioneer.versionfile_source" assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" versionfile_abs = os.path.join(root, cfg.versionfile_source) # extract version from first of: _version.py, VCS command (e.g. 'git # describe'), parentdir. This is meant to work for developers using a # source checkout, for users of a tarball created by 'setup.py sdist', # and for users of a tarball/zipball created by 'git archive' or github's # download-from-tag feature or the equivalent in other VCSes. get_keywords_f = handlers.get("get_keywords") from_keywords_f = handlers.get("keywords") if get_keywords_f and from_keywords_f: try: keywords = get_keywords_f(versionfile_abs) ver = from_keywords_f(keywords, cfg.tag_prefix, verbose) if verbose: print("got version from expanded keyword %s" % ver) return ver except NotThisMethod: pass try: ver = versions_from_file(versionfile_abs) if verbose: print("got version from file %s %s" % (versionfile_abs, ver)) return ver except NotThisMethod: pass from_vcs_f = handlers.get("pieces_from_vcs") if from_vcs_f: try: pieces = from_vcs_f(cfg.tag_prefix, root, verbose) ver = render(pieces, cfg.style) if verbose: print("got version from VCS %s" % ver) return ver except NotThisMethod: pass try: if cfg.parentdir_prefix: ver = versions_from_parentdir(cfg.parentdir_prefix, root, verbose) if verbose: print("got version from parentdir %s" % ver) return ver except NotThisMethod: pass if verbose: print("unable to compute version") return {"version": "0+unknown", "full-revisionid": None, "dirty": None, "error": "unable to compute version"} def get_version(): """Get the short version string for this project.""" return get_versions()["version"] def get_cmdclass(): """Get the custom setuptools/distutils subclasses used by Versioneer.""" if "versioneer" in sys.modules: del sys.modules["versioneer"] # this fixes the "python setup.py develop" case (also 'install' and # 'easy_install .'), in which subdependencies of the main project are # built (using setup.py bdist_egg) in the same python process. Assume # a main project A and a dependency B, which use different versions # of Versioneer. A's setup.py imports A's Versioneer, leaving it in # sys.modules by the time B's setup.py is executed, causing B to run # with the wrong versioneer. Setuptools wraps the sub-dep builds in a # sandbox that restores sys.modules to it's pre-build state, so the # parent is protected against the child's "import versioneer". By # removing ourselves from sys.modules here, before the child build # happens, we protect the child from the parent's versioneer too. # Also see https://github.com/warner/python-versioneer/issues/52 cmds = {} # we add "version" to both distutils and setuptools from distutils.core import Command class cmd_version(Command): description = "report generated version string" user_options = [] boolean_options = [] def initialize_options(self): pass def finalize_options(self): pass def run(self): vers = get_versions(verbose=True) print("Version: %s" % vers["version"]) print(" full-revisionid: %s" % vers.get("full-revisionid")) print(" dirty: %s" % vers.get("dirty")) if vers["error"]: print(" error: %s" % vers["error"]) cmds["version"] = cmd_version # we override "build_py" in both distutils and setuptools # # most invocation pathways end up running build_py: # distutils/build -> build_py # distutils/install -> distutils/build ->.. # setuptools/bdist_wheel -> distutils/install ->.. # setuptools/bdist_egg -> distutils/install_lib -> build_py # setuptools/install -> bdist_egg ->.. # setuptools/develop -> ? # we override different "build_py" commands for both environments if "setuptools" in sys.modules: from setuptools.command.build_py import build_py as _build_py else: from distutils.command.build_py import build_py as _build_py class cmd_build_py(_build_py): def run(self): root = get_root() cfg = get_config_from_root(root) versions = get_versions() _build_py.run(self) # now locate _version.py in the new build/ directory and replace # it with an updated value if cfg.versionfile_build: target_versionfile = os.path.join(self.build_lib, cfg.versionfile_build) print("UPDATING %s" % target_versionfile) write_to_version_file(target_versionfile, versions) cmds["build_py"] = cmd_build_py if "cx_Freeze" in sys.modules: # cx_freeze enabled? from cx_Freeze.dist import build_exe as _build_exe class cmd_build_exe(_build_exe): def run(self): root = get_root() cfg = get_config_from_root(root) versions = get_versions() target_versionfile = cfg.versionfile_source print("UPDATING %s" % target_versionfile) write_to_version_file(target_versionfile, versions) _build_exe.run(self) os.unlink(target_versionfile) with open(cfg.versionfile_source, "w") as f: LONG = LONG_VERSION_PY[cfg.VCS] f.write(LONG % {"DOLLAR": "$", "STYLE": cfg.style, "TAG_PREFIX": cfg.tag_prefix, "PARENTDIR_PREFIX": cfg.parentdir_prefix, "VERSIONFILE_SOURCE": cfg.versionfile_source, }) cmds["build_exe"] = cmd_build_exe del cmds["build_py"] # we override different "sdist" commands for both environments if "setuptools" in sys.modules: from setuptools.command.sdist import sdist as _sdist else: from distutils.command.sdist import sdist as _sdist class cmd_sdist(_sdist): def run(self): versions = get_versions() self._versioneer_generated_versions = versions # unless we update this, the command will keep using the old # version self.distribution.metadata.version = versions["version"] return _sdist.run(self) def make_release_tree(self, base_dir, files): root = get_root() cfg = get_config_from_root(root) _sdist.make_release_tree(self, base_dir, files) # now locate _version.py in the new base_dir directory # (remembering that it may be a hardlink) and replace it with an # updated value target_versionfile = os.path.join(base_dir, cfg.versionfile_source) print("UPDATING %s" % target_versionfile) write_to_version_file(target_versionfile, self._versioneer_generated_versions) cmds["sdist"] = cmd_sdist return cmds CONFIG_ERROR = """ setup.cfg is missing the necessary Versioneer configuration. You need a section like: [versioneer] VCS = git style = pep440 versionfile_source = src/myproject/_version.py versionfile_build = myproject/_version.py tag_prefix = parentdir_prefix = myproject- You will also need to edit your setup.py to use the results: import versioneer setup(version=versioneer.get_version(), cmdclass=versioneer.get_cmdclass(), ...) Please read the docstring in ./versioneer.py for configuration instructions, edit setup.cfg, and re-run the installer or 'python versioneer.py setup'. """ SAMPLE_CONFIG = """ # See the docstring in versioneer.py for instructions. Note that you must # re-run 'versioneer.py setup' after changing this section, and commit the # resulting files. [versioneer] #VCS = git #style = pep440 #versionfile_source = #versionfile_build = #tag_prefix = #parentdir_prefix = """ INIT_PY_SNIPPET = """ from ._version import get_versions __version__ = get_versions()['version'] del get_versions """ def do_setup(): """Main VCS-independent setup function for installing Versioneer.""" root = get_root() try: cfg = get_config_from_root(root) except (EnvironmentError, configparser.NoSectionError, configparser.NoOptionError) as e: if isinstance(e, (EnvironmentError, configparser.NoSectionError)): print("Adding sample versioneer config to setup.cfg", file=sys.stderr) with open(os.path.join(root, "setup.cfg"), "a") as f: f.write(SAMPLE_CONFIG) print(CONFIG_ERROR, file=sys.stderr) return 1 print(" creating %s" % cfg.versionfile_source) with open(cfg.versionfile_source, "w") as f: LONG = LONG_VERSION_PY[cfg.VCS] f.write(LONG % {"DOLLAR": "$", "STYLE": cfg.style, "TAG_PREFIX": cfg.tag_prefix, "PARENTDIR_PREFIX": cfg.parentdir_prefix, "VERSIONFILE_SOURCE": cfg.versionfile_source, }) ipy = os.path.join(os.path.dirname(cfg.versionfile_source), "__init__.py") if os.path.exists(ipy): try: with open(ipy, "r") as f: old = f.read() except EnvironmentError: old = "" if INIT_PY_SNIPPET not in old: print(" appending to %s" % ipy) with open(ipy, "a") as f: f.write(INIT_PY_SNIPPET) else: print(" %s unmodified" % ipy) else: print(" %s doesn't exist, ok" % ipy) ipy = None # Make sure both the top-level "versioneer.py" and versionfile_source # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so # they'll be copied into source distributions. Pip won't be able to # install the package without this. manifest_in = os.path.join(root, "MANIFEST.in") simple_includes = set() try: with open(manifest_in, "r") as f: for line in f: if line.startswith("include "): for include in line.split()[1:]: simple_includes.add(include) except EnvironmentError: pass # That doesn't cover everything MANIFEST.in can do # (http://docs.python.org/2/distutils/sourcedist.html#commands), so # it might give some false negatives. Appending redundant 'include' # lines is safe, though. if "versioneer.py" not in simple_includes: print(" appending 'versioneer.py' to MANIFEST.in") with open(manifest_in, "a") as f: f.write("include versioneer.py\n") else: print(" 'versioneer.py' already in MANIFEST.in") if cfg.versionfile_source not in simple_includes: print(" appending versionfile_source ('%s') to MANIFEST.in" % cfg.versionfile_source) with open(manifest_in, "a") as f: f.write("include %s\n" % cfg.versionfile_source) else: print(" versionfile_source already in MANIFEST.in") # Make VCS-specific changes. For git, this means creating/changing # .gitattributes to mark _version.py for export-time keyword # substitution. do_vcs_install(manifest_in, cfg.versionfile_source, ipy) return 0 def scan_setup_py(): """Validate the contents of setup.py against Versioneer's expectations.""" found = set() setters = False errors = 0 with open("setup.py", "r") as f: for line in f.readlines(): if "import versioneer" in line: found.add("import") if "versioneer.get_cmdclass()" in line: found.add("cmdclass") if "versioneer.get_version()" in line: found.add("get_version") if "versioneer.VCS" in line: setters = True if "versioneer.versionfile_source" in line: setters = True if len(found) != 3: print("") print("Your setup.py appears to be missing some important items") print("(but I might be wrong). Please make sure it has something") print("roughly like the following:") print("") print(" import versioneer") print(" setup( version=versioneer.get_version(),") print(" cmdclass=versioneer.get_cmdclass(), ...)") print("") errors += 1 if setters: print("You should remove lines like 'versioneer.VCS = ' and") print("'versioneer.versionfile_source = ' . This configuration") print("now lives in setup.cfg, and should be removed from setup.py") print("") errors += 1 return errors if __name__ == "__main__": cmd = sys.argv[1] if cmd == "setup": errors = do_setup() errors += scan_setup_py() if errors: sys.exit(1) src/gitversion/versionstring.cpp000066400000000000000000000004161300002025200174370ustar00rootroot00000000000000#include "versionstring.h" using std::string; namespace gitversion { const string &VersionString() { static const string VERSION_STRING = GIT_VERSION_STRING; // GIT_VERSION_STRING is set by our CMake file as a macro return VERSION_STRING; } } src/gitversion/versionstring.h000066400000000000000000000002601300002025200171010ustar00rootroot00000000000000#pragma once #ifndef GITVERSION_VERSIONSTRING_H #define GITVERSION_VERSIONSTRING_H #include namespace gitversion { const std::string &VersionString(); } #endif src/parallelaccessstore/000077500000000000000000000000001300002025200156605ustar00rootroot00000000000000src/parallelaccessstore/CMakeLists.txt000066400000000000000000000005061300002025200204210ustar00rootroot00000000000000project (parallelaccessstore) set(SOURCES ParallelAccessBaseStore.cpp ParallelAccessStore.cpp ) add_library(${PROJECT_NAME} STATIC ${SOURCES}) target_link_libraries(${PROJECT_NAME} PUBLIC cpp-utils) target_add_boost(${PROJECT_NAME}) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) src/parallelaccessstore/ParallelAccessBaseStore.cpp000066400000000000000000000000441300002025200230500ustar00rootroot00000000000000#include "ParallelAccessBaseStore.h"src/parallelaccessstore/ParallelAccessBaseStore.h000066400000000000000000000010471300002025200225210ustar00rootroot00000000000000#pragma once #ifndef MESSMER_PARALLELACCESSSTORE_PARALLELACCESSBASESTORE_H_ #define MESSMER_PARALLELACCESSSTORE_PARALLELACCESSBASESTORE_H_ #include #include namespace parallelaccessstore { template class ParallelAccessBaseStore { public: virtual ~ParallelAccessBaseStore() {} virtual boost::optional> loadFromBaseStore(const Key &key) = 0; virtual void removeFromBaseStore(cpputils::unique_ref block) = 0; }; } #endif src/parallelaccessstore/ParallelAccessStore.cpp000066400000000000000000000000401300002025200222510ustar00rootroot00000000000000#include "ParallelAccessStore.h"src/parallelaccessstore/ParallelAccessStore.h000066400000000000000000000202521300002025200217250ustar00rootroot00000000000000#pragma once #ifndef MESSMER_PARALLELACCESSSTORE_PARALLELACCESSSTORE_H_ #define MESSMER_PARALLELACCESSSTORE_PARALLELACCESSSTORE_H_ #include #include #include #include #include #include #include #include #include "ParallelAccessBaseStore.h" #include //TODO Refactor //TODO Test cases namespace parallelaccessstore { template class ParallelAccessStore final { public: explicit ParallelAccessStore(cpputils::unique_ref> baseStore); ~ParallelAccessStore() { ASSERT(_openResources.size() == 0, "Still resources open when trying to destruct"); ASSERT(_resourcesToRemove.size() == 0, "Still resources to remove when trying to destruct"); }; class ResourceRefBase { public: //TODO Better way to initialize ResourceRefBase(): _parallelAccessStore(nullptr), _key(Key::Null()) {} void init(ParallelAccessStore *parallelAccessStore, const Key &key) { _parallelAccessStore = parallelAccessStore; _key = key; } virtual ~ResourceRefBase() { _parallelAccessStore->release(_key); } private: ParallelAccessStore *_parallelAccessStore; //TODO We're storing Key twice (here and in the base resource). Rather use getKey() on the base resource if possible somehow. Key _key; DISALLOW_COPY_AND_ASSIGN(ResourceRefBase); }; bool isOpened(const Key &key) const; cpputils::unique_ref add(const Key &key, cpputils::unique_ref resource); template cpputils::unique_ref add(const Key &key, cpputils::unique_ref resource, std::function(Resource*)> createResourceRef); boost::optional> load(const Key &key); boost::optional> load(const Key &key, std::function(Resource*)> createResourceRef); void remove(const Key &key, cpputils::unique_ref block); private: class OpenResource final { public: OpenResource(cpputils::unique_ref resource): _resource(std::move(resource)), _refCount(0) {} OpenResource(OpenResource &&rhs) = default; Resource *getReference() { ++_refCount; return _resource.get(); } void releaseReference() { --_refCount; } bool refCountIsZero() const { return 0 == _refCount; } cpputils::unique_ref moveResourceOut() { return std::move(_resource); } private: cpputils::unique_ref _resource; uint32_t _refCount; DISALLOW_COPY_AND_ASSIGN(OpenResource); }; mutable std::mutex _mutex; cpputils::unique_ref> _baseStore; std::unordered_map _openResources; std::map>> _resourcesToRemove; template cpputils::unique_ref _add(const Key &key, cpputils::unique_ref resource, std::function(Resource*)> createResourceRef); void release(const Key &key); friend class CachedResource; DISALLOW_COPY_AND_ASSIGN(ParallelAccessStore); }; template ParallelAccessStore::ParallelAccessStore(cpputils::unique_ref> baseStore) : _mutex(), _baseStore(std::move(baseStore)), _openResources(), _resourcesToRemove() { static_assert(std::is_base_of::value, "ResourceRef must inherit from ResourceRefBase"); } template bool ParallelAccessStore::isOpened(const Key &key) const { std::lock_guard lock(_mutex); return _openResources.find(key) != _openResources.end(); }; template cpputils::unique_ref ParallelAccessStore::add(const Key &key, cpputils::unique_ref resource) { return add(key, std::move(resource), [] (Resource *resource) { return cpputils::make_unique_ref(resource); }); } template template cpputils::unique_ref ParallelAccessStore::add(const Key &key, cpputils::unique_ref resource, std::function(Resource*)> createResourceRef) { static_assert(std::is_base_of::value, "Wrong ResourceRef type"); std::lock_guard lock(_mutex); return _add(key, std::move(resource), createResourceRef); } template template cpputils::unique_ref ParallelAccessStore::_add(const Key &key, cpputils::unique_ref resource, std::function(Resource*)> createResourceRef) { static_assert(std::is_base_of::value, "Wrong ResourceRef type"); auto insertResult = _openResources.emplace(key, std::move(resource)); ASSERT(true == insertResult.second, "Inserting failed. Already exists."); auto resourceRef = createResourceRef(insertResult.first->second.getReference()); resourceRef->init(this, key); return resourceRef; } template boost::optional> ParallelAccessStore::load(const Key &key) { return load(key, [] (Resource *res) { return cpputils::make_unique_ref(res); }); }; template boost::optional> ParallelAccessStore::load(const Key &key, std::function(Resource*)> createResourceRef) { //TODO This lock doesn't allow loading different blocks in parallel. Can we only lock the requested key? std::lock_guard lock(_mutex); auto found = _openResources.find(key); if (found == _openResources.end()) { auto resource = _baseStore->loadFromBaseStore(key); if (resource == boost::none) { return boost::none; } return _add(key, std::move(*resource), createResourceRef); } else { auto resourceRef = createResourceRef(found->second.getReference()); resourceRef->init(this, key); return std::move(resourceRef); } } template void ParallelAccessStore::remove(const Key &key, cpputils::unique_ref resource) { std::future> resourceToRemoveFuture; { std::lock_guard lock(_mutex); // TODO Lock needed for _resourcesToRemove? auto insertResult = _resourcesToRemove.emplace(key, std::promise < cpputils::unique_ref < Resource >> ()); ASSERT(true == insertResult.second, "Inserting failed"); resourceToRemoveFuture = insertResult.first->second.get_future(); } cpputils::destruct(std::move(resource)); //Wait for last resource user to release it auto resourceToRemove = resourceToRemoveFuture.get(); std::lock_guard lock(_mutex); // TODO Just added this as a precaution on a whim, but I seriously need to rethink locking here. _resourcesToRemove.erase(key); //TODO Is this erase causing a race condition? _baseStore->removeFromBaseStore(std::move(resourceToRemove)); } template void ParallelAccessStore::release(const Key &key) { std::lock_guard lock(_mutex); auto found = _openResources.find(key); ASSERT(found != _openResources.end(), "Didn't find key"); found->second.releaseReference(); if (found->second.refCountIsZero()) { auto foundToRemove = _resourcesToRemove.find(key); if (foundToRemove != _resourcesToRemove.end()) { foundToRemove->second.set_value(found->second.moveResourceOut()); } _openResources.erase(found); } } } #endif src/stats/000077500000000000000000000000001300002025200127635ustar00rootroot00000000000000src/stats/main.cpp000066400000000000000000000153041300002025200144160ustar00rootroot00000000000000#include #include #include "../impl/config/CryConfigFile.h" #include #include #include #include #include #include #include #include #include using namespace boost; using namespace boost::filesystem; using namespace std; using namespace cryfs; using namespace cpputils; using namespace blockstore; using namespace blockstore::ondisk; using namespace blobstore::onblocks; using namespace blobstore::onblocks::datanodestore; using namespace cryfs::fsblobstore; void printNode(unique_ref node) { std::cout << "Key: " << node->key().ToString() << ", Depth: " << node->depth() << " "; auto innerNode = dynamic_pointer_move(node); if (innerNode != none) { std::cout << "Type: inner\n"; return; } auto leafNode = dynamic_pointer_move(node); if (leafNode != none) { std::cout << "Type: leaf\n"; return; } } set _getBlockstoreUnaccountedBlocks(const CryConfig &config) { auto onDiskBlockStore = make_unique_ref("/home/heinzi/basedir"); auto encryptedBlockStore = CryCiphers::find(config.Cipher()).createEncryptedBlockstore(std::move(onDiskBlockStore), config.EncryptionKey()); auto nodeStore = make_unique_ref(std::move(encryptedBlockStore), CryDevice::BLOCKSIZE_BYTES); std::set unaccountedBlocks; uint32_t numBlocks = nodeStore->numNodes(); uint32_t i = 0; cout << "There are " << nodeStore->numNodes() << " blocks." << std::endl; // Add all blocks to unaccountedBlocks for (auto file = directory_iterator("/home/heinzi/basedir"); file != directory_iterator(); ++file) { cout << "\r" << (++i) << "/" << numBlocks << flush; if (file->path().filename() != "cryfs.config") { auto key = Key::FromString(file->path().filename().c_str()); unaccountedBlocks.insert(key); } } i = 0; cout << "\nRemove blocks that have a parent" << endl; //Remove root block from unaccountedBlocks unaccountedBlocks.erase(Key::FromString(config.RootBlob())); //Remove all blocks that have a parent node from unaccountedBlocks for (auto file = directory_iterator("/home/heinzi/basedir"); file != directory_iterator(); ++file) { cout << "\r" << (++i) << "/" << numBlocks << flush; if (file->path().filename() != "cryfs.config") { auto key = Key::FromString(file->path().filename().c_str()); auto node = nodeStore->load(key); auto innerNode = dynamic_pointer_move(*node); if (innerNode != none) { for (uint32_t childIndex = 0; childIndex < (*innerNode)->numChildren(); ++childIndex) { auto child = (*innerNode)->getChild(childIndex)->key(); unaccountedBlocks.erase(child); } } } } return unaccountedBlocks; } set _getBlocksReferencedByDirEntries(const CryConfig &config) { auto onDiskBlockStore = make_unique_ref("/home/heinzi/basedir"); auto encryptedBlockStore = CryCiphers::find(config.Cipher()).createEncryptedBlockstore(std::move(onDiskBlockStore), config.EncryptionKey()); auto fsBlobStore = make_unique_ref(make_unique_ref(std::move(encryptedBlockStore), CryDevice::BLOCKSIZE_BYTES)); set blocksReferencedByDirEntries; uint32_t numBlocks = fsBlobStore->numBlocks(); uint32_t i = 0; cout << "\nRemove blocks referenced by dir entries" << endl; for (auto file = directory_iterator("/home/heinzi/basedir"); file != directory_iterator(); ++file) { cout << "\r" << (++i) << "/" << numBlocks << flush; if (file->path().filename() != "cryfs.config") { auto key = Key::FromString(file->path().filename().c_str()); try { auto blob = fsBlobStore->load(key); if (blob != none) { auto dir = dynamic_pointer_move(*blob); if (dir != none) { vector children; (*dir)->AppendChildrenTo(&children); for (const auto &child : children) { blocksReferencedByDirEntries.insert((*dir)->GetChild(child.name)->key); } } } } catch (...) {} } } return blocksReferencedByDirEntries; } int main() { cout << "Password: "; string password; getline(cin, password); cout << "Loading config" << endl; auto config = CryConfigFile::load("/home/heinzi/basedir/cryfs.config", password); set unaccountedBlocks = _getBlockstoreUnaccountedBlocks(*config->config()); //Remove all blocks that are referenced by a directory entry from unaccountedBlocks set blocksReferencedByDirEntries = _getBlocksReferencedByDirEntries(*config->config()); for (const auto &key : blocksReferencedByDirEntries) { unaccountedBlocks.erase(key); } cout << "\nCalculate statistics" << endl; auto onDiskBlockStore = make_unique_ref("/home/heinzi/basedir"); auto encryptedBlockStore = CryCiphers::find(config->config()->Cipher()).createEncryptedBlockstore(std::move(onDiskBlockStore), config->config()->EncryptionKey()); auto nodeStore = make_unique_ref(std::move(encryptedBlockStore), CryDevice::BLOCKSIZE_BYTES); uint32_t numUnaccountedBlocks = unaccountedBlocks.size(); uint32_t numLeaves = 0; uint32_t numInner = 0; cout << "\nUnaccounted blocks: " << unaccountedBlocks.size() << endl; for (const auto &key : unaccountedBlocks) { std::cout << "\r" << (numLeaves+numInner) << "/" << numUnaccountedBlocks << flush; auto node = nodeStore->load(key); auto innerNode = dynamic_pointer_move(*node); if (innerNode != none) { ++numInner; printNode(std::move(*innerNode)); } auto leafNode = dynamic_pointer_move(*node); if (leafNode != none) { ++numLeaves; printNode(std::move(*leafNode)); } } cout << "\n" << numLeaves << " leaves and " << numInner << " inner nodes" << endl; }test/000077500000000000000000000000001300002025200120155ustar00rootroot00000000000000test/CMakeLists.txt000066400000000000000000000004721300002025200145600ustar00rootroot00000000000000if (BUILD_TESTING) include_directories(../src) add_subdirectory(gitversion) add_subdirectory(cpp-utils) add_subdirectory(fspp) add_subdirectory(parallelaccessstore) add_subdirectory(blockstore) add_subdirectory(blobstore) add_subdirectory(cryfs) add_subdirectory(cryfs-cli) endif(BUILD_TESTING) test/blobstore/000077500000000000000000000000001300002025200140105ustar00rootroot00000000000000test/blobstore/CMakeLists.txt000066400000000000000000000031701300002025200165510ustar00rootroot00000000000000project (blobstore-test) set(SOURCES implementations/onblocks/utils/MaxZeroSubtractionTest.cpp implementations/onblocks/utils/CeilDivisionTest.cpp implementations/onblocks/utils/IntPowTest.cpp implementations/onblocks/utils/CeilLogTest.cpp implementations/onblocks/testutils/BlobStoreTest.cpp implementations/onblocks/BlobStoreTest.cpp implementations/onblocks/datanodestore/DataLeafNodeTest.cpp implementations/onblocks/datanodestore/DataInnerNodeTest.cpp implementations/onblocks/datanodestore/DataNodeViewTest.cpp implementations/onblocks/datanodestore/DataNodeStoreTest.cpp implementations/onblocks/datatreestore/testutils/DataTreeTest.cpp implementations/onblocks/datatreestore/impl/GetLowestRightBorderNodeWithMoreThanOneChildOrNullTest.cpp implementations/onblocks/datatreestore/impl/GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNullTest.cpp implementations/onblocks/datatreestore/DataTreeTest_ResizeByTraversing.cpp implementations/onblocks/datatreestore/DataTreeTest_NumStoredBytes.cpp implementations/onblocks/datatreestore/DataTreeTest_ResizeNumBytes.cpp implementations/onblocks/datatreestore/DataTreeStoreTest.cpp implementations/onblocks/datatreestore/DataTreeTest_TraverseLeaves.cpp implementations/onblocks/BlobSizeTest.cpp implementations/onblocks/BlobReadWriteTest.cpp implementations/onblocks/BigBlobsTest.cpp ) add_executable(${PROJECT_NAME} ${SOURCES}) target_link_libraries(${PROJECT_NAME} googletest blobstore) add_test(${PROJECT_NAME} ${PROJECT_NAME}) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) test/blobstore/implementations/000077500000000000000000000000001300002025200172205ustar00rootroot00000000000000test/blobstore/implementations/onblocks/000077500000000000000000000000001300002025200210325ustar00rootroot00000000000000test/blobstore/implementations/onblocks/BigBlobsTest.cpp000066400000000000000000000122431300002025200240630ustar00rootroot00000000000000#include #include #include #include #include #include #include #include "blobstore/implementations/onblocks/BlobStoreOnBlocks.h" #include "blobstore/implementations/onblocks/BlobOnBlocks.h" using namespace blobstore; using namespace blobstore::onblocks; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::DataFixture; using cpputils::Data; using blockstore::inmemory::InMemoryBlockStore; using blockstore::compressing::CompressingBlockStore; using blockstore::compressing::RunLengthEncoding; // Test cases, ensuring that big blobs (>4G) work (i.e. testing that we don't use any 32bit variables for blob size, etc.) class BigBlobsTest : public ::testing::Test { public: static constexpr size_t BLOCKSIZE = 32 * 1024; static constexpr uint64_t SMALL_BLOB_SIZE = UINT64_C(1024)*1024*1024*3.9; // 3.9 GB (<4GB) static constexpr uint64_t LARGE_BLOB_SIZE = UINT64_C(1024)*1024*1024*4.1; // 4.1 GB (>4GB) static constexpr uint64_t max_uint_32 = std::numeric_limits::max(); static_assert(SMALL_BLOB_SIZE < max_uint_32, "LARGE_BLOB_SIZE should need 64bit or the test case is mute"); static_assert(LARGE_BLOB_SIZE > max_uint_32, "LARGE_BLOB_SIZE should need 64bit or the test case is mute"); unique_ref blobStore = make_unique_ref(make_unique_ref>(make_unique_ref()), BLOCKSIZE); unique_ref blob = blobStore->create(); }; constexpr size_t BigBlobsTest::BLOCKSIZE; constexpr uint64_t BigBlobsTest::SMALL_BLOB_SIZE; constexpr uint64_t BigBlobsTest::LARGE_BLOB_SIZE; TEST_F(BigBlobsTest, Resize) { //These operations are in one test case and not in many small ones, because it takes quite long to create a >4GB blob. //Resize to >4GB blob->resize(LARGE_BLOB_SIZE); EXPECT_EQ(LARGE_BLOB_SIZE, blob->size()); //Grow while >4GB blob->resize(LARGE_BLOB_SIZE + 1024); EXPECT_EQ(LARGE_BLOB_SIZE + 1024, blob->size()); //Shrink while >4GB blob->resize(LARGE_BLOB_SIZE); EXPECT_EQ(LARGE_BLOB_SIZE, blob->size()); //Shrink to <4GB blob->resize(SMALL_BLOB_SIZE); EXPECT_EQ(SMALL_BLOB_SIZE, blob->size()); //Grow to >4GB blob->resize(LARGE_BLOB_SIZE); EXPECT_EQ(LARGE_BLOB_SIZE, blob->size()); //Flush >4GB blob blob->flush(); //Destruct >4GB blob auto key = blob->key(); cpputils::destruct(std::move(blob)); //Load >4GB blob blob = blobStore->load(key).value(); //Remove >4GB blob blobStore->remove(std::move(blob)); } TEST_F(BigBlobsTest, GrowByWriting_Crossing4GBBorder) { Data fixture = DataFixture::generate(2*(LARGE_BLOB_SIZE-SMALL_BLOB_SIZE)); blob->write(fixture.data(), SMALL_BLOB_SIZE, fixture.size()); EXPECT_EQ(LARGE_BLOB_SIZE+(LARGE_BLOB_SIZE-SMALL_BLOB_SIZE), blob->size()); Data loaded(fixture.size()); blob->read(loaded.data(), SMALL_BLOB_SIZE, loaded.size()); EXPECT_EQ(0, std::memcmp(loaded.data(), fixture.data(), loaded.size())); } TEST_F(BigBlobsTest, GrowByWriting_Outside4GBBorder_StartingSizeZero) { Data fixture = DataFixture::generate(1024); blob->write(fixture.data(), LARGE_BLOB_SIZE, fixture.size()); EXPECT_EQ(LARGE_BLOB_SIZE+1024, blob->size()); Data loaded(fixture.size()); blob->read(loaded.data(), LARGE_BLOB_SIZE, loaded.size()); EXPECT_EQ(0, std::memcmp(loaded.data(), fixture.data(), loaded.size())); } TEST_F(BigBlobsTest, GrowByWriting_Outside4GBBorder_StartingSizeOutside4GBBorder) { blob->resize(LARGE_BLOB_SIZE); Data fixture = DataFixture::generate(1024); blob->write(fixture.data(), LARGE_BLOB_SIZE+1024, fixture.size()); EXPECT_EQ(LARGE_BLOB_SIZE+2048, blob->size()); Data loaded(fixture.size()); blob->read(loaded.data(), LARGE_BLOB_SIZE+1024, loaded.size()); EXPECT_EQ(0, std::memcmp(loaded.data(), fixture.data(), loaded.size())); } TEST_F(BigBlobsTest, ReadWriteAfterGrown_Crossing4GBBorder) { blob->resize(LARGE_BLOB_SIZE+(LARGE_BLOB_SIZE-SMALL_BLOB_SIZE)+1024); Data fixture = DataFixture::generate(2*(LARGE_BLOB_SIZE-SMALL_BLOB_SIZE)); blob->write(fixture.data(), SMALL_BLOB_SIZE, fixture.size()); EXPECT_EQ(LARGE_BLOB_SIZE+(LARGE_BLOB_SIZE-SMALL_BLOB_SIZE)+1024, blob->size()); Data loaded(fixture.size()); blob->read(loaded.data(), SMALL_BLOB_SIZE, loaded.size()); EXPECT_EQ(0, std::memcmp(loaded.data(), fixture.data(), loaded.size())); } TEST_F(BigBlobsTest, ReadWriteAfterGrown_Outside4GBBorder) { blob->resize(LARGE_BLOB_SIZE+2048); Data fixture = DataFixture::generate(1024); blob->write(fixture.data(), LARGE_BLOB_SIZE, fixture.size()); EXPECT_EQ(LARGE_BLOB_SIZE+2048, blob->size()); Data loaded(fixture.size()); blob->read(loaded.data(), LARGE_BLOB_SIZE, loaded.size()); EXPECT_EQ(0, std::memcmp(loaded.data(), fixture.data(), loaded.size())); } //TODO Test Blob::readAll (only on 64bit systems) test/blobstore/implementations/onblocks/BlobReadWriteTest.cpp000066400000000000000000000174411300002025200250720ustar00rootroot00000000000000#include "testutils/BlobStoreTest.h" #include #include #include "blobstore/implementations/onblocks/datanodestore/DataNodeView.h" using cpputils::unique_ref; using ::testing::WithParamInterface; using ::testing::Values; using namespace blobstore; using blobstore::onblocks::datanodestore::DataNodeLayout; using blockstore::Key; using cpputils::Data; using cpputils::DataFixture; class BlobReadWriteTest: public BlobStoreTest { public: static constexpr uint32_t LARGE_SIZE = 10 * 1024 * 1024; static constexpr DataNodeLayout LAYOUT = DataNodeLayout(BLOCKSIZE_BYTES); BlobReadWriteTest() :randomData(DataFixture::generate(LARGE_SIZE)), blob(blobStore->create()) { } Data readBlob(const Blob &blob) { Data data(blob.size()); blob.read(data.data(), 0, data.size()); return data; } template void EXPECT_DATA_READS_AS(const DataClass &expected, const Blob &actual, uint64_t offset, uint64_t size) { Data read(size); actual.read(read.data(), offset, size); EXPECT_EQ(0, std::memcmp(expected.data(), read.data(), size)); } Data randomData; unique_ref blob; }; constexpr uint32_t BlobReadWriteTest::LARGE_SIZE; constexpr DataNodeLayout BlobReadWriteTest::LAYOUT; TEST_F(BlobReadWriteTest, WritingImmediatelyFlushes_SmallSize) { blob->resize(5); blob->write(randomData.data(), 0, 5); auto loaded = loadBlob(blob->key()); EXPECT_DATA_READS_AS(randomData, *loaded, 0, 5); } TEST_F(BlobReadWriteTest, WritingImmediatelyFlushes_LargeSize) { blob->resize(LARGE_SIZE); blob->write(randomData.data(), 0, LARGE_SIZE); auto loaded = loadBlob(blob->key()); EXPECT_DATA_READS_AS(randomData, *loaded, 0, LARGE_SIZE); } // Regression test for a strange bug we had TEST_F(BlobReadWriteTest, WritingCloseTo16ByteLimitDoesntDestroySize) { blob->resize(1); blob->write(randomData.data(), 32776, 4); EXPECT_EQ(32780u, blob->size()); } struct DataRange { size_t blobsize; off_t offset; size_t count; }; class BlobReadWriteDataTest: public BlobReadWriteTest, public WithParamInterface { public: Data foregroundData; Data backgroundData; BlobReadWriteDataTest() : foregroundData(DataFixture::generate(GetParam().count, 0)), backgroundData(DataFixture::generate(GetParam().blobsize, 1)) { } template void EXPECT_DATA_READS_AS_OUTSIDE_OF(const DataClass &expected, const Blob &blob, off_t start, size_t count) { Data begin(start); Data end(GetParam().blobsize - count - start); std::memcpy(begin.data(), expected.data(), start); std::memcpy(end.data(), (uint8_t*)expected.data()+start+count, end.size()); EXPECT_DATA_READS_AS(begin, blob, 0, start); EXPECT_DATA_READS_AS(end, blob, start + count, end.size()); } void EXPECT_DATA_IS_ZEROES_OUTSIDE_OF(const Blob &blob, off_t start, size_t count) { Data ZEROES(GetParam().blobsize); ZEROES.FillWithZeroes(); EXPECT_DATA_READS_AS_OUTSIDE_OF(ZEROES, blob, start, count); } }; INSTANTIATE_TEST_CASE_P(BlobReadWriteDataTest, BlobReadWriteDataTest, Values( //Blob with only one leaf DataRange{BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf(), 0, BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf()}, // full size leaf, access beginning to end DataRange{BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf(), 100, BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf()-200}, // full size leaf, access middle to middle DataRange{BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf(), 0, BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf()-100}, // full size leaf, access beginning to middle DataRange{BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf(), 100, BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf()-100}, // full size leaf, access middle to end DataRange{BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf()-100, 0, BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf()-100}, // non-full size leaf, access beginning to end DataRange{BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf()-100, 100, BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf()-300}, // non-full size leaf, access middle to middle DataRange{BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf()-100, 0, BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf()-200}, // non-full size leaf, access beginning to middle DataRange{BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf()-100, 100, BlobReadWriteDataTest::LAYOUT.maxBytesPerLeaf()-200}, // non-full size leaf, access middle to end //Larger blob DataRange{BlobReadWriteDataTest::LARGE_SIZE, 0, BlobReadWriteDataTest::LARGE_SIZE}, // access beginning to end DataRange{BlobReadWriteDataTest::LARGE_SIZE, 100, BlobReadWriteDataTest::LARGE_SIZE-200}, // access middle first leaf to middle last leaf DataRange{BlobReadWriteDataTest::LARGE_SIZE, 0, BlobReadWriteDataTest::LARGE_SIZE-100}, // access beginning to middle last leaf DataRange{BlobReadWriteDataTest::LARGE_SIZE, 100, BlobReadWriteDataTest::LARGE_SIZE-100}, // access middle first leaf to end DataRange{BlobReadWriteDataTest::LARGE_SIZE, BlobReadWriteDataTest::LARGE_SIZE*1/3, BlobReadWriteDataTest::LARGE_SIZE*1/3}, // access middle to middle DataRange{BlobReadWriteDataTest::LARGE_SIZE, 0, BlobReadWriteDataTest::LARGE_SIZE*2/3}, // access beginning to middle DataRange{BlobReadWriteDataTest::LARGE_SIZE, BlobReadWriteDataTest::LARGE_SIZE*1/3, BlobReadWriteDataTest::LARGE_SIZE*2/3} // access middle to end )); TEST_P(BlobReadWriteDataTest, WritingDoesntChangeSize) { blob->resize(GetParam().blobsize); blob->write(this->foregroundData.data(), GetParam().offset, GetParam().count); EXPECT_EQ(GetParam().blobsize, blob->size()); } TEST_P(BlobReadWriteDataTest, WriteAndReadImmediately) { blob->resize(GetParam().blobsize); blob->write(this->foregroundData.data(), GetParam().offset, GetParam().count); EXPECT_DATA_READS_AS(this->foregroundData, *blob, GetParam().offset, GetParam().count); EXPECT_DATA_IS_ZEROES_OUTSIDE_OF(*blob, GetParam().offset, GetParam().count); } TEST_P(BlobReadWriteDataTest, WriteAndReadAfterLoading) { blob->resize(GetParam().blobsize); blob->write(this->foregroundData.data(), GetParam().offset, GetParam().count); auto loaded = loadBlob(blob->key()); EXPECT_DATA_READS_AS(this->foregroundData, *loaded, GetParam().offset, GetParam().count); EXPECT_DATA_IS_ZEROES_OUTSIDE_OF(*loaded, GetParam().offset, GetParam().count); } TEST_P(BlobReadWriteDataTest, OverwriteAndRead) { blob->resize(GetParam().blobsize); blob->write(this->backgroundData.data(), 0, GetParam().blobsize); blob->write(this->foregroundData.data(), GetParam().offset, GetParam().count); EXPECT_DATA_READS_AS(this->foregroundData, *blob, GetParam().offset, GetParam().count); EXPECT_DATA_READS_AS_OUTSIDE_OF(this->backgroundData, *blob, GetParam().offset, GetParam().count); } TEST_P(BlobReadWriteDataTest, WriteWholeAndReadPart) { blob->resize(GetParam().blobsize); blob->write(this->backgroundData.data(), 0, GetParam().blobsize); Data read(GetParam().count); blob->read(read.data(), GetParam().offset, GetParam().count); EXPECT_EQ(0, std::memcmp(read.data(), (uint8_t*)this->backgroundData.data()+GetParam().offset, GetParam().count)); } TEST_P(BlobReadWriteDataTest, WritePartAndReadWhole) { blob->resize(GetParam().blobsize); blob->write(this->backgroundData.data(), 0, GetParam().blobsize); blob->write(this->foregroundData.data(), GetParam().offset, GetParam().count); Data read = readBlob(*blob); EXPECT_EQ(0, std::memcmp(read.data(), this->backgroundData.data(), GetParam().offset)); EXPECT_EQ(0, std::memcmp((uint8_t*)read.data()+GetParam().offset, this->foregroundData.data(), GetParam().count)); EXPECT_EQ(0, std::memcmp((uint8_t*)read.data()+GetParam().offset+GetParam().count, (uint8_t*)this->backgroundData.data()+GetParam().offset+GetParam().count, GetParam().blobsize-GetParam().count-GetParam().offset)); } test/blobstore/implementations/onblocks/BlobSizeTest.cpp000066400000000000000000000106541300002025200241150ustar00rootroot00000000000000#include "testutils/BlobStoreTest.h" #include #include using namespace blobstore; using blockstore::Key; using cpputils::Data; using cpputils::DataFixture; using cpputils::unique_ref; class BlobSizeTest: public BlobStoreTest { public: BlobSizeTest(): blob(blobStore->create()) {} static constexpr uint32_t MEDIUM_SIZE = 5 * 1024 * 1024; static constexpr uint32_t LARGE_SIZE = 10 * 1024 * 1024; unique_ref blob; }; constexpr uint32_t BlobSizeTest::MEDIUM_SIZE; constexpr uint32_t BlobSizeTest::LARGE_SIZE; TEST_F(BlobSizeTest, CreatedBlobIsEmpty) { EXPECT_EQ(0u, blob->size()); } TEST_F(BlobSizeTest, Growing_1Byte) { blob->resize(1); EXPECT_EQ(1u, blob->size()); } TEST_F(BlobSizeTest, Growing_Large) { blob->resize(LARGE_SIZE); EXPECT_EQ(LARGE_SIZE, blob->size()); } TEST_F(BlobSizeTest, Shrinking_Empty) { blob->resize(LARGE_SIZE); blob->resize(0); EXPECT_EQ(0u, blob->size()); } TEST_F(BlobSizeTest, Shrinking_1Byte) { blob->resize(LARGE_SIZE); blob->resize(1); EXPECT_EQ(1u, blob->size()); } TEST_F(BlobSizeTest, ResizingToItself_Empty) { blob->resize(0); EXPECT_EQ(0u, blob->size()); } TEST_F(BlobSizeTest, ResizingToItself_1Byte) { blob->resize(1); blob->resize(1); EXPECT_EQ(1u, blob->size()); } TEST_F(BlobSizeTest, ResizingToItself_Large) { blob->resize(LARGE_SIZE); blob->resize(LARGE_SIZE); EXPECT_EQ(LARGE_SIZE, blob->size()); } TEST_F(BlobSizeTest, EmptyBlobStaysEmptyWhenLoading) { Key key = blob->key(); reset(std::move(blob)); auto loaded = loadBlob(key); EXPECT_EQ(0u, loaded->size()); } TEST_F(BlobSizeTest, BlobSizeStaysIntactWhenLoading) { blob->resize(LARGE_SIZE); Key key = blob->key(); reset(std::move(blob)); auto loaded = loadBlob(key); EXPECT_EQ(LARGE_SIZE, loaded->size()); } TEST_F(BlobSizeTest, WritingAtEndOfBlobGrowsBlob_Empty) { int value; blob->write(&value, 0, 4); EXPECT_EQ(4u, blob->size()); } TEST_F(BlobSizeTest, WritingAfterEndOfBlobGrowsBlob_Empty) { int value; blob->write(&value, 2, 4); EXPECT_EQ(6u, blob->size()); } TEST_F(BlobSizeTest, WritingOverEndOfBlobGrowsBlob_NonEmpty) { blob->resize(1); int value; blob->write(&value, 0, 4); EXPECT_EQ(4u, blob->size()); } TEST_F(BlobSizeTest, WritingAtEndOfBlobGrowsBlob_NonEmpty) { blob->resize(1); int value; blob->write(&value, 1, 4); EXPECT_EQ(5u, blob->size()); } TEST_F(BlobSizeTest, WritingAfterEndOfBlobGrowsBlob_NonEmpty) { blob->resize(1); int value; blob->write(&value, 2, 4); EXPECT_EQ(6u, blob->size()); } TEST_F(BlobSizeTest, ChangingSizeImmediatelyFlushes) { blob->resize(LARGE_SIZE); auto loaded = loadBlob(blob->key()); EXPECT_EQ(LARGE_SIZE, loaded->size()); } class BlobSizeDataTest: public BlobSizeTest { public: BlobSizeDataTest() :ZEROES(LARGE_SIZE), randomData(DataFixture::generate(LARGE_SIZE)) { ZEROES.FillWithZeroes(); } Data readBlob(const Blob &blob) { Data data(blob.size()); blob.read(data.data(), 0, data.size()); return data; } Data ZEROES; Data randomData; }; TEST_F(BlobSizeDataTest, BlobIsZeroedOutAfterGrowing) { blob->resize(LARGE_SIZE); EXPECT_EQ(0, std::memcmp(readBlob(*blob).data(), ZEROES.data(), LARGE_SIZE)); } TEST_F(BlobSizeDataTest, BlobIsZeroedOutAfterGrowingAndLoading) { blob->resize(LARGE_SIZE); auto loaded = loadBlob(blob->key()); EXPECT_EQ(0, std::memcmp(readBlob(*loaded).data(), ZEROES.data(), LARGE_SIZE)); } TEST_F(BlobSizeDataTest, DataStaysIntactWhenGrowing) { blob->resize(MEDIUM_SIZE); blob->write(randomData.data(), 0, MEDIUM_SIZE); blob->resize(LARGE_SIZE); EXPECT_EQ(0, std::memcmp(readBlob(*blob).data(), randomData.data(), MEDIUM_SIZE)); EXPECT_EQ(0, std::memcmp((uint8_t*)readBlob(*blob).data() + MEDIUM_SIZE, ZEROES.data(), LARGE_SIZE-MEDIUM_SIZE)); } TEST_F(BlobSizeDataTest, DataStaysIntactWhenShrinking) { blob->resize(LARGE_SIZE); blob->write(randomData.data(), 0, LARGE_SIZE); blob->resize(MEDIUM_SIZE); EXPECT_EQ(0, std::memcmp(readBlob(*blob).data(), randomData.data(), MEDIUM_SIZE)); } TEST_F(BlobSizeDataTest, ChangedAreaIsZeroedOutWhenShrinkingAndRegrowing) { blob->resize(LARGE_SIZE); blob->write(randomData.data(), 0, LARGE_SIZE); blob->resize(MEDIUM_SIZE); blob->resize(LARGE_SIZE); EXPECT_EQ(0, std::memcmp(readBlob(*blob).data(), randomData.data(), MEDIUM_SIZE)); EXPECT_EQ(0, std::memcmp((uint8_t*)readBlob(*blob).data() + MEDIUM_SIZE, ZEROES.data(), LARGE_SIZE-MEDIUM_SIZE)); } test/blobstore/implementations/onblocks/BlobStoreTest.cpp000066400000000000000000000023571300002025200243000ustar00rootroot00000000000000#include "testutils/BlobStoreTest.h" #include using blockstore::Key; using cpputils::unique_ref; using blobstore::Blob; using boost::none; TEST_F(BlobStoreTest, LoadNonexistingKeyOnEmptyBlobstore) { const blockstore::Key key = blockstore::Key::FromString("1491BB4932A389EE14BC7090AC772972"); EXPECT_EQ(none, blobStore->load(key)); } TEST_F(BlobStoreTest, LoadNonexistingKeyOnNonEmptyBlobstore) { blobStore->create(); const blockstore::Key key = blockstore::Key::FromString("1491BB4932A389EE14BC7090AC772972"); EXPECT_EQ(none, blobStore->load(key)); } TEST_F(BlobStoreTest, TwoCreatedBlobsHaveDifferentKeys) { auto blob1 = blobStore->create(); auto blob2 = blobStore->create(); EXPECT_NE(blob1->key(), blob2->key()); } TEST_F(BlobStoreTest, BlobIsNotLoadableAfterDeletion_DeleteDirectly) { auto blob = blobStore->create(); Key key = blob->key(); blobStore->remove(std::move(blob)); EXPECT_FALSE((bool)blobStore->load(key)); } TEST_F(BlobStoreTest, BlobIsNotLoadableAfterDeletion_DeleteAfterLoading) { auto blob = blobStore->create(); Key key = blob->key(); reset(std::move(blob)); blobStore->remove(loadBlob(key)); EXPECT_FALSE((bool)blobStore->load(key)); } test/blobstore/implementations/onblocks/datanodestore/000077500000000000000000000000001300002025200236665ustar00rootroot00000000000000test/blobstore/implementations/onblocks/datanodestore/DataInnerNodeTest.cpp000066400000000000000000000174601300002025200277150ustar00rootroot00000000000000#include #include "blobstore/implementations/onblocks/datanodestore/DataInnerNode.h" #include "blobstore/implementations/onblocks/datanodestore/DataLeafNode.h" #include "blobstore/implementations/onblocks/datanodestore/DataNodeStore.h" #include #include #include #include using ::testing::Test; using cpputils::dynamic_pointer_move; using blockstore::Key; using blockstore::testfake::FakeBlockStore; using blockstore::BlockStore; using cpputils::Data; using namespace blobstore; using namespace blobstore::onblocks; using namespace blobstore::onblocks::datanodestore; using cpputils::unique_ref; using cpputils::make_unique_ref; class DataInnerNodeTest: public Test { public: static constexpr uint32_t BLOCKSIZE_BYTES = 1024; DataInnerNodeTest() : _blockStore(make_unique_ref()), blockStore(_blockStore.get()), nodeStore(make_unique_ref(std::move(_blockStore), BLOCKSIZE_BYTES)), ZEROES(nodeStore->layout().maxBytesPerLeaf()), leaf(nodeStore->createNewLeafNode()), node(nodeStore->createNewInnerNode(*leaf)) { ZEROES.FillWithZeroes(); } unique_ref LoadInnerNode(const Key &key) { auto node = nodeStore->load(key).value(); return dynamic_pointer_move(node).value(); } Key CreateNewInnerNodeReturnKey(const DataNode &firstChild) { return nodeStore->createNewInnerNode(firstChild)->key(); } unique_ref CreateNewInnerNode() { auto new_leaf = nodeStore->createNewLeafNode(); return nodeStore->createNewInnerNode(*new_leaf); } unique_ref CreateAndLoadNewInnerNode(const DataNode &firstChild) { auto key = CreateNewInnerNodeReturnKey(firstChild); return LoadInnerNode(key); } unique_ref CreateNewInnerNode(const DataNode &firstChild, const DataNode &secondChild) { auto node = nodeStore->createNewInnerNode(firstChild); node->addChild(secondChild); return node; } Key CreateNewInnerNodeReturnKey(const DataNode &firstChild, const DataNode &secondChild) { return CreateNewInnerNode(firstChild, secondChild)->key(); } unique_ref CreateAndLoadNewInnerNode(const DataNode &firstChild, const DataNode &secondChild) { auto key = CreateNewInnerNodeReturnKey(firstChild, secondChild); return LoadInnerNode(key); } Key AddALeafTo(DataInnerNode *node) { auto leaf2 = nodeStore->createNewLeafNode(); node->addChild(*leaf2); return leaf2->key(); } Key CreateNodeWithDataConvertItToInnerNodeAndReturnKey() { auto node = CreateNewInnerNode(); AddALeafTo(node.get()); AddALeafTo(node.get()); auto child = nodeStore->createNewLeafNode(); unique_ref converted = DataNode::convertToNewInnerNode(std::move(node), *child); return converted->key(); } unique_ref CopyInnerNode(const DataInnerNode &node) { auto copied = nodeStore->createNewNodeAsCopyFrom(node); return dynamic_pointer_move(copied).value(); } Key InitializeInnerNodeAddLeafReturnKey() { auto node = DataInnerNode::InitializeNewNode(blockStore->create(Data(BLOCKSIZE_BYTES)), *leaf); AddALeafTo(node.get()); return node->key(); } unique_ref _blockStore; BlockStore *blockStore; unique_ref nodeStore; Data ZEROES; unique_ref leaf; unique_ref node; private: DISALLOW_COPY_AND_ASSIGN(DataInnerNodeTest); }; constexpr uint32_t DataInnerNodeTest::BLOCKSIZE_BYTES; TEST_F(DataInnerNodeTest, CorrectKeyReturnedAfterInitialization) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); Key key = block->key(); auto node = DataInnerNode::InitializeNewNode(std::move(block), *leaf); EXPECT_EQ(key, node->key()); } TEST_F(DataInnerNodeTest, CorrectKeyReturnedAfterLoading) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); Key key = block->key(); DataInnerNode::InitializeNewNode(std::move(block), *leaf); auto loaded = nodeStore->load(key).value(); EXPECT_EQ(key, loaded->key()); } TEST_F(DataInnerNodeTest, InitializesCorrectly) { auto node = DataInnerNode::InitializeNewNode(blockStore->create(Data(BLOCKSIZE_BYTES)), *leaf); EXPECT_EQ(1u, node->numChildren()); EXPECT_EQ(leaf->key(), node->getChild(0)->key()); } TEST_F(DataInnerNodeTest, ReinitializesCorrectly) { auto key = InitializeInnerNodeAddLeafReturnKey(); auto node = DataInnerNode::InitializeNewNode(blockStore->load(key).value(), *leaf); EXPECT_EQ(1u, node->numChildren()); EXPECT_EQ(leaf->key(), node->getChild(0)->key()); } TEST_F(DataInnerNodeTest, IsCorrectlyInitializedAfterLoading) { auto loaded = CreateAndLoadNewInnerNode(*leaf); EXPECT_EQ(1u, loaded->numChildren()); EXPECT_EQ(leaf->key(), loaded->getChild(0)->key()); } TEST_F(DataInnerNodeTest, AddingASecondLeaf) { Key leaf2_key = AddALeafTo(node.get()); EXPECT_EQ(2u, node->numChildren()); EXPECT_EQ(leaf->key(), node->getChild(0)->key()); EXPECT_EQ(leaf2_key, node->getChild(1)->key()); } TEST_F(DataInnerNodeTest, AddingASecondLeafAndReload) { auto leaf2 = nodeStore->createNewLeafNode(); auto loaded = CreateAndLoadNewInnerNode(*leaf, *leaf2); EXPECT_EQ(2u, loaded->numChildren()); EXPECT_EQ(leaf->key(), loaded->getChild(0)->key()); EXPECT_EQ(leaf2->key(), loaded->getChild(1)->key()); } TEST_F(DataInnerNodeTest, BuildingAThreeLevelTree) { auto node2 = CreateNewInnerNode(); auto parent = CreateNewInnerNode(*node, *node2); EXPECT_EQ(2u, parent->numChildren()); EXPECT_EQ(node->key(), parent->getChild(0)->key()); EXPECT_EQ(node2->key(), parent->getChild(1)->key()); } TEST_F(DataInnerNodeTest, BuildingAThreeLevelTreeAndReload) { auto node2 = CreateNewInnerNode(); auto parent = CreateAndLoadNewInnerNode(*node, *node2); EXPECT_EQ(2u, parent->numChildren()); EXPECT_EQ(node->key(), parent->getChild(0)->key()); EXPECT_EQ(node2->key(), parent->getChild(1)->key()); } TEST_F(DataInnerNodeTest, ConvertToInternalNode) { auto child = nodeStore->createNewLeafNode(); Key node_key = node->key(); unique_ref converted = DataNode::convertToNewInnerNode(std::move(node), *child); EXPECT_EQ(1u, converted->numChildren()); EXPECT_EQ(child->key(), converted->getChild(0)->key()); EXPECT_EQ(node_key, converted->key()); } TEST_F(DataInnerNodeTest, ConvertToInternalNodeZeroesOutChildrenRegion) { Key key = CreateNodeWithDataConvertItToInnerNodeAndReturnKey(); auto block = blockStore->load(key).value(); EXPECT_EQ(0, std::memcmp(ZEROES.data(), (uint8_t*)block->data()+DataNodeLayout::HEADERSIZE_BYTES+sizeof(DataInnerNode::ChildEntry), nodeStore->layout().maxBytesPerLeaf()-sizeof(DataInnerNode::ChildEntry))); } TEST_F(DataInnerNodeTest, CopyingCreatesNewNode) { auto copied = CopyInnerNode(*node); EXPECT_NE(node->key(), copied->key()); } TEST_F(DataInnerNodeTest, CopyInnerNodeWithOneChild) { auto copied = CopyInnerNode(*node); EXPECT_EQ(node->numChildren(), copied->numChildren()); EXPECT_EQ(node->getChild(0)->key(), copied->getChild(0)->key()); } TEST_F(DataInnerNodeTest, CopyInnerNodeWithTwoChildren) { AddALeafTo(node.get()); auto copied = CopyInnerNode(*node); EXPECT_EQ(node->numChildren(), copied->numChildren()); EXPECT_EQ(node->getChild(0)->key(), copied->getChild(0)->key()); EXPECT_EQ(node->getChild(1)->key(), copied->getChild(1)->key()); } TEST_F(DataInnerNodeTest, LastChildWhenOneChild) { EXPECT_EQ(leaf->key(), node->LastChild()->key()); } TEST_F(DataInnerNodeTest, LastChildWhenTwoChildren) { Key key = AddALeafTo(node.get()); EXPECT_EQ(key, node->LastChild()->key()); } TEST_F(DataInnerNodeTest, LastChildWhenThreeChildren) { AddALeafTo(node.get()); Key key = AddALeafTo(node.get()); EXPECT_EQ(key, node->LastChild()->key()); } test/blobstore/implementations/onblocks/datanodestore/DataLeafNodeTest.cpp000066400000000000000000000320101300002025200274750ustar00rootroot00000000000000#include "blobstore/implementations/onblocks/datanodestore/DataLeafNode.h" #include "blobstore/implementations/onblocks/datanodestore/DataInnerNode.h" #include "blobstore/implementations/onblocks/datanodestore/DataNodeStore.h" #include "blobstore/implementations/onblocks/BlobStoreOnBlocks.h" #include #include #include #include #include using ::testing::Test; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Combine; using cpputils::unique_ref; using cpputils::make_unique_ref; using std::string; using cpputils::DataFixture; //TODO Split into multiple files using cpputils::dynamic_pointer_move; using blockstore::BlockStore; using cpputils::Data; using blockstore::Key; using blockstore::testfake::FakeBlockStore; using namespace blobstore; using namespace blobstore::onblocks; using namespace blobstore::onblocks::datanodestore; #define EXPECT_IS_PTR_TYPE(Type, ptr) EXPECT_NE(nullptr, dynamic_cast(ptr)) << "Given pointer cannot be cast to the given type" class DataLeafNodeTest: public Test { public: static constexpr uint32_t BLOCKSIZE_BYTES = 1024; static constexpr DataNodeLayout LAYOUT = DataNodeLayout(BLOCKSIZE_BYTES); DataLeafNodeTest(): _blockStore(make_unique_ref()), blockStore(_blockStore.get()), nodeStore(make_unique_ref(std::move(_blockStore), BLOCKSIZE_BYTES)), ZEROES(nodeStore->layout().maxBytesPerLeaf()), randomData(nodeStore->layout().maxBytesPerLeaf()), leaf(nodeStore->createNewLeafNode()) { ZEROES.FillWithZeroes(); Data dataFixture(DataFixture::generate(nodeStore->layout().maxBytesPerLeaf())); std::memcpy(randomData.data(), dataFixture.data(), randomData.size()); } Data loadData(const DataLeafNode &leaf) { Data data(leaf.numBytes()); leaf.read(data.data(), 0, leaf.numBytes()); return data; } Key WriteDataToNewLeafBlockAndReturnKey() { auto newleaf = nodeStore->createNewLeafNode(); newleaf->resize(randomData.size()); newleaf->write(randomData.data(), 0, randomData.size()); return newleaf->key(); } void FillLeafBlockWithData() { FillLeafBlockWithData(leaf.get()); } void FillLeafBlockWithData(DataLeafNode *leaf_to_fill) { leaf_to_fill->resize(randomData.size()); leaf_to_fill->write(randomData.data(), 0, randomData.size()); } unique_ref LoadLeafNode(const Key &key) { auto leaf = nodeStore->load(key).value(); return dynamic_pointer_move(leaf).value(); } void ResizeLeaf(const Key &key, size_t size) { auto leaf = LoadLeafNode(key); EXPECT_IS_PTR_TYPE(DataLeafNode, leaf.get()); leaf->resize(size); } Key CreateLeafWithDataConvertItToInnerNodeAndReturnKey() { auto leaf = nodeStore->createNewLeafNode(); FillLeafBlockWithData(leaf.get()); auto child = nodeStore->createNewLeafNode(); unique_ref converted = DataNode::convertToNewInnerNode(std::move(leaf), *child); return converted->key(); } unique_ref CopyLeafNode(const DataLeafNode &node) { auto copied = nodeStore->createNewNodeAsCopyFrom(node); return dynamic_pointer_move(copied).value(); } Key InitializeLeafGrowAndReturnKey() { auto leaf = DataLeafNode::InitializeNewNode(blockStore->create(Data(BLOCKSIZE_BYTES))); leaf->resize(5); return leaf->key(); } unique_ref _blockStore; BlockStore *blockStore; unique_ref nodeStore; Data ZEROES; Data randomData; unique_ref leaf; private: DISALLOW_COPY_AND_ASSIGN(DataLeafNodeTest); }; constexpr uint32_t DataLeafNodeTest::BLOCKSIZE_BYTES; constexpr DataNodeLayout DataLeafNodeTest::LAYOUT; TEST_F(DataLeafNodeTest, CorrectKeyReturnedAfterInitialization) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); Key key = block->key(); auto node = DataLeafNode::InitializeNewNode(std::move(block)); EXPECT_EQ(key, node->key()); } TEST_F(DataLeafNodeTest, CorrectKeyReturnedAfterLoading) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); Key key = block->key(); DataLeafNode::InitializeNewNode(std::move(block)); auto loaded = nodeStore->load(key).value(); EXPECT_EQ(key, loaded->key()); } TEST_F(DataLeafNodeTest, InitializesCorrectly) { auto leaf = DataLeafNode::InitializeNewNode(blockStore->create(Data(BLOCKSIZE_BYTES))); EXPECT_EQ(0u, leaf->numBytes()); } TEST_F(DataLeafNodeTest, ReinitializesCorrectly) { auto key = InitializeLeafGrowAndReturnKey(); auto leaf = DataLeafNode::InitializeNewNode(blockStore->load(key).value()); EXPECT_EQ(0u, leaf->numBytes()); } TEST_F(DataLeafNodeTest, ReadWrittenDataAfterReloadingBlock) { Key key = WriteDataToNewLeafBlockAndReturnKey(); auto loaded = LoadLeafNode(key); EXPECT_EQ(randomData.size(), loaded->numBytes()); EXPECT_EQ(randomData, loadData(*loaded)); } TEST_F(DataLeafNodeTest, NewLeafNodeHasSizeZero) { EXPECT_EQ(0u, leaf->numBytes()); } TEST_F(DataLeafNodeTest, NewLeafNodeHasSizeZero_AfterLoading) { Key key = nodeStore->createNewLeafNode()->key(); auto leaf = LoadLeafNode(key); EXPECT_EQ(0u, leaf->numBytes()); } class DataLeafNodeSizeTest: public DataLeafNodeTest, public WithParamInterface { public: Key CreateLeafResizeItAndReturnKey() { auto leaf = nodeStore->createNewLeafNode(); leaf->resize(GetParam()); return leaf->key(); } }; INSTANTIATE_TEST_CASE_P(DataLeafNodeSizeTest, DataLeafNodeSizeTest, Values(0, 1, 5, 16, 32, 512, DataNodeLayout(DataLeafNodeTest::BLOCKSIZE_BYTES).maxBytesPerLeaf())); TEST_P(DataLeafNodeSizeTest, ResizeNode_ReadSizeImmediately) { leaf->resize(GetParam()); EXPECT_EQ(GetParam(), leaf->numBytes()); } TEST_P(DataLeafNodeSizeTest, ResizeNode_ReadSizeAfterLoading) { Key key = CreateLeafResizeItAndReturnKey(); auto leaf = LoadLeafNode(key); EXPECT_EQ(GetParam(), leaf->numBytes()); } TEST_F(DataLeafNodeTest, SpaceIsZeroFilledWhenGrowing) { leaf->resize(randomData.size()); EXPECT_EQ(0, std::memcmp(ZEROES.data(), loadData(*leaf).data(), randomData.size())); } TEST_F(DataLeafNodeTest, SpaceGetsZeroFilledWhenShrinkingAndRegrowing) { FillLeafBlockWithData(); // resize it smaller and then back to original size uint32_t smaller_size = randomData.size() - 100; leaf->resize(smaller_size); leaf->resize(randomData.size()); //Check that the space was filled with zeroes EXPECT_EQ(0, std::memcmp(ZEROES.data(), ((uint8_t*)loadData(*leaf).data())+smaller_size, 100)); } TEST_F(DataLeafNodeTest, DataGetsZeroFilledWhenShrinking) { Key key = WriteDataToNewLeafBlockAndReturnKey(); uint32_t smaller_size = randomData.size() - 100; { //At first, we expect there to be random data in the underlying data block auto block = blockStore->load(key).value(); EXPECT_EQ(0, std::memcmp((char*)randomData.data()+smaller_size, (uint8_t*)block->data()+DataNodeLayout::HEADERSIZE_BYTES+smaller_size, 100)); } //After shrinking, we expect there to be zeroes in the underlying data block ResizeLeaf(key, smaller_size); { auto block = blockStore->load(key).value(); EXPECT_EQ(0, std::memcmp(ZEROES.data(), (uint8_t*)block->data()+DataNodeLayout::HEADERSIZE_BYTES+smaller_size, 100)); } } TEST_F(DataLeafNodeTest, ShrinkingDoesntDestroyValidDataRegion) { FillLeafBlockWithData(); uint32_t smaller_size = randomData.size() - 100; leaf->resize(smaller_size); //Check that the remaining data region is unchanged EXPECT_EQ(0, std::memcmp(randomData.data(), loadData(*leaf).data(), smaller_size)); } TEST_F(DataLeafNodeTest, ConvertToInternalNode) { auto child = nodeStore->createNewLeafNode(); Key leaf_key = leaf->key(); unique_ref converted = DataNode::convertToNewInnerNode(std::move(leaf), *child); EXPECT_EQ(1u, converted->numChildren()); EXPECT_EQ(child->key(), converted->getChild(0)->key()); EXPECT_EQ(leaf_key, converted->key()); } TEST_F(DataLeafNodeTest, ConvertToInternalNodeZeroesOutChildrenRegion) { Key key = CreateLeafWithDataConvertItToInnerNodeAndReturnKey(); auto block = blockStore->load(key).value(); EXPECT_EQ(0, std::memcmp(ZEROES.data(), (uint8_t*)block->data()+DataNodeLayout::HEADERSIZE_BYTES+sizeof(DataInnerNode::ChildEntry), nodeStore->layout().maxBytesPerLeaf()-sizeof(DataInnerNode::ChildEntry))); } TEST_F(DataLeafNodeTest, CopyingCreatesANewLeaf) { auto copied = CopyLeafNode(*leaf); EXPECT_NE(leaf->key(), copied->key()); } TEST_F(DataLeafNodeTest, CopyEmptyLeaf) { auto copied = CopyLeafNode(*leaf); EXPECT_EQ(leaf->numBytes(), copied->numBytes()); } TEST_F(DataLeafNodeTest, CopyDataLeaf) { FillLeafBlockWithData(); auto copied = CopyLeafNode(*leaf); EXPECT_EQ(leaf->numBytes(), copied->numBytes()); EXPECT_EQ(0, std::memcmp(loadData(*leaf).data(), loadData(*copied).data(), leaf->numBytes())); //Test that they have different data regions (changing the original one doesn't change the copy) char data = '\0'; leaf->write(&data, 0, 1); EXPECT_EQ(data, *(char*)loadData(*leaf).data()); EXPECT_NE(data, *(char*)loadData(*copied).data()); } struct DataRange { size_t leafsize; off_t offset; size_t count; }; class DataLeafNodeDataTest: public DataLeafNodeTest, public WithParamInterface { public: Data foregroundData; Data backgroundData; DataLeafNodeDataTest(): foregroundData(DataFixture::generate(GetParam().count, 0)), backgroundData(DataFixture::generate(GetParam().leafsize, 1)) { } Key CreateLeafWriteToItAndReturnKey(const Data &to_write) { auto newleaf = nodeStore->createNewLeafNode(); newleaf->resize(GetParam().leafsize); newleaf->write(to_write.data(), GetParam().offset, GetParam().count); return newleaf->key(); } void EXPECT_DATA_READS_AS(const Data &expected, const DataLeafNode &leaf, off_t offset, size_t count) { Data read(count); leaf.read(read.data(), offset, count); EXPECT_EQ(expected, read); } void EXPECT_DATA_READS_AS_OUTSIDE_OF(const Data &expected, const DataLeafNode &leaf, off_t start, size_t count) { Data begin(start); Data end(GetParam().leafsize - count - start); std::memcpy(begin.data(), expected.data(), start); std::memcpy(end.data(), (uint8_t*)expected.data()+start+count, end.size()); EXPECT_DATA_READS_AS(begin, leaf, 0, start); EXPECT_DATA_READS_AS(end, leaf, start + count, end.size()); } void EXPECT_DATA_IS_ZEROES_OUTSIDE_OF(const DataLeafNode &leaf, off_t start, size_t count) { Data ZEROES(GetParam().leafsize); ZEROES.FillWithZeroes(); EXPECT_DATA_READS_AS_OUTSIDE_OF(ZEROES, leaf, start, count); } }; INSTANTIATE_TEST_CASE_P(DataLeafNodeDataTest, DataLeafNodeDataTest, Values( DataRange{DataLeafNodeTest::LAYOUT.maxBytesPerLeaf(), 0, DataLeafNodeTest::LAYOUT.maxBytesPerLeaf()}, // full size leaf, access beginning to end DataRange{DataLeafNodeTest::LAYOUT.maxBytesPerLeaf(), 100, DataLeafNodeTest::LAYOUT.maxBytesPerLeaf()-200}, // full size leaf, access middle to middle DataRange{DataLeafNodeTest::LAYOUT.maxBytesPerLeaf(), 0, DataLeafNodeTest::LAYOUT.maxBytesPerLeaf()-100}, // full size leaf, access beginning to middle DataRange{DataLeafNodeTest::LAYOUT.maxBytesPerLeaf(), 100, DataLeafNodeTest::LAYOUT.maxBytesPerLeaf()-100}, // full size leaf, access middle to end DataRange{DataLeafNodeTest::LAYOUT.maxBytesPerLeaf()-100, 0, DataLeafNodeTest::LAYOUT.maxBytesPerLeaf()-100}, // non-full size leaf, access beginning to end DataRange{DataLeafNodeTest::LAYOUT.maxBytesPerLeaf()-100, 100, DataLeafNodeTest::LAYOUT.maxBytesPerLeaf()-300}, // non-full size leaf, access middle to middle DataRange{DataLeafNodeTest::LAYOUT.maxBytesPerLeaf()-100, 0, DataLeafNodeTest::LAYOUT.maxBytesPerLeaf()-200}, // non-full size leaf, access beginning to middle DataRange{DataLeafNodeTest::LAYOUT.maxBytesPerLeaf()-100, 100, DataLeafNodeTest::LAYOUT.maxBytesPerLeaf()-200} // non-full size leaf, access middle to end )); TEST_P(DataLeafNodeDataTest, WriteAndReadImmediately) { leaf->resize(GetParam().leafsize); leaf->write(this->foregroundData.data(), GetParam().offset, GetParam().count); EXPECT_DATA_READS_AS(this->foregroundData, *leaf, GetParam().offset, GetParam().count); EXPECT_DATA_IS_ZEROES_OUTSIDE_OF(*leaf, GetParam().offset, GetParam().count); } TEST_P(DataLeafNodeDataTest, WriteAndReadAfterLoading) { Key key = CreateLeafWriteToItAndReturnKey(this->foregroundData); auto loaded_leaf = LoadLeafNode(key); EXPECT_DATA_READS_AS(this->foregroundData, *loaded_leaf, GetParam().offset, GetParam().count); EXPECT_DATA_IS_ZEROES_OUTSIDE_OF(*loaded_leaf, GetParam().offset, GetParam().count); } TEST_P(DataLeafNodeDataTest, OverwriteAndRead) { leaf->resize(GetParam().leafsize); leaf->write(this->backgroundData.data(), 0, GetParam().leafsize); leaf->write(this->foregroundData.data(), GetParam().offset, GetParam().count); EXPECT_DATA_READS_AS(this->foregroundData, *leaf, GetParam().offset, GetParam().count); EXPECT_DATA_READS_AS_OUTSIDE_OF(this->backgroundData, *leaf, GetParam().offset, GetParam().count); } test/blobstore/implementations/onblocks/datanodestore/DataNodeStoreTest.cpp000066400000000000000000000116441300002025200277340ustar00rootroot00000000000000#include "blobstore/implementations/onblocks/datanodestore/DataInnerNode.h" #include "blobstore/implementations/onblocks/datanodestore/DataLeafNode.h" #include "blobstore/implementations/onblocks/datanodestore/DataNode.h" #include "blobstore/implementations/onblocks/datanodestore/DataNodeStore.h" #include "blobstore/implementations/onblocks/BlobStoreOnBlocks.h" #include #include #include #include using ::testing::Test; using cpputils::unique_ref; using cpputils::make_unique_ref; using std::string; using boost::none; using blockstore::BlockStore; using blockstore::testfake::FakeBlockStore; using blockstore::Key; using cpputils::Data; using namespace blobstore; using namespace blobstore::onblocks; using namespace blobstore::onblocks::datanodestore; class DataNodeStoreTest: public Test { public: static constexpr uint32_t BLOCKSIZE_BYTES = 1024; unique_ref _blockStore = make_unique_ref(); BlockStore *blockStore = _blockStore.get(); unique_ref nodeStore = make_unique_ref(std::move(_blockStore), BLOCKSIZE_BYTES); }; constexpr uint32_t DataNodeStoreTest::BLOCKSIZE_BYTES; #define EXPECT_IS_PTR_TYPE(Type, ptr) EXPECT_NE(nullptr, dynamic_cast(ptr)) << "Given pointer cannot be cast to the given type" TEST_F(DataNodeStoreTest, CreateLeafNodeCreatesLeafNode) { auto node = nodeStore->createNewLeafNode(); EXPECT_IS_PTR_TYPE(DataLeafNode, node.get()); } TEST_F(DataNodeStoreTest, CreateInnerNodeCreatesInnerNode) { auto leaf = nodeStore->createNewLeafNode(); auto node = nodeStore->createNewInnerNode(*leaf); EXPECT_IS_PTR_TYPE(DataInnerNode, node.get()); } TEST_F(DataNodeStoreTest, LeafNodeIsRecognizedAfterStoreAndLoad) { Key key = nodeStore->createNewLeafNode()->key(); auto loaded_node = nodeStore->load(key).value(); EXPECT_IS_PTR_TYPE(DataLeafNode, loaded_node.get()); } TEST_F(DataNodeStoreTest, InnerNodeWithDepth1IsRecognizedAfterStoreAndLoad) { auto leaf = nodeStore->createNewLeafNode(); Key key = nodeStore->createNewInnerNode(*leaf)->key(); auto loaded_node = nodeStore->load(key).value(); EXPECT_IS_PTR_TYPE(DataInnerNode, loaded_node.get()); } TEST_F(DataNodeStoreTest, InnerNodeWithDepth2IsRecognizedAfterStoreAndLoad) { auto leaf = nodeStore->createNewLeafNode(); auto inner = nodeStore->createNewInnerNode(*leaf); Key key = nodeStore->createNewInnerNode(*inner)->key(); auto loaded_node = nodeStore->load(key).value(); EXPECT_IS_PTR_TYPE(DataInnerNode, loaded_node.get()); } TEST_F(DataNodeStoreTest, DataNodeCrashesOnLoadIfDepthIsTooHigh) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); Key key = block->key(); { DataNodeView view(std::move(block)); view.setDepth(DataNodeStore::MAX_DEPTH + 1); } EXPECT_ANY_THROW( nodeStore->load(key) ); } TEST_F(DataNodeStoreTest, CreatedInnerNodeIsInitialized) { auto leaf = nodeStore->createNewLeafNode(); auto node = nodeStore->createNewInnerNode(*leaf); EXPECT_EQ(1u, node->numChildren()); EXPECT_EQ(leaf->key(), node->getChild(0)->key()); } TEST_F(DataNodeStoreTest, CreatedLeafNodeIsInitialized) { auto leaf = nodeStore->createNewLeafNode(); EXPECT_EQ(0u, leaf->numBytes()); } TEST_F(DataNodeStoreTest, NodeIsNotLoadableAfterDeleting) { auto nodekey = nodeStore->createNewLeafNode()->key(); auto node = nodeStore->load(nodekey); EXPECT_NE(none, node); nodeStore->remove(std::move(*node)); EXPECT_EQ(none, nodeStore->load(nodekey)); } TEST_F(DataNodeStoreTest, NumNodesIsCorrectOnEmptyNodestore) { EXPECT_EQ(0u, nodeStore->numNodes()); } TEST_F(DataNodeStoreTest, NumNodesIsCorrectAfterAddingOneLeafNode) { nodeStore->createNewLeafNode(); EXPECT_EQ(1u, nodeStore->numNodes()); } TEST_F(DataNodeStoreTest, NumNodesIsCorrectAfterRemovingTheLastNode) { auto leaf = nodeStore->createNewLeafNode(); nodeStore->remove(std::move(leaf)); EXPECT_EQ(0u, nodeStore->numNodes()); } TEST_F(DataNodeStoreTest, NumNodesIsCorrectAfterAddingTwoNodes) { auto leaf = nodeStore->createNewLeafNode(); auto node = nodeStore->createNewInnerNode(*leaf); EXPECT_EQ(2u, nodeStore->numNodes()); } TEST_F(DataNodeStoreTest, NumNodesIsCorrectAfterRemovingANode) { auto leaf = nodeStore->createNewLeafNode(); auto node = nodeStore->createNewInnerNode(*leaf); nodeStore->remove(std::move(node)); EXPECT_EQ(1u, nodeStore->numNodes()); } TEST_F(DataNodeStoreTest, PhysicalBlockSize_Leaf) { auto leaf = nodeStore->createNewLeafNode(); auto block = blockStore->load(leaf->key()).value(); EXPECT_EQ(BLOCKSIZE_BYTES, block->size()); } TEST_F(DataNodeStoreTest, PhysicalBlockSize_Inner) { auto leaf = nodeStore->createNewLeafNode(); auto node = nodeStore->createNewInnerNode(*leaf); auto block = blockStore->load(node->key()).value(); EXPECT_EQ(BLOCKSIZE_BYTES, block->size()); }test/blobstore/implementations/onblocks/datanodestore/DataNodeViewTest.cpp000066400000000000000000000125771300002025200275600ustar00rootroot00000000000000#include "blobstore/implementations/onblocks/datanodestore/DataNodeView.h" #include #include #include #include "blobstore/implementations/onblocks/BlobStoreOnBlocks.h" #include using ::testing::Test; using ::testing::WithParamInterface; using ::testing::Values; using std::string; using blockstore::BlockStore; using blockstore::testfake::FakeBlockStore; using cpputils::Data; using cpputils::DataFixture; using cpputils::unique_ref; using cpputils::make_unique_ref; using namespace blobstore; using namespace blobstore::onblocks; using namespace blobstore::onblocks::datanodestore; class DataNodeViewTest: public Test { public: static constexpr uint32_t BLOCKSIZE_BYTES = 1024; static constexpr uint32_t DATASIZE_BYTES = DataNodeLayout(DataNodeViewTest::BLOCKSIZE_BYTES).datasizeBytes(); unique_ref blockStore = make_unique_ref(); }; class DataNodeViewDepthTest: public DataNodeViewTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(DataNodeViewDepthTest, DataNodeViewDepthTest, Values(0, 1, 3, 10, 100)); TEST_P(DataNodeViewDepthTest, DepthIsStored) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); auto key = block->key(); { DataNodeView view(std::move(block)); view.setDepth(GetParam()); } DataNodeView view(blockStore->load(key).value()); EXPECT_EQ(GetParam(), view.Depth()); } class DataNodeViewSizeTest: public DataNodeViewTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(DataNodeViewSizeTest, DataNodeViewSizeTest, Values(0, 50, 64, 1024, 1024*1024*1024)); TEST_P(DataNodeViewSizeTest, SizeIsStored) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); auto key = block->key(); { DataNodeView view(std::move(block)); view.setSize(GetParam()); } DataNodeView view(blockStore->load(key).value()); EXPECT_EQ(GetParam(), view.Size()); } TEST_F(DataNodeViewTest, DataIsStored) { Data randomData = DataFixture::generate(DATASIZE_BYTES); auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); auto key = block->key(); { DataNodeView view(std::move(block)); view.write(randomData.data(), 0, randomData.size()); } DataNodeView view(blockStore->load(key).value()); EXPECT_EQ(0, std::memcmp(view.data(), randomData.data(), randomData.size())); } TEST_F(DataNodeViewTest, HeaderAndBodyDontOverlap) { Data randomData = DataFixture::generate(DATASIZE_BYTES); auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); auto key = block->key(); { DataNodeView view(std::move(block)); view.setDepth(3); view.setSize(1000000000u); view.write(randomData.data(), 0, DATASIZE_BYTES); } DataNodeView view(blockStore->load(key).value()); EXPECT_EQ(3, view.Depth()); EXPECT_EQ(1000000000u, view.Size()); EXPECT_EQ(0, std::memcmp(view.data(), randomData.data(), DATASIZE_BYTES)); } TEST_F(DataNodeViewTest, DataBeginWorksWithOneByteEntries) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); uint8_t *blockBegin = (uint8_t*)block->data(); DataNodeView view(std::move(block)); EXPECT_EQ(blockBegin+DataNodeLayout::HEADERSIZE_BYTES, view.DataBegin()); } TEST_F(DataNodeViewTest, DataBeginWorksWithEightByteEntries) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); uint8_t *blockBegin = (uint8_t*)block->data(); DataNodeView view(std::move(block)); EXPECT_EQ(blockBegin+DataNodeLayout::HEADERSIZE_BYTES, (uint8_t*)view.DataBegin()); } TEST_F(DataNodeViewTest, DataEndWorksWithOneByteEntries) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); uint8_t *blockBegin = (uint8_t*)block->data(); DataNodeView view(std::move(block)); EXPECT_EQ(blockBegin+BLOCKSIZE_BYTES, view.DataEnd()); } TEST_F(DataNodeViewTest, DataEndWorksWithEightByteEntries) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); uint8_t *blockBegin = (uint8_t*)block->data(); DataNodeView view(std::move(block)); EXPECT_EQ(blockBegin+BLOCKSIZE_BYTES, (uint8_t*)view.DataEnd()); } struct SizedDataEntry { uint8_t data[6]; }; BOOST_STATIC_ASSERT_MSG(DataNodeViewTest::DATASIZE_BYTES % sizeof(SizedDataEntry) != 0, "This test case only makes sense, if the data entries don't fill up the whole space. " "There should be some space left at the end that is not used, because it isn't enough space for a full entry. " "If this static assertion fails, please use a different size for SizedDataEntry."); TEST_F(DataNodeViewTest, DataBeginWorksWithStructEntries) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); uint8_t *blockBegin = (uint8_t*)block->data(); DataNodeView view(std::move(block)); EXPECT_EQ(blockBegin+DataNodeLayout::HEADERSIZE_BYTES, (uint8_t*)view.DataBegin()); } TEST_F(DataNodeViewTest, DataEndWorksWithStructByteEntries) { auto block = blockStore->create(Data(BLOCKSIZE_BYTES)); uint8_t *blockBegin = (uint8_t*)block->data(); DataNodeView view(std::move(block)); unsigned int numFittingEntries = DATASIZE_BYTES / sizeof(SizedDataEntry); uint8_t *dataEnd = (uint8_t*)view.DataEnd(); EXPECT_EQ(blockBegin+DataNodeLayout::HEADERSIZE_BYTES + numFittingEntries * sizeof(SizedDataEntry), dataEnd); EXPECT_LT(dataEnd, blockBegin + BLOCKSIZE_BYTES); } //TODO Test that header fields (and data) are also stored over reloads test/blobstore/implementations/onblocks/datatreestore/000077500000000000000000000000001300002025200237005ustar00rootroot00000000000000test/blobstore/implementations/onblocks/datatreestore/DataTreeStoreTest.cpp000066400000000000000000000032071300002025200277540ustar00rootroot00000000000000#include "testutils/DataTreeTest.h" #include "blobstore/implementations/onblocks/datanodestore/DataNodeStore.h" #include "blobstore/implementations/onblocks/datatreestore/DataTreeStore.h" #include #include using blockstore::testfake::FakeBlockStore; using blockstore::Key; using blobstore::onblocks::datanodestore::DataNodeStore; using boost::none; using namespace blobstore::onblocks::datatreestore; class DataTreeStoreTest: public DataTreeTest { }; TEST_F(DataTreeStoreTest, CorrectKeyReturned) { Key key = treeStore.createNewTree()->key(); auto tree = treeStore.load(key).value(); EXPECT_EQ(key, tree->key()); } TEST_F(DataTreeStoreTest, CreatedTreeIsLoadable) { auto key = treeStore.createNewTree()->key(); auto loaded = treeStore.load(key); EXPECT_NE(none, loaded); } TEST_F(DataTreeStoreTest, NewTreeIsLeafOnly) { auto tree = treeStore.createNewTree(); EXPECT_IS_LEAF_NODE(tree->key()); } TEST_F(DataTreeStoreTest, TreeIsNotLoadableAfterRemove) { Key key = treeStore.createNewTree()->key(); auto tree = treeStore.load(key); EXPECT_NE(none, tree); treeStore.remove(std::move(*tree)); EXPECT_EQ(none, treeStore.load(key)); } TEST_F(DataTreeStoreTest, RemovingTreeRemovesAllNodesOfTheTree) { auto key = CreateThreeLevelMinData()->key(); auto tree1 = treeStore.load(key).value(); auto tree2_key = treeStore.createNewTree()->key(); treeStore.remove(std::move(tree1)); //Check that the only remaining node is tree2 EXPECT_EQ(1u, nodeStore->numNodes()); EXPECT_NE(none, treeStore.load(tree2_key)); } test/blobstore/implementations/onblocks/datatreestore/DataTreeTest_NumStoredBytes.cpp000066400000000000000000000071741300002025200317550ustar00rootroot00000000000000#include "testutils/DataTreeTest.h" #include using ::testing::_; using ::testing::WithParamInterface; using ::testing::Values; using blobstore::onblocks::datanodestore::DataLeafNode; using blobstore::onblocks::datanodestore::DataInnerNode; using blobstore::onblocks::datanodestore::DataNode; using blobstore::onblocks::datanodestore::DataNodeLayout; using blobstore::onblocks::datatreestore::DataTree; using blockstore::Key; class DataTreeTest_NumStoredBytes: public DataTreeTest { public: }; TEST_F(DataTreeTest_NumStoredBytes, CreatedTreeIsEmpty) { auto tree = treeStore.createNewTree(); EXPECT_EQ(0u, tree->numStoredBytes()); } class DataTreeTest_NumStoredBytes_P: public DataTreeTest_NumStoredBytes, public WithParamInterface {}; INSTANTIATE_TEST_CASE_P(EmptyLastLeaf, DataTreeTest_NumStoredBytes_P, Values(0u)); INSTANTIATE_TEST_CASE_P(HalfFullLastLeaf, DataTreeTest_NumStoredBytes_P, Values(5u, 10u)); INSTANTIATE_TEST_CASE_P(FullLastLeaf, DataTreeTest_NumStoredBytes_P, Values((uint32_t)DataNodeLayout(DataTreeTest_NumStoredBytes::BLOCKSIZE_BYTES).maxBytesPerLeaf())); TEST_P(DataTreeTest_NumStoredBytes_P, SingleLeaf) { Key key = CreateLeafWithSize(GetParam())->key(); auto tree = treeStore.load(key).value(); EXPECT_EQ(GetParam(), tree->numStoredBytes()); } TEST_P(DataTreeTest_NumStoredBytes_P, TwoLeafTree) { Key key = CreateTwoLeafWithSecondLeafSize(GetParam())->key(); auto tree = treeStore.load(key).value(); EXPECT_EQ(nodeStore->layout().maxBytesPerLeaf() + GetParam(), tree->numStoredBytes()); } TEST_P(DataTreeTest_NumStoredBytes_P, FullTwolevelTree) { Key key = CreateFullTwoLevelWithLastLeafSize(GetParam())->key(); auto tree = treeStore.load(key).value(); EXPECT_EQ(nodeStore->layout().maxBytesPerLeaf()*(nodeStore->layout().maxChildrenPerInnerNode()-1) + GetParam(), tree->numStoredBytes()); } TEST_P(DataTreeTest_NumStoredBytes_P, ThreeLevelTreeWithOneChild) { Key key = CreateThreeLevelWithOneChildAndLastLeafSize(GetParam())->key(); auto tree = treeStore.load(key).value(); EXPECT_EQ(nodeStore->layout().maxBytesPerLeaf() + GetParam(), tree->numStoredBytes()); } TEST_P(DataTreeTest_NumStoredBytes_P, ThreeLevelTreeWithTwoChildren) { Key key = CreateThreeLevelWithTwoChildrenAndLastLeafSize(GetParam())->key(); auto tree = treeStore.load(key).value(); EXPECT_EQ(nodeStore->layout().maxBytesPerLeaf()*nodeStore->layout().maxChildrenPerInnerNode() + nodeStore->layout().maxBytesPerLeaf() + GetParam(), tree->numStoredBytes()); } TEST_P(DataTreeTest_NumStoredBytes_P, ThreeLevelTreeWithThreeChildren) { Key key = CreateThreeLevelWithThreeChildrenAndLastLeafSize(GetParam())->key(); auto tree = treeStore.load(key).value(); EXPECT_EQ(2*nodeStore->layout().maxBytesPerLeaf()*nodeStore->layout().maxChildrenPerInnerNode() + nodeStore->layout().maxBytesPerLeaf() + GetParam(), tree->numStoredBytes()); } TEST_P(DataTreeTest_NumStoredBytes_P, FullThreeLevelTree) { Key key = CreateFullThreeLevelWithLastLeafSize(GetParam())->key(); auto tree = treeStore.load(key).value(); EXPECT_EQ(nodeStore->layout().maxBytesPerLeaf()*nodeStore->layout().maxChildrenPerInnerNode()*(nodeStore->layout().maxChildrenPerInnerNode()-1) + nodeStore->layout().maxBytesPerLeaf()*(nodeStore->layout().maxChildrenPerInnerNode()-1) + GetParam(), tree->numStoredBytes()); } TEST_P(DataTreeTest_NumStoredBytes_P, FourLevelMinDataTree) { Key key = CreateFourLevelMinDataWithLastLeafSize(GetParam())->key(); auto tree = treeStore.load(key).value(); EXPECT_EQ(nodeStore->layout().maxBytesPerLeaf()*nodeStore->layout().maxChildrenPerInnerNode()*nodeStore->layout().maxChildrenPerInnerNode() + GetParam(), tree->numStoredBytes()); } test/blobstore/implementations/onblocks/datatreestore/DataTreeTest_ResizeByTraversing.cpp000066400000000000000000000173221300002025200326230ustar00rootroot00000000000000#include "testutils/DataTreeTest.h" #include "testutils/TwoLevelDataFixture.h" #include "blobstore/implementations/onblocks/utils/Math.h" #include #include using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Combine; using std::tuple; using std::get; using std::function; using std::mem_fn; using cpputils::dynamic_pointer_move; using blobstore::onblocks::datanodestore::DataLeafNode; using blobstore::onblocks::datanodestore::DataInnerNode; using blobstore::onblocks::datanodestore::DataNode; using blobstore::onblocks::datanodestore::DataNodeLayout; using blobstore::onblocks::datatreestore::DataTree; using blobstore::onblocks::utils::ceilDivision; using blockstore::Key; using cpputils::Data; using boost::none; using cpputils::unique_ref; class DataTreeTest_ResizeByTraversing: public DataTreeTest { public: static constexpr DataNodeLayout LAYOUT = DataNodeLayout(BLOCKSIZE_BYTES); unique_ref CreateTree(unique_ref root) { Key key = root->key(); cpputils::destruct(std::move(root)); return treeStore.load(key).value(); } unique_ref CreateLeafTreeWithSize(uint32_t size) { return CreateTree(CreateLeafWithSize(size)); } unique_ref CreateTwoLeafTreeWithSecondLeafSize(uint32_t size) { return CreateTree(CreateTwoLeafWithSecondLeafSize(size)); } unique_ref CreateFullTwoLevelTreeWithLastLeafSize(uint32_t size) { return CreateTree(CreateFullTwoLevelWithLastLeafSize(size)); } unique_ref CreateThreeLevelTreeWithTwoChildrenAndLastLeafSize(uint32_t size) { return CreateTree(CreateThreeLevelWithTwoChildrenAndLastLeafSize(size)); } unique_ref CreateThreeLevelTreeWithThreeChildrenAndLastLeafSize(uint32_t size) { return CreateTree(CreateThreeLevelWithThreeChildrenAndLastLeafSize(size)); } unique_ref CreateFullThreeLevelTreeWithLastLeafSize(uint32_t size) { return CreateTree(CreateFullThreeLevelWithLastLeafSize(size)); } unique_ref CreateFourLevelMinDataTreeWithLastLeafSize(uint32_t size) { return CreateTree(CreateFourLevelMinDataWithLastLeafSize(size)); } void EXPECT_IS_LEFTMAXDATA_TREE(const Key &key) { auto root = nodeStore->load(key).value(); DataInnerNode *inner = dynamic_cast(root.get()); if (inner != nullptr) { for (uint32_t i = 0; i < inner->numChildren()-1; ++i) { EXPECT_IS_MAXDATA_TREE(inner->getChild(i)->key()); } EXPECT_IS_LEFTMAXDATA_TREE(inner->LastChild()->key()); } } void EXPECT_IS_MAXDATA_TREE(const Key &key) { auto root = nodeStore->load(key).value(); DataInnerNode *inner = dynamic_cast(root.get()); if (inner != nullptr) { for (uint32_t i = 0; i < inner->numChildren(); ++i) { EXPECT_IS_MAXDATA_TREE(inner->getChild(i)->key()); } } else { DataLeafNode *leaf = dynamic_cast(root.get()); EXPECT_EQ(nodeStore->layout().maxBytesPerLeaf(), leaf->numBytes()); } } }; constexpr DataNodeLayout DataTreeTest_ResizeByTraversing::LAYOUT; class DataTreeTest_ResizeByTraversing_P: public DataTreeTest_ResizeByTraversing, public WithParamInterface(DataTreeTest_ResizeByTraversing*, uint32_t)>, uint32_t, uint32_t>> { public: DataTreeTest_ResizeByTraversing_P() : oldLastLeafSize(get<1>(GetParam())), tree(get<0>(GetParam())(this, oldLastLeafSize)), numberOfLeavesToAdd(get<2>(GetParam())), newNumberOfLeaves(tree->numLeaves()+numberOfLeavesToAdd), ZEROES(LAYOUT.maxBytesPerLeaf()) { ZEROES.FillWithZeroes(); } void GrowTree(const Key &key, uint32_t numLeavesToAdd) { auto tree = treeStore.load(key); GrowTree(tree.get().get(), numLeavesToAdd); } void GrowTree(DataTree *tree, uint32_t numLeavesToAdd) { uint32_t oldNumLeaves = tree->numLeaves(); uint32_t newNumLeaves = oldNumLeaves + numLeavesToAdd; //TODO Test cases where beginIndex is inside of the existing leaves tree->traverseLeaves(newNumLeaves-1, newNumLeaves, [] (DataLeafNode*,uint32_t){}); tree->flush(); } unique_ref LastLeaf(const Key &key) { auto root = nodeStore->load(key).value(); auto leaf = dynamic_pointer_move(root); if (leaf != none) { return std::move(*leaf); } auto inner = dynamic_pointer_move(root).value(); return LastLeaf(inner->LastChild()->key()); } uint32_t oldLastLeafSize; unique_ref tree; uint32_t numberOfLeavesToAdd; uint32_t newNumberOfLeaves; Data ZEROES; }; INSTANTIATE_TEST_CASE_P(DataTreeTest_ResizeByTraversing_P, DataTreeTest_ResizeByTraversing_P, Combine( //Tree we're starting with Values(DataTreeTest_ResizeByTraversing*, uint32_t)>>( mem_fn(&DataTreeTest_ResizeByTraversing::CreateLeafTreeWithSize), mem_fn(&DataTreeTest_ResizeByTraversing::CreateTwoLeafTreeWithSecondLeafSize), mem_fn(&DataTreeTest_ResizeByTraversing::CreateFullTwoLevelTreeWithLastLeafSize), mem_fn(&DataTreeTest_ResizeByTraversing::CreateThreeLevelTreeWithTwoChildrenAndLastLeafSize), mem_fn(&DataTreeTest_ResizeByTraversing::CreateThreeLevelTreeWithThreeChildrenAndLastLeafSize), mem_fn(&DataTreeTest_ResizeByTraversing::CreateFullThreeLevelTreeWithLastLeafSize), mem_fn(&DataTreeTest_ResizeByTraversing::CreateFourLevelMinDataTreeWithLastLeafSize) ), //Last leaf size of the start tree Values( 0u, 1u, 10u, DataTreeTest_ResizeByTraversing::LAYOUT.maxBytesPerLeaf() ), //Number of leaves we're adding Values( 1u, 2u, DataTreeTest_ResizeByTraversing::LAYOUT.maxChildrenPerInnerNode(), //Full two level tree 2* DataTreeTest_ResizeByTraversing::LAYOUT.maxChildrenPerInnerNode(), //Three level tree with two children 3* DataTreeTest_ResizeByTraversing::LAYOUT.maxChildrenPerInnerNode(), //Three level tree with three children DataTreeTest_ResizeByTraversing::LAYOUT.maxChildrenPerInnerNode() * DataTreeTest_ResizeByTraversing::LAYOUT.maxChildrenPerInnerNode(), //Full three level tree DataTreeTest_ResizeByTraversing::LAYOUT.maxChildrenPerInnerNode() * DataTreeTest_ResizeByTraversing::LAYOUT.maxChildrenPerInnerNode() + 1 //Four level mindata tree ) ) ); TEST_P(DataTreeTest_ResizeByTraversing_P, StructureIsValid) { GrowTree(tree.get(), numberOfLeavesToAdd); EXPECT_IS_LEFTMAXDATA_TREE(tree->key()); } TEST_P(DataTreeTest_ResizeByTraversing_P, NumBytesIsCorrect) { GrowTree(tree.get(), numberOfLeavesToAdd); // tree->numLeaves() only goes down the right border nodes and expects the tree to be a left max data tree. // This is what the StructureIsValid test case is for. EXPECT_EQ(newNumberOfLeaves, tree->numLeaves()); } TEST_P(DataTreeTest_ResizeByTraversing_P, DepthFlagsAreCorrect) { GrowTree(tree.get(), numberOfLeavesToAdd); uint32_t depth = ceil(log(newNumberOfLeaves)/log(DataTreeTest_ResizeByTraversing::LAYOUT.maxChildrenPerInnerNode())); CHECK_DEPTH(depth, tree->key()); } TEST_P(DataTreeTest_ResizeByTraversing_P, KeyDoesntChange) { Key key = tree->key(); tree->flush(); GrowTree(tree.get(), numberOfLeavesToAdd); EXPECT_EQ(key, tree->key()); } TEST_P(DataTreeTest_ResizeByTraversing_P, DataStaysIntact) { uint32_t oldNumberOfLeaves = std::max(UINT64_C(1), ceilDivision(tree->numStoredBytes(), (uint64_t)nodeStore->layout().maxBytesPerLeaf())); TwoLevelDataFixture data(nodeStore, TwoLevelDataFixture::SizePolicy::Unchanged); Key key = tree->key(); cpputils::destruct(std::move(tree)); data.FillInto(nodeStore->load(key).get().get()); GrowTree(key, newNumberOfLeaves); data.EXPECT_DATA_CORRECT(nodeStore->load(key).get().get(), oldNumberOfLeaves, oldLastLeafSize); } test/blobstore/implementations/onblocks/datatreestore/DataTreeTest_ResizeNumBytes.cpp000066400000000000000000000206611300002025200317520ustar00rootroot00000000000000#include "testutils/DataTreeTest.h" #include "testutils/TwoLevelDataFixture.h" #include "blobstore/implementations/onblocks/utils/Math.h" #include #include using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Combine; using std::tuple; using std::get; using std::function; using std::mem_fn; using cpputils::dynamic_pointer_move; using blobstore::onblocks::datanodestore::DataLeafNode; using blobstore::onblocks::datanodestore::DataInnerNode; using blobstore::onblocks::datanodestore::DataNode; using blobstore::onblocks::datanodestore::DataNodeLayout; using blobstore::onblocks::datatreestore::DataTree; using blobstore::onblocks::utils::ceilDivision; using blockstore::Key; using cpputils::Data; using boost::none; using cpputils::unique_ref; class DataTreeTest_ResizeNumBytes: public DataTreeTest { public: static constexpr DataNodeLayout LAYOUT = DataNodeLayout(BLOCKSIZE_BYTES); unique_ref CreateTree(unique_ref root) { Key key = root->key(); cpputils::destruct(std::move(root)); return treeStore.load(key).value(); } unique_ref CreateLeafTreeWithSize(uint32_t size) { return CreateTree(CreateLeafWithSize(size)); } unique_ref CreateTwoLeafTreeWithSecondLeafSize(uint32_t size) { return CreateTree(CreateTwoLeafWithSecondLeafSize(size)); } unique_ref CreateFullTwoLevelTreeWithLastLeafSize(uint32_t size) { return CreateTree(CreateFullTwoLevelWithLastLeafSize(size)); } unique_ref CreateThreeLevelTreeWithTwoChildrenAndLastLeafSize(uint32_t size) { return CreateTree(CreateThreeLevelWithTwoChildrenAndLastLeafSize(size)); } unique_ref CreateThreeLevelTreeWithThreeChildrenAndLastLeafSize(uint32_t size) { return CreateTree(CreateThreeLevelWithThreeChildrenAndLastLeafSize(size)); } unique_ref CreateFullThreeLevelTreeWithLastLeafSize(uint32_t size) { return CreateTree(CreateFullThreeLevelWithLastLeafSize(size)); } unique_ref CreateFourLevelMinDataTreeWithLastLeafSize(uint32_t size) { return CreateTree(CreateFourLevelMinDataWithLastLeafSize(size)); } void EXPECT_IS_LEFTMAXDATA_TREE(const Key &key) { auto root = nodeStore->load(key).value(); DataInnerNode *inner = dynamic_cast(root.get()); if (inner != nullptr) { for (uint32_t i = 0; i < inner->numChildren()-1; ++i) { EXPECT_IS_MAXDATA_TREE(inner->getChild(i)->key()); } EXPECT_IS_LEFTMAXDATA_TREE(inner->LastChild()->key()); } } void EXPECT_IS_MAXDATA_TREE(const Key &key) { auto root = nodeStore->load(key).value(); DataInnerNode *inner = dynamic_cast(root.get()); if (inner != nullptr) { for (uint32_t i = 0; i < inner->numChildren(); ++i) { EXPECT_IS_MAXDATA_TREE(inner->getChild(i)->key()); } } else { DataLeafNode *leaf = dynamic_cast(root.get()); EXPECT_EQ(nodeStore->layout().maxBytesPerLeaf(), leaf->numBytes()); } } }; constexpr DataNodeLayout DataTreeTest_ResizeNumBytes::LAYOUT; class DataTreeTest_ResizeNumBytes_P: public DataTreeTest_ResizeNumBytes, public WithParamInterface(DataTreeTest_ResizeNumBytes*, uint32_t)>, uint32_t, uint32_t, uint32_t>> { public: DataTreeTest_ResizeNumBytes_P() : oldLastLeafSize(get<1>(GetParam())), tree(get<0>(GetParam())(this, oldLastLeafSize)), newNumberOfLeaves(get<2>(GetParam())), newLastLeafSize(get<3>(GetParam())), newSize((newNumberOfLeaves-1) * LAYOUT.maxBytesPerLeaf() + newLastLeafSize), ZEROES(LAYOUT.maxBytesPerLeaf()) { ZEROES.FillWithZeroes(); } void ResizeTree(const Key &key, uint64_t size) { treeStore.load(key).get()->resizeNumBytes(size); } unique_ref LastLeaf(const Key &key) { auto root = nodeStore->load(key).value(); auto leaf = dynamic_pointer_move(root); if (leaf != none) { return std::move(*leaf); } auto inner = dynamic_pointer_move(root).value(); return LastLeaf(inner->LastChild()->key()); } uint32_t oldLastLeafSize; unique_ref tree; uint32_t newNumberOfLeaves; uint32_t newLastLeafSize; uint64_t newSize; Data ZEROES; }; INSTANTIATE_TEST_CASE_P(DataTreeTest_ResizeNumBytes_P, DataTreeTest_ResizeNumBytes_P, Combine( //Tree we're starting with Values(DataTreeTest_ResizeNumBytes*, uint32_t)>>( mem_fn(&DataTreeTest_ResizeNumBytes::CreateLeafTreeWithSize), mem_fn(&DataTreeTest_ResizeNumBytes::CreateTwoLeafTreeWithSecondLeafSize), mem_fn(&DataTreeTest_ResizeNumBytes::CreateFullTwoLevelTreeWithLastLeafSize), mem_fn(&DataTreeTest_ResizeNumBytes::CreateThreeLevelTreeWithTwoChildrenAndLastLeafSize), mem_fn(&DataTreeTest_ResizeNumBytes::CreateThreeLevelTreeWithThreeChildrenAndLastLeafSize), mem_fn(&DataTreeTest_ResizeNumBytes::CreateFullThreeLevelTreeWithLastLeafSize), mem_fn(&DataTreeTest_ResizeNumBytes::CreateFourLevelMinDataTreeWithLastLeafSize) ), //Last leaf size of the start tree Values( 0u, 1u, 10u, DataTreeTest_ResizeNumBytes::LAYOUT.maxBytesPerLeaf() ), //Number of leaves we're resizing to Values( 1u, 2u, DataTreeTest_ResizeNumBytes::LAYOUT.maxChildrenPerInnerNode(), //Full two level tree 2* DataTreeTest_ResizeNumBytes::LAYOUT.maxChildrenPerInnerNode(), //Three level tree with two children 3* DataTreeTest_ResizeNumBytes::LAYOUT.maxChildrenPerInnerNode(), //Three level tree with three children DataTreeTest_ResizeNumBytes::LAYOUT.maxChildrenPerInnerNode() * DataTreeTest_ResizeNumBytes::LAYOUT.maxChildrenPerInnerNode(), //Full three level tree DataTreeTest_ResizeNumBytes::LAYOUT.maxChildrenPerInnerNode() * DataTreeTest_ResizeNumBytes::LAYOUT.maxChildrenPerInnerNode() + 1 //Four level mindata tree ), //Last leaf size of the resized tree Values( 1u, 10u, DataTreeTest_ResizeNumBytes::LAYOUT.maxBytesPerLeaf() ) ) ); TEST_P(DataTreeTest_ResizeNumBytes_P, StructureIsValid) { tree->resizeNumBytes(newSize); tree->flush(); EXPECT_IS_LEFTMAXDATA_TREE(tree->key()); } TEST_P(DataTreeTest_ResizeNumBytes_P, NumBytesIsCorrect) { tree->resizeNumBytes(newSize); tree->flush(); // tree->numStoredBytes() only goes down the right border nodes and expects the tree to be a left max data tree. // This is what the StructureIsValid test case is for. EXPECT_EQ(newSize, tree->numStoredBytes()); } TEST_P(DataTreeTest_ResizeNumBytes_P, DepthFlagsAreCorrect) { tree->resizeNumBytes(newSize); tree->flush(); uint32_t depth = ceil(log(newNumberOfLeaves)/log(DataTreeTest_ResizeNumBytes::LAYOUT.maxChildrenPerInnerNode()) - 0.00000000001); // The subtraction takes care of double inaccuracies if newNumberOfLeaves == maxChildrenPerInnerNode CHECK_DEPTH(depth, tree->key()); } TEST_P(DataTreeTest_ResizeNumBytes_P, KeyDoesntChange) { Key key = tree->key(); tree->flush(); tree->resizeNumBytes(newSize); EXPECT_EQ(key, tree->key()); } TEST_P(DataTreeTest_ResizeNumBytes_P, DataStaysIntact) { uint32_t oldNumberOfLeaves = std::max(UINT64_C(1), ceilDivision(tree->numStoredBytes(), (uint64_t)nodeStore->layout().maxBytesPerLeaf())); TwoLevelDataFixture data(nodeStore, TwoLevelDataFixture::SizePolicy::Unchanged); Key key = tree->key(); cpputils::destruct(std::move(tree)); data.FillInto(nodeStore->load(key).get().get()); ResizeTree(key, newSize); if (oldNumberOfLeaves < newNumberOfLeaves || (oldNumberOfLeaves == newNumberOfLeaves && oldLastLeafSize < newLastLeafSize)) { data.EXPECT_DATA_CORRECT(nodeStore->load(key).get().get(), oldNumberOfLeaves, oldLastLeafSize); } else { data.EXPECT_DATA_CORRECT(nodeStore->load(key).get().get(), newNumberOfLeaves, newLastLeafSize); } } //Resize to zero is not caught in the parametrized test above, in the following, we test it separately. TEST_F(DataTreeTest_ResizeNumBytes, ResizeToZero_NumBytesIsCorrect) { auto tree = CreateThreeLevelTreeWithThreeChildrenAndLastLeafSize(10u); tree->resizeNumBytes(0); Key key = tree->key(); cpputils::destruct(std::move(tree)); auto leaf = LoadLeafNode(key); EXPECT_EQ(0u, leaf->numBytes()); } TEST_F(DataTreeTest_ResizeNumBytes, ResizeToZero_KeyDoesntChange) { auto tree = CreateThreeLevelTreeWithThreeChildrenAndLastLeafSize(10u); Key key = tree->key(); tree->resizeNumBytes(0); tree->flush(); EXPECT_EQ(key, tree->key()); } test/blobstore/implementations/onblocks/datatreestore/DataTreeTest_TraverseLeaves.cpp000066400000000000000000000404511300002025200317540ustar00rootroot00000000000000#include "testutils/DataTreeTest.h" #include using ::testing::_; using blobstore::onblocks::datanodestore::DataLeafNode; using blobstore::onblocks::datanodestore::DataInnerNode; using blobstore::onblocks::datanodestore::DataNode; using blobstore::onblocks::datatreestore::DataTree; using blockstore::Key; using cpputils::unique_ref; class TraversorMock { public: MOCK_METHOD2(called, void(DataLeafNode*, uint32_t)); }; MATCHER_P(KeyEq, expected, "node key equals") { return arg->key() == expected; } class DataTreeTest_TraverseLeaves: public DataTreeTest { public: DataTreeTest_TraverseLeaves() :traversor() {} unique_ref CreateThreeLevel() { return CreateInner({ CreateFullTwoLevel(), CreateFullTwoLevel(), CreateFullTwoLevel(), CreateFullTwoLevel(), CreateFullTwoLevel(), CreateInner({CreateLeaf(), CreateLeaf(), CreateLeaf()})}); } unique_ref CreateFourLevel() { return CreateInner({ CreateFullThreeLevel(), CreateFullThreeLevel(), CreateInner({CreateFullTwoLevel(), CreateInner({CreateLeaf()})}) }); } void EXPECT_TRAVERSE_LEAF(const Key &key, uint32_t leafIndex) { EXPECT_CALL(traversor, called(KeyEq(key), leafIndex)).Times(1); } void EXPECT_TRAVERSE_ALL_CHILDREN_OF(const DataInnerNode &node, uint32_t firstLeafIndex) { for (unsigned int i = 0; i < node.numChildren(); ++i) { EXPECT_TRAVERSE_LEAF(node.getChild(i)->key(), firstLeafIndex+i); } } void EXPECT_DONT_TRAVERSE_ANY_LEAVES() { EXPECT_CALL(traversor, called(_, _)).Times(0); } void TraverseLeaves(DataNode *root, uint32_t beginIndex, uint32_t endIndex) { root->flush(); auto tree = treeStore.load(root->key()).value(); tree->traverseLeaves(beginIndex, endIndex, [this] (DataLeafNode *leaf, uint32_t nodeIndex) { traversor.called(leaf, nodeIndex); }); } TraversorMock traversor; }; TEST_F(DataTreeTest_TraverseLeaves, TraverseSingleLeafTree) { auto root = CreateLeaf(); EXPECT_TRAVERSE_LEAF(root->key(), 0); TraverseLeaves(root.get(), 0, 1); } TEST_F(DataTreeTest_TraverseLeaves, TraverseNothingInSingleLeafTree1) { auto root = CreateLeaf(); EXPECT_DONT_TRAVERSE_ANY_LEAVES(); TraverseLeaves(root.get(), 0, 0); } TEST_F(DataTreeTest_TraverseLeaves, TraverseNothingInSingleLeafTree2) { auto root = CreateLeaf(); EXPECT_DONT_TRAVERSE_ANY_LEAVES(); TraverseLeaves(root.get(), 1, 1); } TEST_F(DataTreeTest_TraverseLeaves, TraverseFirstLeafOfFullTwolevelTree) { auto root = CreateFullTwoLevel(); EXPECT_TRAVERSE_LEAF(root->getChild(0)->key(), 0); TraverseLeaves(root.get(), 0, 1); } TEST_F(DataTreeTest_TraverseLeaves, TraverseMiddleLeafOfFullTwolevelTree) { auto root = CreateFullTwoLevel(); EXPECT_TRAVERSE_LEAF(root->getChild(5)->key(), 5); TraverseLeaves(root.get(), 5, 6); } TEST_F(DataTreeTest_TraverseLeaves, TraverseLastLeafOfFullTwolevelTree) { auto root = CreateFullTwoLevel(); EXPECT_TRAVERSE_LEAF(root->getChild(nodeStore->layout().maxChildrenPerInnerNode()-1)->key(), nodeStore->layout().maxChildrenPerInnerNode()-1); TraverseLeaves(root.get(), nodeStore->layout().maxChildrenPerInnerNode()-1, nodeStore->layout().maxChildrenPerInnerNode()); } TEST_F(DataTreeTest_TraverseLeaves, TraverseNothingInFullTwolevelTree1) { auto root = CreateFullTwoLevel(); EXPECT_DONT_TRAVERSE_ANY_LEAVES(); TraverseLeaves(root.get(), 0, 0); } TEST_F(DataTreeTest_TraverseLeaves, TraverseNothingInFullTwolevelTree2) { auto root = CreateFullTwoLevel(); EXPECT_DONT_TRAVERSE_ANY_LEAVES(); TraverseLeaves(root.get(), nodeStore->layout().maxChildrenPerInnerNode(), nodeStore->layout().maxChildrenPerInnerNode()); } TEST_F(DataTreeTest_TraverseLeaves, TraverseFirstLeafOfThreeLevelMinDataTree) { auto root = CreateThreeLevelMinData(); EXPECT_TRAVERSE_LEAF(LoadInnerNode(root->getChild(0)->key())->getChild(0)->key(), 0); TraverseLeaves(root.get(), 0, 1); } TEST_F(DataTreeTest_TraverseLeaves, TraverseMiddleLeafOfThreeLevelMinDataTree) { auto root = CreateThreeLevelMinData(); EXPECT_TRAVERSE_LEAF(LoadInnerNode(root->getChild(0)->key())->getChild(5)->key(), 5); TraverseLeaves(root.get(), 5, 6); } TEST_F(DataTreeTest_TraverseLeaves, TraverseLastLeafOfThreeLevelMinDataTree) { auto root = CreateThreeLevelMinData(); EXPECT_TRAVERSE_LEAF(LoadInnerNode(root->getChild(1)->key())->getChild(0)->key(), nodeStore->layout().maxChildrenPerInnerNode()); TraverseLeaves(root.get(), nodeStore->layout().maxChildrenPerInnerNode(), nodeStore->layout().maxChildrenPerInnerNode()+1); } TEST_F(DataTreeTest_TraverseLeaves, TraverseAllLeavesOfFullTwolevelTree) { auto root = CreateFullTwoLevel(); EXPECT_TRAVERSE_ALL_CHILDREN_OF(*root, 0); TraverseLeaves(root.get(), 0, nodeStore->layout().maxChildrenPerInnerNode()); } TEST_F(DataTreeTest_TraverseLeaves, TraverseAllLeavesOfThreelevelMinDataTree) { auto root = CreateThreeLevelMinData(); EXPECT_TRAVERSE_ALL_CHILDREN_OF(*LoadInnerNode(root->getChild(0)->key()), 0); EXPECT_TRAVERSE_LEAF(LoadInnerNode(root->getChild(1)->key())->getChild(0)->key(), nodeStore->layout().maxChildrenPerInnerNode()); TraverseLeaves(root.get(), 0, nodeStore->layout().maxChildrenPerInnerNode()+1); } TEST_F(DataTreeTest_TraverseLeaves, TraverseFirstChildOfThreelevelMinDataTree) { auto root = CreateThreeLevelMinData(); EXPECT_TRAVERSE_ALL_CHILDREN_OF(*LoadInnerNode(root->getChild(0)->key()), 0); TraverseLeaves(root.get(), 0, nodeStore->layout().maxChildrenPerInnerNode()); } TEST_F(DataTreeTest_TraverseLeaves, TraverseFirstPartOfFullTwolevelTree) { auto root = CreateFullTwoLevel(); for (unsigned int i = 0; i < 5; ++i) { EXPECT_TRAVERSE_LEAF(root->getChild(i)->key(), i); } TraverseLeaves(root.get(), 0, 5); } TEST_F(DataTreeTest_TraverseLeaves, TraverseInnerPartOfFullTwolevelTree) { auto root = CreateFullTwoLevel(); for (unsigned int i = 5; i < 10; ++i) { EXPECT_TRAVERSE_LEAF(root->getChild(i)->key(), i); } TraverseLeaves(root.get(), 5, 10); } TEST_F(DataTreeTest_TraverseLeaves, TraverseLastPartOfFullTwolevelTree) { auto root = CreateFullTwoLevel(); for (unsigned int i = 5; i < nodeStore->layout().maxChildrenPerInnerNode(); ++i) { EXPECT_TRAVERSE_LEAF(root->getChild(i)->key(), i); } TraverseLeaves(root.get(), 5, nodeStore->layout().maxChildrenPerInnerNode()); } TEST_F(DataTreeTest_TraverseLeaves, TraverseFirstPartOfThreelevelMinDataTree) { auto root = CreateThreeLevelMinData(); auto node = LoadInnerNode(root->getChild(0)->key()); for (unsigned int i = 0; i < 5; ++i) { EXPECT_TRAVERSE_LEAF(node->getChild(i)->key(), i); } TraverseLeaves(root.get(), 0, 5); } TEST_F(DataTreeTest_TraverseLeaves, TraverseInnerPartOfThreelevelMinDataTree) { auto root = CreateThreeLevelMinData(); auto node = LoadInnerNode(root->getChild(0)->key()); for (unsigned int i = 5; i < 10; ++i) { EXPECT_TRAVERSE_LEAF(node->getChild(i)->key(), i); } TraverseLeaves(root.get(), 5, 10); } TEST_F(DataTreeTest_TraverseLeaves, TraverseLastPartOfThreelevelMinDataTree) { auto root = CreateThreeLevelMinData(); auto node = LoadInnerNode(root->getChild(0)->key()); for (unsigned int i = 5; i < nodeStore->layout().maxChildrenPerInnerNode(); ++i) { EXPECT_TRAVERSE_LEAF(node->getChild(i)->key(), i); } EXPECT_TRAVERSE_LEAF(LoadInnerNode(root->getChild(1)->key())->getChild(0)->key(), nodeStore->layout().maxChildrenPerInnerNode()); TraverseLeaves(root.get(), 5, nodeStore->layout().maxChildrenPerInnerNode()+1); } TEST_F(DataTreeTest_TraverseLeaves, TraverseFirstLeafOfThreelevelTree) { auto root = CreateThreeLevel(); EXPECT_TRAVERSE_LEAF(LoadInnerNode(root->getChild(0)->key())->getChild(0)->key(), 0); TraverseLeaves(root.get(), 0, 1); } TEST_F(DataTreeTest_TraverseLeaves, TraverseLastLeafOfThreelevelTree) { auto root = CreateThreeLevel(); uint32_t numLeaves = nodeStore->layout().maxChildrenPerInnerNode() * 5 + 3; EXPECT_TRAVERSE_LEAF(LoadInnerNode(root->LastChild()->key())->LastChild()->key(), numLeaves-1); TraverseLeaves(root.get(), numLeaves-1, numLeaves); } TEST_F(DataTreeTest_TraverseLeaves, TraverseMiddleLeafOfThreelevelTree) { auto root = CreateThreeLevel(); uint32_t wantedLeafIndex = nodeStore->layout().maxChildrenPerInnerNode() * 2 + 5; EXPECT_TRAVERSE_LEAF(LoadInnerNode(root->getChild(2)->key())->getChild(5)->key(), wantedLeafIndex); TraverseLeaves(root.get(), wantedLeafIndex, wantedLeafIndex+1); } TEST_F(DataTreeTest_TraverseLeaves, TraverseFirstPartOfThreelevelTree) { auto root = CreateThreeLevel(); //Traverse all leaves in the first two children of the root for(unsigned int i = 0; i < 2; ++i) { EXPECT_TRAVERSE_ALL_CHILDREN_OF(*LoadInnerNode(root->getChild(i)->key()), i * nodeStore->layout().maxChildrenPerInnerNode()); } //Traverse some of the leaves in the third child of the root auto child = LoadInnerNode(root->getChild(2)->key()); for(unsigned int i = 0; i < 5; ++i) { EXPECT_TRAVERSE_LEAF(child->getChild(i)->key(), 2 * nodeStore->layout().maxChildrenPerInnerNode() + i); } TraverseLeaves(root.get(), 0, 2 * nodeStore->layout().maxChildrenPerInnerNode() + 5); } TEST_F(DataTreeTest_TraverseLeaves, TraverseMiddlePartOfThreelevelTree_OnlyFullChildren) { auto root = CreateThreeLevel(); //Traverse some of the leaves in the second child of the root auto child = LoadInnerNode(root->getChild(1)->key()); for(unsigned int i = 5; i < nodeStore->layout().maxChildrenPerInnerNode(); ++i) { EXPECT_TRAVERSE_LEAF(child->getChild(i)->key(), nodeStore->layout().maxChildrenPerInnerNode() + i); } //Traverse all leaves in the third and fourth child of the root for(unsigned int i = 2; i < 4; ++i) { EXPECT_TRAVERSE_ALL_CHILDREN_OF(*LoadInnerNode(root->getChild(i)->key()), i * nodeStore->layout().maxChildrenPerInnerNode()); } //Traverse some of the leaves in the fifth child of the root child = LoadInnerNode(root->getChild(4)->key()); for(unsigned int i = 0; i < 5; ++i) { EXPECT_TRAVERSE_LEAF(child->getChild(i)->key(), 4 * nodeStore->layout().maxChildrenPerInnerNode() + i); } TraverseLeaves(root.get(), nodeStore->layout().maxChildrenPerInnerNode() + 5, 4 * nodeStore->layout().maxChildrenPerInnerNode() + 5); } TEST_F(DataTreeTest_TraverseLeaves, TraverseMiddlePartOfThreelevelTree_AlsoLastNonfullChild) { auto root = CreateThreeLevel(); //Traverse some of the leaves in the second child of the root auto child = LoadInnerNode(root->getChild(1)->key()); for(unsigned int i = 5; i < nodeStore->layout().maxChildrenPerInnerNode(); ++i) { EXPECT_TRAVERSE_LEAF(child->getChild(i)->key(), nodeStore->layout().maxChildrenPerInnerNode() + i); } //Traverse all leaves in the third, fourth and fifth child of the root for(unsigned int i = 2; i < 5; ++i) { EXPECT_TRAVERSE_ALL_CHILDREN_OF(*LoadInnerNode(root->getChild(i)->key()), i * nodeStore->layout().maxChildrenPerInnerNode()); } //Traverse some of the leaves in the sixth child of the root child = LoadInnerNode(root->getChild(5)->key()); for(unsigned int i = 0; i < 2; ++i) { EXPECT_TRAVERSE_LEAF(child->getChild(i)->key(), 5 * nodeStore->layout().maxChildrenPerInnerNode() + i); } TraverseLeaves(root.get(), nodeStore->layout().maxChildrenPerInnerNode() + 5, 5 * nodeStore->layout().maxChildrenPerInnerNode() + 2); } TEST_F(DataTreeTest_TraverseLeaves, TraverseLastPartOfThreelevelTree) { auto root = CreateThreeLevel(); //Traverse some of the leaves in the second child of the root auto child = LoadInnerNode(root->getChild(1)->key()); for(unsigned int i = 5; i < nodeStore->layout().maxChildrenPerInnerNode(); ++i) { EXPECT_TRAVERSE_LEAF(child->getChild(i)->key(), nodeStore->layout().maxChildrenPerInnerNode() + i); } //Traverse all leaves in the third, fourth and fifth child of the root for(unsigned int i = 2; i < 5; ++i) { EXPECT_TRAVERSE_ALL_CHILDREN_OF(*LoadInnerNode(root->getChild(i)->key()), i * nodeStore->layout().maxChildrenPerInnerNode()); } //Traverse all of the leaves in the sixth child of the root child = LoadInnerNode(root->getChild(5)->key()); for(unsigned int i = 0; i < child->numChildren(); ++i) { EXPECT_TRAVERSE_LEAF(child->getChild(i)->key(), 5 * nodeStore->layout().maxChildrenPerInnerNode() + i); } TraverseLeaves(root.get(), nodeStore->layout().maxChildrenPerInnerNode() + 5, 5 * nodeStore->layout().maxChildrenPerInnerNode() + child->numChildren()); } TEST_F(DataTreeTest_TraverseLeaves, TraverseAllLeavesOfThreelevelTree) { auto root = CreateThreeLevel(); //Traverse all leaves in the third, fourth and fifth child of the root for(unsigned int i = 0; i < 5; ++i) { EXPECT_TRAVERSE_ALL_CHILDREN_OF(*LoadInnerNode(root->getChild(i)->key()), i * nodeStore->layout().maxChildrenPerInnerNode()); } //Traverse all of the leaves in the sixth child of the root auto child = LoadInnerNode(root->getChild(5)->key()); for(unsigned int i = 0; i < child->numChildren(); ++i) { EXPECT_TRAVERSE_LEAF(child->getChild(i)->key(), 5 * nodeStore->layout().maxChildrenPerInnerNode() + i); } TraverseLeaves(root.get(), 0, 5 * nodeStore->layout().maxChildrenPerInnerNode() + child->numChildren()); } TEST_F(DataTreeTest_TraverseLeaves, TraverseAllLeavesOfFourLevelTree) { auto root = CreateFourLevel(); //Traverse all leaves of the full threelevel tree in the first child auto firstChild = LoadInnerNode(root->getChild(0)->key()); for(unsigned int i = 0; i < firstChild->numChildren(); ++i) { EXPECT_TRAVERSE_ALL_CHILDREN_OF(*LoadInnerNode(firstChild->getChild(i)->key()), i * nodeStore->layout().maxChildrenPerInnerNode()); } //Traverse all leaves of the full threelevel tree in the second child auto secondChild = LoadInnerNode(root->getChild(1)->key()); for(unsigned int i = 0; i < secondChild->numChildren(); ++i) { EXPECT_TRAVERSE_ALL_CHILDREN_OF(*LoadInnerNode(secondChild->getChild(i)->key()), (nodeStore->layout().maxChildrenPerInnerNode() + i) * nodeStore->layout().maxChildrenPerInnerNode()); } //Traverse all leaves of the non-full threelevel tree in the third child auto thirdChild = LoadInnerNode(root->getChild(2)->key()); EXPECT_TRAVERSE_ALL_CHILDREN_OF(*LoadInnerNode(thirdChild->getChild(0)->key()), 2 * nodeStore->layout().maxChildrenPerInnerNode() * nodeStore->layout().maxChildrenPerInnerNode()); EXPECT_TRAVERSE_LEAF(LoadInnerNode(thirdChild->getChild(1)->key())->getChild(0)->key(), 2 * nodeStore->layout().maxChildrenPerInnerNode() * nodeStore->layout().maxChildrenPerInnerNode() + nodeStore->layout().maxChildrenPerInnerNode()); TraverseLeaves(root.get(), 0, 2*nodeStore->layout().maxChildrenPerInnerNode()*nodeStore->layout().maxChildrenPerInnerNode() + nodeStore->layout().maxChildrenPerInnerNode() + 1); } TEST_F(DataTreeTest_TraverseLeaves, TraverseMiddlePartOfFourLevelTree) { auto root = CreateFourLevel(); //Traverse some leaves of the full threelevel tree in the first child auto firstChild = LoadInnerNode(root->getChild(0)->key()); auto secondChildOfFirstChild = LoadInnerNode(firstChild->getChild(1)->key()); for(unsigned int i = 5; i < secondChildOfFirstChild->numChildren(); ++i) { EXPECT_TRAVERSE_LEAF(secondChildOfFirstChild->getChild(i)->key(), nodeStore->layout().maxChildrenPerInnerNode()+i); } for(unsigned int i = 2; i < firstChild->numChildren(); ++i) { EXPECT_TRAVERSE_ALL_CHILDREN_OF(*LoadInnerNode(firstChild->getChild(i)->key()), i * nodeStore->layout().maxChildrenPerInnerNode()); } //Traverse all leaves of the full threelevel tree in the second child auto secondChild = LoadInnerNode(root->getChild(1)->key()); for(unsigned int i = 0; i < secondChild->numChildren(); ++i) { EXPECT_TRAVERSE_ALL_CHILDREN_OF(*LoadInnerNode(secondChild->getChild(i)->key()), (nodeStore->layout().maxChildrenPerInnerNode() + i) * nodeStore->layout().maxChildrenPerInnerNode()); } //Traverse some leaves of the non-full threelevel tree in the third child auto thirdChild = LoadInnerNode(root->getChild(2)->key()); auto firstChildOfThirdChild = LoadInnerNode(thirdChild->getChild(0)->key()); for(unsigned int i = 0; i < firstChildOfThirdChild->numChildren()-1; ++i) { EXPECT_TRAVERSE_LEAF(firstChildOfThirdChild->getChild(i)->key(), 2 * nodeStore->layout().maxChildrenPerInnerNode()*nodeStore->layout().maxChildrenPerInnerNode()+i); } TraverseLeaves(root.get(), nodeStore->layout().maxChildrenPerInnerNode()+5, 2*nodeStore->layout().maxChildrenPerInnerNode()*nodeStore->layout().maxChildrenPerInnerNode() + nodeStore->layout().maxChildrenPerInnerNode() -1); } //TODO Refactor the test cases that are too long test/blobstore/implementations/onblocks/datatreestore/impl/000077500000000000000000000000001300002025200246415ustar00rootroot00000000000000GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNullTest.cpp000066400000000000000000000064241300002025200412250ustar00rootroot00000000000000test/blobstore/implementations/onblocks/datatreestore/impl#include #include "../testutils/DataTreeTest.h" #include "blobstore/implementations/onblocks/datatreestore/DataTree.h" #include "blobstore/implementations/onblocks/datanodestore/DataLeafNode.h" #include "blobstore/implementations/onblocks/datanodestore/DataInnerNode.h" #include #include "blobstore/implementations/onblocks/datatreestore/impl/algorithms.h" using ::testing::Test; using std::pair; using std::make_pair; using blobstore::onblocks::datanodestore::DataNodeStore; using blobstore::onblocks::datanodestore::DataNode; using blobstore::onblocks::datanodestore::DataInnerNode; using blockstore::testfake::FakeBlockStore; using blockstore::Key; using namespace blobstore::onblocks::datatreestore::algorithms; class GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNullTest: public DataTreeTest { public: struct TestData { Key rootNode; Key expectedResult; }; void check(const TestData &testData) { auto root = nodeStore->load(testData.rootNode).value(); auto result = GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNull(nodeStore, root.get()); EXPECT_EQ(testData.expectedResult, result->key()); } TestData CreateTwoRightBorderNodes() { auto node = CreateInner({CreateLeaf()}); return TestData{node->key(), node->key()}; } TestData CreateThreeRightBorderNodes() { auto node = CreateInner({CreateLeaf()}); auto root = CreateInner({node.get()}); return TestData{root->key(), node->key()}; } TestData CreateThreeRightBorderNodes_LastFull() { auto root = CreateInner({CreateFullTwoLevel()}); return TestData{root->key(), root->key()}; } TestData CreateLargerTree() { auto node = CreateInner({CreateLeaf(), CreateLeaf()}); auto root = CreateInner({CreateFullTwoLevel().get(), node.get()}); return TestData{root->key(), node->key()}; } }; TEST_F(GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNullTest, Leaf) { auto leaf = nodeStore->createNewLeafNode(); auto result = GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNull(nodeStore, leaf.get()); EXPECT_EQ(nullptr, result.get()); } TEST_F(GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNullTest, TwoRightBorderNodes) { auto testData = CreateTwoRightBorderNodes(); check(testData); } TEST_F(GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNullTest, ThreeRightBorderNodes) { auto testData = CreateThreeRightBorderNodes(); check(testData); } TEST_F(GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNullTest, ThreeRightBorderNodes_LastFull) { auto testData = CreateThreeRightBorderNodes_LastFull(); check(testData); } TEST_F(GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNullTest, LargerTree) { auto testData = CreateLargerTree(); check(testData); } TEST_F(GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNullTest, FullTwoLevelTree) { auto root = CreateFullTwoLevel(); auto result = GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNull(nodeStore, root.get()); EXPECT_EQ(nullptr, result.get()); } TEST_F(GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNullTest, FullThreeLevelTree) { auto root = CreateFullThreeLevel(); auto result = GetLowestInnerRightBorderNodeWithLessThanKChildrenOrNull(nodeStore, root.get()); EXPECT_EQ(nullptr, result.get()); } GetLowestRightBorderNodeWithMoreThanOneChildOrNullTest.cpp000066400000000000000000000104041300002025200400400ustar00rootroot00000000000000test/blobstore/implementations/onblocks/datatreestore/impl#include #include "../testutils/DataTreeTest.h" #include "blobstore/implementations/onblocks/datatreestore/DataTree.h" #include "blobstore/implementations/onblocks/datanodestore/DataLeafNode.h" #include "blobstore/implementations/onblocks/datanodestore/DataInnerNode.h" #include #include "blobstore/implementations/onblocks/datatreestore/impl/algorithms.h" using ::testing::Test; using std::pair; using std::make_pair; using blobstore::onblocks::datanodestore::DataNodeStore; using blobstore::onblocks::datanodestore::DataNode; using blobstore::onblocks::datanodestore::DataInnerNode; using blockstore::testfake::FakeBlockStore; using blockstore::Key; using namespace blobstore::onblocks::datatreestore::algorithms; class GetLowestRightBorderNodeWithMoreThanOneChildOrNullTest: public DataTreeTest { public: struct TestData { Key rootNode; Key expectedResult; }; void check(const TestData &testData) { auto root = nodeStore->load(testData.rootNode).value(); auto result = GetLowestRightBorderNodeWithMoreThanOneChildOrNull(nodeStore, root.get()); EXPECT_EQ(testData.expectedResult, result->key()); } Key CreateLeafOnlyTree() { return CreateLeaf()->key(); } Key CreateTwoRightBorderNodes() { return CreateInner({CreateLeaf()})->key(); } Key CreateThreeRightBorderNodes() { return CreateInner({CreateInner({CreateLeaf()})})->key(); } TestData CreateThreeRightBorderNodes_LastFull() { auto node = CreateFullTwoLevel(); auto root = CreateInner({node.get()}); return TestData{root->key(), node->key()}; } TestData CreateLargerTree() { auto node = CreateInner({CreateLeaf(), CreateLeaf()}); auto root = CreateInner({CreateFullTwoLevel().get(), node.get()}); return TestData{root->key(), node->key()}; } TestData CreateThreeLevelTreeWithRightBorderSingleNodeChain() { auto root = CreateInner({CreateFullTwoLevel(), CreateInner({CreateLeaf()})}); return TestData{root->key(), root->key()}; } TestData CreateThreeLevelTree() { auto node = CreateInner({CreateLeaf(), CreateLeaf()}); auto root = CreateInner({CreateFullTwoLevel().get(), node.get()}); return TestData{root->key(), node->key()}; } TestData CreateFullTwoLevelTree() { auto node = CreateFullTwoLevel(); return TestData{node->key(), node->key()}; } TestData CreateFullThreeLevelTree() { auto root = CreateFullThreeLevel(); return TestData{root->key(), root->LastChild()->key()}; } }; TEST_F(GetLowestRightBorderNodeWithMoreThanOneChildOrNullTest, Leaf) { auto leaf = nodeStore->load(CreateLeafOnlyTree()).value(); auto result = GetLowestRightBorderNodeWithMoreThanOneChildOrNull(nodeStore, leaf.get()); EXPECT_EQ(nullptr, result.get()); } TEST_F(GetLowestRightBorderNodeWithMoreThanOneChildOrNullTest, TwoRightBorderNodes) { auto node = nodeStore->load(CreateTwoRightBorderNodes()).value(); auto result = GetLowestRightBorderNodeWithMoreThanOneChildOrNull(nodeStore, node.get()); EXPECT_EQ(nullptr, result.get()); } TEST_F(GetLowestRightBorderNodeWithMoreThanOneChildOrNullTest, ThreeRightBorderNodes) { auto node = nodeStore->load(CreateThreeRightBorderNodes()).value(); auto result = GetLowestRightBorderNodeWithMoreThanOneChildOrNull(nodeStore, node.get()); EXPECT_EQ(nullptr, result.get()); } TEST_F(GetLowestRightBorderNodeWithMoreThanOneChildOrNullTest, ThreeRightBorderNodes_LastFull) { auto testData = CreateThreeRightBorderNodes_LastFull(); check(testData); } TEST_F(GetLowestRightBorderNodeWithMoreThanOneChildOrNullTest, LargerTree) { auto testData = CreateLargerTree(); check(testData); } TEST_F(GetLowestRightBorderNodeWithMoreThanOneChildOrNullTest, FullTwoLevelTree) { auto testData = CreateFullTwoLevelTree(); check(testData); } TEST_F(GetLowestRightBorderNodeWithMoreThanOneChildOrNullTest, FullThreeLevelTree) { auto testData = CreateFullThreeLevelTree(); check(testData); } TEST_F(GetLowestRightBorderNodeWithMoreThanOneChildOrNullTest, ThreeLevelTreeWithRightBorderSingleNodeChain) { auto testData = CreateThreeLevelTreeWithRightBorderSingleNodeChain(); check(testData); } TEST_F(GetLowestRightBorderNodeWithMoreThanOneChildOrNullTest, ThreeLevelTree) { auto testData = CreateThreeLevelTree(); check(testData); } test/blobstore/implementations/onblocks/datatreestore/testutils/000077500000000000000000000000001300002025200257405ustar00rootroot00000000000000test/blobstore/implementations/onblocks/datatreestore/testutils/DataTreeTest.cpp000066400000000000000000000174071300002025200310060ustar00rootroot00000000000000#include "DataTreeTest.h" #include #include #include using blobstore::onblocks::datanodestore::DataNodeStore; using blobstore::onblocks::datanodestore::DataNode; using blobstore::onblocks::datanodestore::DataInnerNode; using blobstore::onblocks::datanodestore::DataLeafNode; using blobstore::onblocks::datatreestore::DataTree; using blockstore::testfake::FakeBlockStore; using blockstore::Key; using cpputils::unique_ref; using cpputils::make_unique_ref; using std::initializer_list; using std::vector; using boost::none; using cpputils::dynamic_pointer_move; constexpr uint32_t DataTreeTest::BLOCKSIZE_BYTES; DataTreeTest::DataTreeTest() :_nodeStore(make_unique_ref(make_unique_ref(), BLOCKSIZE_BYTES)), nodeStore(_nodeStore.get()), treeStore(std::move(_nodeStore)) { } unique_ref DataTreeTest::CreateLeaf() { return nodeStore->createNewLeafNode(); } unique_ref DataTreeTest::CreateInner(initializer_list> children) { vector childrenVector(children.size()); std::transform(children.begin(), children.end(), childrenVector.begin(), [](const unique_ref &ptr) {return ptr.get();}); return CreateInner(childrenVector); } unique_ref DataTreeTest::CreateInner(initializer_list children) { return CreateInner(vector(children)); } unique_ref DataTreeTest::CreateInner(vector children) { ASSERT(children.size() >= 1, "An inner node must have at least one child"); auto node = nodeStore->createNewInnerNode(**children.begin()); for(auto child = children.begin()+1; child != children.end(); ++child) { node->addChild(**child); } return node; } unique_ref DataTreeTest::CreateLeafOnlyTree() { auto key = CreateLeaf()->key(); return treeStore.load(key).value(); } void DataTreeTest::FillNode(DataInnerNode *node) { for(unsigned int i=node->numChildren(); i < nodeStore->layout().maxChildrenPerInnerNode(); ++i) { node->addChild(*CreateLeaf()); } } void DataTreeTest::FillNodeTwoLevel(DataInnerNode *node) { for(unsigned int i=node->numChildren(); i < nodeStore->layout().maxChildrenPerInnerNode(); ++i) { node->addChild(*CreateFullTwoLevel()); } } unique_ref DataTreeTest::CreateFullTwoLevel() { auto root = CreateInner({CreateLeaf().get()}); FillNode(root.get()); return root; } unique_ref DataTreeTest::CreateThreeLevelMinData() { return CreateInner({ CreateFullTwoLevel(), CreateInner({CreateLeaf()}) }); } unique_ref DataTreeTest::CreateFourLevelMinData() { return CreateInner({ CreateFullThreeLevel(), CreateInner({CreateInner({CreateLeaf()})}) }); } unique_ref DataTreeTest::CreateFullThreeLevel() { auto root = CreateInner({CreateFullTwoLevel().get()}); FillNodeTwoLevel(root.get()); return root; } unique_ref DataTreeTest::LoadInnerNode(const Key &key) { auto node = nodeStore->load(key).value(); auto casted = dynamic_pointer_move(node); EXPECT_NE(none, casted) << "Is not an inner node"; return std::move(*casted); } unique_ref DataTreeTest::LoadLeafNode(const Key &key) { auto node = nodeStore->load(key).value(); auto casted = dynamic_pointer_move(node); EXPECT_NE(none, casted) << "Is not a leaf node"; return std::move(*casted); } unique_ref DataTreeTest::CreateTwoLeaf() { return CreateInner({CreateLeaf().get(), CreateLeaf().get()}); } unique_ref DataTreeTest::CreateTwoLeafTree() { auto key = CreateTwoLeaf()->key(); return treeStore.load(key).value(); } unique_ref DataTreeTest::CreateLeafWithSize(uint32_t size) { auto leaf = CreateLeaf(); leaf->resize(size); return leaf; } unique_ref DataTreeTest::CreateTwoLeafWithSecondLeafSize(uint32_t size) { return CreateInner({ CreateLeafWithSize(nodeStore->layout().maxBytesPerLeaf()), CreateLeafWithSize(size) }); } unique_ref DataTreeTest::CreateFullTwoLevelWithLastLeafSize(uint32_t size) { auto root = CreateFullTwoLevel(); for (uint32_t i = 0; i < root->numChildren()-1; ++i) { LoadLeafNode(root->getChild(i)->key())->resize(nodeStore->layout().maxBytesPerLeaf()); } LoadLeafNode(root->LastChild()->key())->resize(size); return root; } unique_ref DataTreeTest::CreateThreeLevelWithOneChildAndLastLeafSize(uint32_t size) { return CreateInner({ CreateInner({ CreateLeafWithSize(nodeStore->layout().maxBytesPerLeaf()), CreateLeafWithSize(size) }) }); } unique_ref DataTreeTest::CreateThreeLevelWithTwoChildrenAndLastLeafSize(uint32_t size) { return CreateInner({ CreateFullTwoLevelWithLastLeafSize(nodeStore->layout().maxBytesPerLeaf()), CreateInner({ CreateLeafWithSize(nodeStore->layout().maxBytesPerLeaf()), CreateLeafWithSize(size) }) }); } unique_ref DataTreeTest::CreateThreeLevelWithThreeChildrenAndLastLeafSize(uint32_t size) { return CreateInner({ CreateFullTwoLevelWithLastLeafSize(nodeStore->layout().maxBytesPerLeaf()), CreateFullTwoLevelWithLastLeafSize(nodeStore->layout().maxBytesPerLeaf()), CreateInner({ CreateLeafWithSize(nodeStore->layout().maxBytesPerLeaf()), CreateLeafWithSize(size) }) }); } unique_ref DataTreeTest::CreateFullThreeLevelWithLastLeafSize(uint32_t size) { auto root = CreateFullThreeLevel(); for (uint32_t i = 0; i < root->numChildren(); ++i) { auto node = LoadInnerNode(root->getChild(i)->key()); for (uint32_t j = 0; j < node->numChildren(); ++j) { LoadLeafNode(node->getChild(j)->key())->resize(nodeStore->layout().maxBytesPerLeaf()); } } LoadLeafNode(LoadInnerNode(root->LastChild()->key())->LastChild()->key())->resize(size); return root; } unique_ref DataTreeTest::CreateFourLevelMinDataWithLastLeafSize(uint32_t size) { return CreateInner({ CreateFullThreeLevelWithLastLeafSize(nodeStore->layout().maxBytesPerLeaf()), CreateInner({CreateInner({CreateLeafWithSize(size)})}) }); } void DataTreeTest::EXPECT_IS_LEAF_NODE(const Key &key) { auto node = LoadLeafNode(key); EXPECT_NE(nullptr, node.get()); } void DataTreeTest::EXPECT_IS_INNER_NODE(const Key &key) { auto node = LoadInnerNode(key); EXPECT_NE(nullptr, node.get()); } void DataTreeTest::EXPECT_IS_TWONODE_CHAIN(const Key &key) { auto node = LoadInnerNode(key); EXPECT_EQ(1u, node->numChildren()); EXPECT_IS_LEAF_NODE(node->getChild(0)->key()); } void DataTreeTest::EXPECT_IS_FULL_TWOLEVEL_TREE(const Key &key) { auto node = LoadInnerNode(key); EXPECT_EQ(nodeStore->layout().maxChildrenPerInnerNode(), node->numChildren()); for (unsigned int i = 0; i < node->numChildren(); ++i) { EXPECT_IS_LEAF_NODE(node->getChild(i)->key()); } } void DataTreeTest::EXPECT_IS_FULL_THREELEVEL_TREE(const Key &key) { auto root = LoadInnerNode(key); EXPECT_EQ(nodeStore->layout().maxChildrenPerInnerNode(), root->numChildren()); for (unsigned int i = 0; i < root->numChildren(); ++i) { auto node = LoadInnerNode(root->getChild(i)->key()); EXPECT_EQ(nodeStore->layout().maxChildrenPerInnerNode(), node->numChildren()); for (unsigned int j = 0; j < node->numChildren(); ++j) { EXPECT_IS_LEAF_NODE(node->getChild(j)->key()); } } } void DataTreeTest::CHECK_DEPTH(int depth, const Key &key) { if (depth == 0) { EXPECT_IS_LEAF_NODE(key); } else { auto node = LoadInnerNode(key); EXPECT_EQ(depth, node->depth()); for (uint32_t i = 0; i < node->numChildren(); ++i) { CHECK_DEPTH(depth-1, node->getChild(i)->key()); } } } test/blobstore/implementations/onblocks/datatreestore/testutils/DataTreeTest.h000066400000000000000000000077151300002025200304540ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_TEST_IMPLEMENTATIONS_ONBLOCKS_DATATREESTORE_DATATREETEST_H_ #define MESSMER_BLOBSTORE_TEST_IMPLEMENTATIONS_ONBLOCKS_DATATREESTORE_DATATREETEST_H_ #include #include "blobstore/implementations/onblocks/datanodestore/DataNodeStore.h" #include "blobstore/implementations/onblocks/datanodestore/DataInnerNode.h" #include "blobstore/implementations/onblocks/datanodestore/DataLeafNode.h" #include "blobstore/implementations/onblocks/datatreestore/DataTree.h" #include "blobstore/implementations/onblocks/datatreestore/DataTreeStore.h" class DataTreeTest: public ::testing::Test { public: DataTreeTest(); static constexpr uint32_t BLOCKSIZE_BYTES = 256; cpputils::unique_ref CreateLeaf(); cpputils::unique_ref CreateInner(std::vector children); cpputils::unique_ref CreateInner(std::initializer_list children); cpputils::unique_ref CreateInner(std::initializer_list> children); cpputils::unique_ref CreateLeafOnlyTree(); cpputils::unique_ref CreateTwoLeaf(); cpputils::unique_ref CreateTwoLeafTree(); void FillNode(blobstore::onblocks::datanodestore::DataInnerNode *node); void FillNodeTwoLevel(blobstore::onblocks::datanodestore::DataInnerNode *node); cpputils::unique_ref CreateFullTwoLevel(); cpputils::unique_ref CreateFullThreeLevel(); cpputils::unique_ref CreateThreeLevelMinData(); cpputils::unique_ref CreateFourLevelMinData(); cpputils::unique_ref LoadInnerNode(const blockstore::Key &key); cpputils::unique_ref LoadLeafNode(const blockstore::Key &key); cpputils::unique_ref CreateLeafWithSize(uint32_t size); cpputils::unique_ref CreateTwoLeafWithSecondLeafSize(uint32_t size); cpputils::unique_ref CreateFullTwoLevelWithLastLeafSize(uint32_t size); cpputils::unique_ref CreateThreeLevelWithOneChildAndLastLeafSize(uint32_t size); cpputils::unique_ref CreateThreeLevelWithTwoChildrenAndLastLeafSize(uint32_t size); cpputils::unique_ref CreateThreeLevelWithThreeChildrenAndLastLeafSize(uint32_t size); cpputils::unique_ref CreateFullThreeLevelWithLastLeafSize(uint32_t size); cpputils::unique_ref CreateFourLevelMinDataWithLastLeafSize(uint32_t size); cpputils::unique_ref _nodeStore; blobstore::onblocks::datanodestore::DataNodeStore *nodeStore; blobstore::onblocks::datatreestore::DataTreeStore treeStore; void EXPECT_IS_LEAF_NODE(const blockstore::Key &key); void EXPECT_IS_INNER_NODE(const blockstore::Key &key); void EXPECT_IS_TWONODE_CHAIN(const blockstore::Key &key); void EXPECT_IS_FULL_TWOLEVEL_TREE(const blockstore::Key &key); void EXPECT_IS_FULL_THREELEVEL_TREE(const blockstore::Key &key); void CHECK_DEPTH(int depth, const blockstore::Key &key); private: DISALLOW_COPY_AND_ASSIGN(DataTreeTest); }; #endif test/blobstore/implementations/onblocks/datatreestore/testutils/LeafDataFixture.h000066400000000000000000000026671300002025200311340ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_TEST_IMPLEMENTATIONS_ONBLOCKS_DATATREESTORE_GROWING_TESTUTILS_LEAFDATAFIXTURE_H_ #define MESSMER_BLOBSTORE_TEST_IMPLEMENTATIONS_ONBLOCKS_DATATREESTORE_GROWING_TESTUTILS_LEAFDATAFIXTURE_H_ #include #include // A data fixture containing data for a leaf. // The class can fill this data into a given leaf // and check, whether the data stored in a given leaf is correct. class LeafDataFixture { public: LeafDataFixture(int size, int iv = 0): _data(cpputils::DataFixture::generate(size, iv)) {} void FillInto(blobstore::onblocks::datanodestore::DataLeafNode *leaf) const { leaf->resize(_data.size()); leaf->write(_data.data(), 0, _data.size()); } void EXPECT_DATA_CORRECT(const blobstore::onblocks::datanodestore::DataLeafNode &leaf, int onlyCheckNumBytes = -1) const { if (onlyCheckNumBytes == -1) { EXPECT_EQ(_data.size(), leaf.numBytes()); EXPECT_EQ(0, std::memcmp(_data.data(), loadData(leaf).data(), _data.size())); } else { EXPECT_LE(onlyCheckNumBytes, (int)leaf.numBytes()); EXPECT_EQ(0, std::memcmp(_data.data(), loadData(leaf).data(), onlyCheckNumBytes)); } } private: static cpputils::Data loadData(const blobstore::onblocks::datanodestore::DataLeafNode &leaf) { cpputils::Data data(leaf.numBytes()); leaf.read(data.data(), 0, leaf.numBytes()); return data; } cpputils::Data _data; }; #endif test/blobstore/implementations/onblocks/datatreestore/testutils/TwoLevelDataFixture.h000066400000000000000000000066351300002025200320250ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_TEST_IMPLEMENTATIONS_ONBLOCKS_DATATREESTORE_GROWING_TESTUTILS_TWOLEVELDATAFIXTURE_H_ #define MESSMER_BLOBSTORE_TEST_IMPLEMENTATIONS_ONBLOCKS_DATATREESTORE_GROWING_TESTUTILS_TWOLEVELDATAFIXTURE_H_ #include #include #include "LeafDataFixture.h" #include //TODO Rename, since we now allow any number of levels // A data fixture containing data for a two-level tree (one inner node with leaf children). // The class can fill this data into the leaf children of a given inner node // and given an inner node can check, whether the data stored is correct. class TwoLevelDataFixture { public: enum class SizePolicy { Random, Full, Unchanged }; TwoLevelDataFixture(blobstore::onblocks::datanodestore::DataNodeStore *dataNodeStore, SizePolicy sizePolicy, int iv=0): _dataNodeStore(dataNodeStore), _iv(iv), _sizePolicy(sizePolicy) {} void FillInto(blobstore::onblocks::datanodestore::DataNode *node) { // _iv-1 means there is no endLeafIndex - we fill all leaves. ForEachLeaf(node, _iv, _iv-1, [this] (blobstore::onblocks::datanodestore::DataLeafNode *leaf, int leafIndex) { LeafDataFixture(size(leafIndex, leaf), leafIndex).FillInto(leaf); }); } void EXPECT_DATA_CORRECT(blobstore::onblocks::datanodestore::DataNode *node, int maxCheckedLeaves = 0, int lastLeafMaxCheckedBytes = -1) { ForEachLeaf(node, _iv, _iv+maxCheckedLeaves, [this, maxCheckedLeaves, lastLeafMaxCheckedBytes] (blobstore::onblocks::datanodestore::DataLeafNode *leaf, int leafIndex) { if (leafIndex == _iv+maxCheckedLeaves-1) { // It is the last leaf LeafDataFixture(size(leafIndex, leaf), leafIndex).EXPECT_DATA_CORRECT(*leaf, lastLeafMaxCheckedBytes); } else { LeafDataFixture(size(leafIndex, leaf), leafIndex).EXPECT_DATA_CORRECT(*leaf); } }); } private: int ForEachLeaf(blobstore::onblocks::datanodestore::DataNode *node, int firstLeafIndex, int endLeafIndex, std::function action) { if (firstLeafIndex == endLeafIndex) { return firstLeafIndex; } auto leaf = dynamic_cast(node); if (leaf != nullptr) { action(leaf, firstLeafIndex); return firstLeafIndex + 1; } else { auto inner = dynamic_cast(node); int leafIndex = firstLeafIndex; for (uint32_t i = 0; i < inner->numChildren(); ++i) { auto child = _dataNodeStore->load(inner->getChild(i)->key()).value(); leafIndex = ForEachLeaf(child.get(), leafIndex, endLeafIndex, action); } return leafIndex; } } blobstore::onblocks::datanodestore::DataNodeStore *_dataNodeStore; int _iv; SizePolicy _sizePolicy; int size(int childIndex, blobstore::onblocks::datanodestore::DataLeafNode *leaf) { switch (_sizePolicy) { case SizePolicy::Full: return _dataNodeStore->layout().maxBytesPerLeaf(); case SizePolicy::Random: return mod(_dataNodeStore->layout().maxBytesPerLeaf() - childIndex, _dataNodeStore->layout().maxBytesPerLeaf()); case SizePolicy::Unchanged: return leaf->numBytes(); default: ASSERT(false, "Unknown size policy"); } } int mod(int value, int mod) { while(value < 0) { value += mod; } return value; } }; #endif test/blobstore/implementations/onblocks/testutils/000077500000000000000000000000001300002025200230725ustar00rootroot00000000000000test/blobstore/implementations/onblocks/testutils/BlobStoreTest.cpp000066400000000000000000000007301300002025200263310ustar00rootroot00000000000000#include "BlobStoreTest.h" #include #include "blobstore/implementations/onblocks/BlobStoreOnBlocks.h" using blobstore::onblocks::BlobStoreOnBlocks; using blockstore::testfake::FakeBlockStore; using cpputils::make_unique_ref; constexpr uint32_t BlobStoreTest::BLOCKSIZE_BYTES; BlobStoreTest::BlobStoreTest() : blobStore(make_unique_ref(make_unique_ref(), BLOCKSIZE_BYTES)) { } test/blobstore/implementations/onblocks/testutils/BlobStoreTest.h000066400000000000000000000013671300002025200260050ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOBSTORE_TEST_IMPLEMENTATIONS_ONBLOCKS_TESTUTILS_BLOBSTORETEST_H_ #define MESSMER_BLOBSTORE_TEST_IMPLEMENTATIONS_ONBLOCKS_TESTUTILS_BLOBSTORETEST_H_ #include #include "blobstore/interface/BlobStore.h" class BlobStoreTest: public ::testing::Test { public: BlobStoreTest(); static constexpr uint32_t BLOCKSIZE_BYTES = 4096; cpputils::unique_ref blobStore; cpputils::unique_ref loadBlob(const blockstore::Key &key) { auto loaded = blobStore->load(key); EXPECT_TRUE((bool)loaded); return std::move(*loaded); } void reset(cpputils::unique_ref ref) { UNUSED(ref); //ref is moved into here and then destructed } }; #endif test/blobstore/implementations/onblocks/utils/000077500000000000000000000000001300002025200221725ustar00rootroot00000000000000test/blobstore/implementations/onblocks/utils/CeilDivisionTest.cpp000066400000000000000000000034641300002025200261260ustar00rootroot00000000000000#include #include "blobstore/implementations/onblocks/utils/Math.h" #include using namespace blobstore::onblocks::utils; using ::testing::Test; using std::numeric_limits; class CeilDivisionTest: public Test {}; TEST_F(CeilDivisionTest, Divide0_4) { EXPECT_EQ(0, ceilDivision(0, 4)); } TEST_F(CeilDivisionTest, Divide1_4) { EXPECT_EQ(1, ceilDivision(1, 4)); } TEST_F(CeilDivisionTest, Divide2_4) { EXPECT_EQ(1, ceilDivision(2, 4)); } TEST_F(CeilDivisionTest, Divide3_4) { EXPECT_EQ(1, ceilDivision(3, 4)); } TEST_F(CeilDivisionTest, Divide4_4) { EXPECT_EQ(1, ceilDivision(4, 4)); } TEST_F(CeilDivisionTest, Divide5_4) { EXPECT_EQ(2, ceilDivision(5, 4)); } TEST_F(CeilDivisionTest, Divide6_4) { EXPECT_EQ(2, ceilDivision(6, 4)); } TEST_F(CeilDivisionTest, Divide7_4) { EXPECT_EQ(2, ceilDivision(7, 4)); } TEST_F(CeilDivisionTest, Divide8_4) { EXPECT_EQ(2, ceilDivision(8, 4)); } TEST_F(CeilDivisionTest, Divide9_4) { EXPECT_EQ(3, ceilDivision(9, 4)); } TEST_F(CeilDivisionTest, Divide0_1) { EXPECT_EQ(0, ceilDivision(0, 1)); } TEST_F(CeilDivisionTest, Divide5_1) { EXPECT_EQ(5, ceilDivision(5, 1)); } TEST_F(CeilDivisionTest, Divide7_2) { EXPECT_EQ(4, ceilDivision(7, 2)); } TEST_F(CeilDivisionTest, Divide8_2) { EXPECT_EQ(4, ceilDivision(8, 2)); } TEST_F(CeilDivisionTest, Divide9_2) { EXPECT_EQ(5, ceilDivision(9, 2)); } TEST_F(CeilDivisionTest, Divide1_1) { EXPECT_EQ(1, ceilDivision(1, 1)); } TEST_F(CeilDivisionTest, Divide5_5) { EXPECT_EQ(1, ceilDivision(5, 5)); } TEST_F(CeilDivisionTest, DivideLargeByItself) { EXPECT_EQ(1, ceilDivision(183495303, 183495303)); } TEST_F(CeilDivisionTest, 64bit) { uint64_t base = UINT64_C(1024)*1024*1024*1024; EXPECT_GT(base, std::numeric_limits::max()); EXPECT_EQ(base/1024, ceilDivision(base, (uint64_t)1024)); } test/blobstore/implementations/onblocks/utils/CeilLogTest.cpp000066400000000000000000000012551300002025200250570ustar00rootroot00000000000000#include #include "blobstore/implementations/onblocks/utils/Math.h" #include using namespace blobstore::onblocks::utils; using ::testing::Test; using std::numeric_limits; class CeilLogTest: public Test {}; TEST_F(CeilLogTest, Log3_1) { EXPECT_EQ(0, ceilLog(3, 1)); } TEST_F(CeilLogTest, Log3_2) { EXPECT_EQ(1, ceilLog(3, 2)); } TEST_F(CeilLogTest, Log3_3) { EXPECT_EQ(1, ceilLog(3, 3)); } TEST_F(CeilLogTest, Log3_4) { EXPECT_EQ(2, ceilLog(3, 4)); } TEST_F(CeilLogTest, 64bit) { uint64_t value = UINT64_C(1024)*1024*1024*1024; EXPECT_GT(value, std::numeric_limits::max()); EXPECT_EQ(4u, ceilLog((uint64_t)1024, value)); } //TODO ... test/blobstore/implementations/onblocks/utils/IntPowTest.cpp000066400000000000000000000030321300002025200247540ustar00rootroot00000000000000#include #include "blobstore/implementations/onblocks/utils/Math.h" using namespace blobstore::onblocks::utils; using ::testing::Test; class IntPowTest: public Test {}; TEST_F(IntPowTest, ExponentAndBaseAreZero) { EXPECT_EQ(1, intPow(0, 0)); } TEST_F(IntPowTest, ExponentIsZero1) { EXPECT_EQ(1, intPow(1, 0)); } TEST_F(IntPowTest, ExponentIsZero2) { EXPECT_EQ(1, intPow(1000, 0)); } TEST_F(IntPowTest, BaseIsZero1) { EXPECT_EQ(0, intPow(0, 1)); } TEST_F(IntPowTest, BaseIsZero2) { EXPECT_EQ(0, intPow(0, 1000)); } TEST_F(IntPowTest, ExponentIsOne1) { EXPECT_EQ(0, intPow(0, 1)); } TEST_F(IntPowTest, ExponentIsOne2) { EXPECT_EQ(2, intPow(2, 1)); } TEST_F(IntPowTest, ExponentIsOne3) { EXPECT_EQ(1000, intPow(1000, 1)); } TEST_F(IntPowTest, BaseIsTwo1) { EXPECT_EQ(1024, intPow(2, 10)); } TEST_F(IntPowTest, BaseIsTwo2) { EXPECT_EQ(1024*1024, intPow(2, 20)); } TEST_F(IntPowTest, BaseIsTwo3) { EXPECT_EQ(1024*1024*1024, intPow(2, 30)); } TEST_F(IntPowTest, BaseIsTen1) { EXPECT_EQ(100, intPow(10, 2)); } TEST_F(IntPowTest, BaseIsTen2) { EXPECT_EQ(1000000, intPow(10, 6)); } TEST_F(IntPowTest, ArbitraryNumbers1) { EXPECT_EQ(4096, intPow(4, 6)); } TEST_F(IntPowTest, ArbitraryNumbers2) { EXPECT_EQ(1296, intPow(6, 4)); } TEST_F(IntPowTest, ArbitraryNumbers3) { EXPECT_EQ(282475249, intPow(7, 10)); } TEST_F(IntPowTest, 64bit) { uint64_t value = UINT64_C(1024)*1024*1024*1024; EXPECT_GT(value, std::numeric_limits::max()); EXPECT_EQ(value*value*value, intPow(value, (uint64_t)3)); }test/blobstore/implementations/onblocks/utils/MaxZeroSubtractionTest.cpp000066400000000000000000000054141300002025200273450ustar00rootroot00000000000000#include #include "blobstore/implementations/onblocks/utils/Math.h" #include using namespace blobstore::onblocks::utils; using ::testing::Test; using std::numeric_limits; class MaxZeroSubtractionTest: public Test {}; TEST_F(MaxZeroSubtractionTest, SubtractToZero1) { EXPECT_EQ(0, maxZeroSubtraction(0, 0)); } TEST_F(MaxZeroSubtractionTest, SubtractToZero2) { EXPECT_EQ(0, maxZeroSubtraction(5, 5)); } TEST_F(MaxZeroSubtractionTest, SubtractToZero3) { EXPECT_EQ(0, maxZeroSubtraction(184930, 184930)); } TEST_F(MaxZeroSubtractionTest, SubtractToZero4) { EXPECT_EQ(0u, maxZeroSubtraction(numeric_limits::max()-1, numeric_limits::max()-1)); } TEST_F(MaxZeroSubtractionTest, SubtractToZero5) { EXPECT_EQ(0u, maxZeroSubtraction(numeric_limits::max(), numeric_limits::max())); } TEST_F(MaxZeroSubtractionTest, SubtractPositive1) { EXPECT_EQ(1, maxZeroSubtraction(5, 4)); } TEST_F(MaxZeroSubtractionTest, SubtractPositive2) { EXPECT_EQ(181081, maxZeroSubtraction(184930, 3849)); } TEST_F(MaxZeroSubtractionTest, SubtractPositive3) { EXPECT_EQ(numeric_limits::max()-1, maxZeroSubtraction(numeric_limits::max(), UINT32_C(1))); } TEST_F(MaxZeroSubtractionTest, SubtractPositive4) { EXPECT_EQ(5u, maxZeroSubtraction(numeric_limits::max(), numeric_limits::max()-5)); } TEST_F(MaxZeroSubtractionTest, SubtractNegative1) { EXPECT_EQ(0, maxZeroSubtraction(4, 5)); } TEST_F(MaxZeroSubtractionTest, SubtractNegative2) { EXPECT_EQ(0, maxZeroSubtraction(3849, 184930)); } TEST_F(MaxZeroSubtractionTest, SubtractNegative3) { EXPECT_EQ(0u, maxZeroSubtraction(numeric_limits::max()-1, numeric_limits::max())); } TEST_F(MaxZeroSubtractionTest, SubtractNegative4) { EXPECT_EQ(0u, maxZeroSubtraction(numeric_limits::max()-5, numeric_limits::max())); } TEST_F(MaxZeroSubtractionTest, SubtractNegative5) { EXPECT_EQ(0u, maxZeroSubtraction(UINT32_C(5), numeric_limits::max())); } TEST_F(MaxZeroSubtractionTest, SubtractFromZero1) { EXPECT_EQ(0, maxZeroSubtraction(0, 1)); } TEST_F(MaxZeroSubtractionTest, SubtractFromZero2) { EXPECT_EQ(0, maxZeroSubtraction(0, 184930)); } TEST_F(MaxZeroSubtractionTest, SubtractFromZero3) { EXPECT_EQ(0u, maxZeroSubtraction(UINT32_C(0), numeric_limits::max())); } TEST_F(MaxZeroSubtractionTest, 64bit_valid) { uint64_t value = UINT64_C(1024)*1024*1024*1024; EXPECT_GT(value, std::numeric_limits::max()); EXPECT_EQ(value*1024-value, maxZeroSubtraction(value*1024, value)); } TEST_F(MaxZeroSubtractionTest, 64bit_zero) { uint64_t value = UINT64_C(1024)*1024*1024*1024; EXPECT_GT(value, std::numeric_limits::max()); EXPECT_EQ(0u, maxZeroSubtraction(value, value*1024)); } test/blockstore/000077500000000000000000000000001300002025200141645ustar00rootroot00000000000000test/blockstore/CMakeLists.txt000066400000000000000000000043321300002025200167260ustar00rootroot00000000000000project (blockstore-test) set(SOURCES utils/BlockStoreUtilsTest.cpp interface/helpers/BlockStoreWithRandomKeysTest.cpp interface/BlockStoreTest.cpp interface/BlockTest.cpp implementations/testfake/TestFakeBlockStoreTest.cpp implementations/inmemory/InMemoryBlockStoreTest.cpp implementations/parallelaccess/ParallelAccessBlockStoreTest_Generic.cpp implementations/parallelaccess/ParallelAccessBlockStoreTest_Specific.cpp implementations/compressing/CompressingBlockStoreTest.cpp implementations/compressing/compressors/testutils/CompressorTest.cpp implementations/encrypted/EncryptedBlockStoreTest_Generic.cpp implementations/encrypted/EncryptedBlockStoreTest_Specific.cpp implementations/ondisk/OnDiskBlockStoreTest_Generic.cpp implementations/ondisk/OnDiskBlockStoreTest_Specific.cpp implementations/ondisk/OnDiskBlockTest/OnDiskBlockCreateTest.cpp implementations/ondisk/OnDiskBlockTest/OnDiskBlockFlushTest.cpp implementations/ondisk/OnDiskBlockTest/OnDiskBlockLoadTest.cpp implementations/caching/CachingBlockStoreTest_Generic.cpp implementations/caching/CachingBlockStoreTest_Specific.cpp implementations/caching/cache/QueueMapTest_Values.cpp implementations/caching/cache/testutils/MinimalKeyType.cpp implementations/caching/cache/testutils/CopyableMovableValueType.cpp implementations/caching/cache/testutils/MinimalValueType.cpp implementations/caching/cache/testutils/QueueMapTest.cpp implementations/caching/cache/testutils/CacheTest.cpp implementations/caching/cache/QueueMapTest_Size.cpp implementations/caching/cache/CacheTest_MoveConstructor.cpp implementations/caching/cache/CacheTest_PushAndPop.cpp implementations/caching/cache/QueueMapTest_MoveConstructor.cpp implementations/caching/cache/QueueMapTest_MemoryLeak.cpp implementations/caching/cache/CacheTest_RaceCondition.cpp implementations/caching/cache/PeriodicTaskTest.cpp implementations/caching/cache/QueueMapTest_Peek.cpp ) add_executable(${PROJECT_NAME} ${SOURCES}) target_link_libraries(${PROJECT_NAME} googletest blockstore) add_test(${PROJECT_NAME} ${PROJECT_NAME}) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) test/blockstore/implementations/000077500000000000000000000000001300002025200173745ustar00rootroot00000000000000test/blockstore/implementations/caching/000077500000000000000000000000001300002025200207705ustar00rootroot00000000000000test/blockstore/implementations/caching/CachingBlockStoreTest_Generic.cpp000066400000000000000000000014511300002025200273150ustar00rootroot00000000000000#include "blockstore/implementations/caching/CachingBlockStore.h" #include "blockstore/implementations/testfake/FakeBlockStore.h" #include "../../testutils/BlockStoreTest.h" #include #include using blockstore::BlockStore; using blockstore::caching::CachingBlockStore; using blockstore::testfake::FakeBlockStore; using cpputils::unique_ref; using cpputils::make_unique_ref; class CachingBlockStoreTestFixture: public BlockStoreTestFixture { public: unique_ref createBlockStore() override { return make_unique_ref(make_unique_ref()); } }; INSTANTIATE_TYPED_TEST_CASE_P(Caching, BlockStoreTest, CachingBlockStoreTestFixture); //TODO Add specific tests for the blockstore test/blockstore/implementations/caching/CachingBlockStoreTest_Specific.cpp000066400000000000000000000042521300002025200274700ustar00rootroot00000000000000#include #include "blockstore/implementations/caching/CachingBlockStore.h" #include "blockstore/implementations/testfake/FakeBlockStore.h" using ::testing::Test; using cpputils::Data; using cpputils::unique_ref; using cpputils::make_unique_ref; using blockstore::testfake::FakeBlockStore; using namespace blockstore::caching; class CachingBlockStoreTest: public Test { public: CachingBlockStoreTest(): baseBlockStore(new FakeBlockStore), blockStore(std::move(cpputils::nullcheck(std::unique_ptr(baseBlockStore)).value())) { } FakeBlockStore *baseBlockStore; CachingBlockStore blockStore; blockstore::Key CreateBlockReturnKey(const Data &initData) { auto block = blockStore.create(initData); block->flush(); return block->key(); } }; TEST_F(CachingBlockStoreTest, PhysicalBlockSize_zerophysical) { EXPECT_EQ(0u, blockStore.blockSizeFromPhysicalBlockSize(0)); } TEST_F(CachingBlockStoreTest, PhysicalBlockSize_zerovirtual) { auto key = CreateBlockReturnKey(Data(0)); auto base = baseBlockStore->load(key).value(); EXPECT_EQ(0u, blockStore.blockSizeFromPhysicalBlockSize(base->size())); } TEST_F(CachingBlockStoreTest, PhysicalBlockSize_negativeboundaries) { // This tests that a potential if/else in blockSizeFromPhysicalBlockSize that catches negative values has the // correct boundary set. We test the highest value that is negative and the smallest value that is positive. auto physicalSizeForVirtualSizeZero = baseBlockStore->load(CreateBlockReturnKey(Data(0))).value()->size(); if (physicalSizeForVirtualSizeZero > 0) { EXPECT_EQ(0u, blockStore.blockSizeFromPhysicalBlockSize(physicalSizeForVirtualSizeZero - 1)); } EXPECT_EQ(0u, blockStore.blockSizeFromPhysicalBlockSize(physicalSizeForVirtualSizeZero)); EXPECT_EQ(1u, blockStore.blockSizeFromPhysicalBlockSize(physicalSizeForVirtualSizeZero + 1)); } TEST_F(CachingBlockStoreTest, PhysicalBlockSize_positive) { auto key = CreateBlockReturnKey(Data(10*1024)); auto base = baseBlockStore->load(key).value(); EXPECT_EQ(10*1024u, blockStore.blockSizeFromPhysicalBlockSize(base->size())); } test/blockstore/implementations/caching/cache/000077500000000000000000000000001300002025200220335ustar00rootroot00000000000000test/blockstore/implementations/caching/cache/CacheTest_MoveConstructor.cpp000066400000000000000000000026261300002025200276440ustar00rootroot00000000000000#include #include #include "blockstore/implementations/caching/cache/Cache.h" #include "testutils/MinimalKeyType.h" #include "testutils/CopyableMovableValueType.h" using namespace blockstore::caching; using cpputils::unique_ref; using cpputils::make_unique_ref; using ::testing::Test; //Test that Cache uses a move constructor for Value if possible class CacheTest_MoveConstructor: public Test { public: CacheTest_MoveConstructor(): cache(make_unique_ref>()) { CopyableMovableValueType::numCopyConstructorCalled = 0; } unique_ref> cache; }; TEST_F(CacheTest_MoveConstructor, MoveIntoCache) { cache->push(MinimalKeyType::create(0), CopyableMovableValueType(2)); CopyableMovableValueType val = cache->pop(MinimalKeyType::create(0)).value(); val.value(); //Access it to avoid the compiler optimizing the assignment away EXPECT_EQ(0, CopyableMovableValueType::numCopyConstructorCalled); } TEST_F(CacheTest_MoveConstructor, CopyIntoCache) { CopyableMovableValueType value(2); cache->push(MinimalKeyType::create(0), value); CopyableMovableValueType val = cache->pop(MinimalKeyType::create(0)).value(); val.value(); //Access it to avoid the compiler optimizing the assignment away EXPECT_EQ(1, CopyableMovableValueType::numCopyConstructorCalled); } test/blockstore/implementations/caching/cache/CacheTest_PushAndPop.cpp000066400000000000000000000072601300002025200265100ustar00rootroot00000000000000#include "testutils/CacheTest.h" #include "blockstore/implementations/caching/cache/Cache.h" #include "testutils/MinimalKeyType.h" #include "testutils/MinimalValueType.h" #include using ::testing::Test; using namespace blockstore::caching; class CacheTest_PushAndPop: public CacheTest {}; TEST_F(CacheTest_PushAndPop, PopNonExistingEntry_EmptyCache) { EXPECT_EQ(boost::none, pop(10)); } TEST_F(CacheTest_PushAndPop, PopNonExistingEntry_NonEmptyCache) { push(9, 10); EXPECT_EQ(boost::none, pop(10)); } TEST_F(CacheTest_PushAndPop, PopNonExistingEntry_FullCache) { //Add a lot of even numbered keys for (unsigned int i = 0; i < MAX_ENTRIES; ++i) { push(2*i, 2*i); } //Request an odd numbered key EXPECT_EQ(boost::none, pop(9)); } TEST_F(CacheTest_PushAndPop, OneEntry) { push(10, 20); EXPECT_EQ(20, pop(10).value()); } TEST_F(CacheTest_PushAndPop, MultipleEntries) { push(10, 20); push(20, 30); push(30, 40); EXPECT_EQ(30, pop(20).value()); EXPECT_EQ(20, pop(10).value()); EXPECT_EQ(40, pop(30).value()); } TEST_F(CacheTest_PushAndPop, FullCache) { for(unsigned int i = 0; i < MAX_ENTRIES; ++i) { push(i, 2*i); } for(unsigned int i = 0; i < MAX_ENTRIES; ++i) { EXPECT_EQ((signed int)(2*i), pop(i).value()); } } TEST_F(CacheTest_PushAndPop, FullCache_PushNonOrdered_PopOrdered) { for(unsigned int i = 1; i < MAX_ENTRIES; i += 2) { push(i, 2*i); } for(unsigned int i = 0; i < MAX_ENTRIES; i += 2) { push(i, 2*i); } for(unsigned int i = 0; i < MAX_ENTRIES; ++i) { EXPECT_EQ((signed int)(2*i), pop(i).value()); } } TEST_F(CacheTest_PushAndPop, FullCache_PushOrdered_PopNonOrdered) { for(unsigned int i = 0; i < MAX_ENTRIES; ++i) { push(i, 2*i); } for(unsigned int i = 1; i < MAX_ENTRIES; i += 2) { EXPECT_EQ((signed int)(2*i), pop(i).value()); } for(unsigned int i = 0; i < MAX_ENTRIES; i += 2) { EXPECT_EQ((signed int)(2*i), pop(i).value()); } } int roundDownToEven(int number) { if (number % 2 == 0) { return number; } else { return number - 1; } } int roundDownToOdd(int number) { if (number % 2 != 0) { return number; } else { return number - 1; } } TEST_F(CacheTest_PushAndPop, FullCache_PushNonOrdered_PopNonOrdered) { for(int i = roundDownToEven(MAX_ENTRIES - 1); i >= 0; i -= 2) { push(i, 2*i); } for(unsigned int i = 1; i < MAX_ENTRIES; i += 2) { push(i, 2*i); } for(int i = roundDownToOdd(MAX_ENTRIES-1); i >= 0; i -= 2) { EXPECT_EQ((signed int)(2*i), pop(i).value()); } for(unsigned int i = 0; i < MAX_ENTRIES; i += 2) { EXPECT_EQ((signed int)(2*i), pop(i).value()); } } TEST_F(CacheTest_PushAndPop, MoreThanFullCache) { for(unsigned int i = 0; i < MAX_ENTRIES + 2; ++i) { push(i, 2*i); } //Check that the oldest two elements got deleted automatically EXPECT_EQ(boost::none, pop(0)); EXPECT_EQ(boost::none, pop(1)); //Check the other elements are still there for(unsigned int i = 2; i < MAX_ENTRIES + 2; ++i) { EXPECT_EQ((signed int)(2*i), pop(i).value()); } } TEST_F(CacheTest_PushAndPop, AfterTimeout) { constexpr double TIMEOUT1_SEC = Cache::MAX_LIFETIME_SEC * 3/4; constexpr double TIMEOUT2_SEC = Cache::PURGE_LIFETIME_SEC * 3/4; static_assert(TIMEOUT1_SEC + TIMEOUT2_SEC > Cache::MAX_LIFETIME_SEC, "Ensure that our chosen timeouts push the first entry out of the cache"); push(10, 20); boost::this_thread::sleep_for(boost::chrono::milliseconds(static_cast(1000 * TIMEOUT1_SEC))); push(20, 30); boost::this_thread::sleep_for(boost::chrono::milliseconds(static_cast(1000 * TIMEOUT2_SEC))); EXPECT_EQ(boost::none, pop(10)); EXPECT_EQ(30, pop(20).value()); } test/blockstore/implementations/caching/cache/CacheTest_RaceCondition.cpp000066400000000000000000000071121300002025200272040ustar00rootroot00000000000000#include "testutils/CacheTest.h" #include #include #include #include #include using namespace blockstore::caching; using std::chrono::seconds; using std::string; using cpputils::ConditionBarrier; using std::unique_ptr; using std::make_unique; using std::future; // Regression tests for a race condition. // An element could be in the process of being thrown out of the cache and while the destructor is running, another // thread calls pop() for the element and gets none returned. But since the destructor isn't finished yet, the data from // the cache element also isn't completely written back yet and an application loading it runs into a race condition. class ObjectWithLongDestructor { public: ObjectWithLongDestructor(ConditionBarrier *onDestructorStarted, bool *destructorFinished) : _onDestructorStarted(onDestructorStarted), _destructorFinished(destructorFinished) {} ~ObjectWithLongDestructor() { _onDestructorStarted->release(); std::this_thread::sleep_for(seconds(1)); *_destructorFinished = true; } private: ConditionBarrier *_onDestructorStarted; bool *_destructorFinished; DISALLOW_COPY_AND_ASSIGN(ObjectWithLongDestructor); }; class CacheTest_RaceCondition: public ::testing::Test { public: CacheTest_RaceCondition(): cache(), destructorStarted(), destructorFinished(false) {} static constexpr unsigned int MAX_ENTRIES = 100; Cache, MAX_ENTRIES> cache; ConditionBarrier destructorStarted; bool destructorFinished; int pushObjectWithLongDestructor() { cache.push(2, make_unique(&destructorStarted, &destructorFinished)); return 2; } int pushDummyObject() { cache.push(3, nullptr); return 3; } future causeCacheOverflowInOtherThread() { //Add maximum+1 element in another thread (this causes the cache to flush the first element in another thread) return std::async(std::launch::async, [this] { for(unsigned int i = 0; i < MAX_ENTRIES+1; ++i) { cache.push(MAX_ENTRIES+i, nullptr); } }); } void EXPECT_POP_BLOCKS_UNTIL_DESTRUCTOR_FINISHED(int key) { EXPECT_FALSE(destructorFinished); cache.pop(key); EXPECT_TRUE(destructorFinished); } void EXPECT_POP_DOESNT_BLOCK_UNTIL_DESTRUCTOR_FINISHED(int key) { EXPECT_FALSE(destructorFinished); cache.pop(key); EXPECT_FALSE(destructorFinished); } }; TEST_F(CacheTest_RaceCondition, PopBlocksWhileRequestedElementIsThrownOut_ByAge) { auto id = pushObjectWithLongDestructor(); destructorStarted.wait(); EXPECT_POP_BLOCKS_UNTIL_DESTRUCTOR_FINISHED(id); } TEST_F(CacheTest_RaceCondition, PopDoesntBlockWhileOtherElementIsThrownOut_ByAge) { pushObjectWithLongDestructor(); auto id = pushDummyObject(); destructorStarted.wait(); EXPECT_POP_DOESNT_BLOCK_UNTIL_DESTRUCTOR_FINISHED(id); } TEST_F(CacheTest_RaceCondition, PopBlocksWhileRequestedElementIsThrownOut_ByPush) { auto id = pushObjectWithLongDestructor(); auto future = causeCacheOverflowInOtherThread(); destructorStarted.wait(); EXPECT_POP_BLOCKS_UNTIL_DESTRUCTOR_FINISHED(id); } TEST_F(CacheTest_RaceCondition, PopDoesntBlockWhileOtherElementIsThrownOut_ByPush) { pushObjectWithLongDestructor(); auto id = pushDummyObject(); auto future = causeCacheOverflowInOtherThread(); destructorStarted.wait(); EXPECT_POP_DOESNT_BLOCK_UNTIL_DESTRUCTOR_FINISHED(id); } test/blockstore/implementations/caching/cache/PeriodicTaskTest.cpp000066400000000000000000000025401300002025200257610ustar00rootroot00000000000000#include #include "blockstore/implementations/caching/cache/PeriodicTask.h" #include #include #include using ::testing::Test; using std::mutex; using std::unique_lock; using std::condition_variable; using namespace blockstore::caching; class AtomicCounter { public: AtomicCounter(int count): _mutex(), _cv(), _counter(count) {} void decrease() { unique_lock lock(_mutex); --_counter; _cv.notify_all(); } void waitForZero() { unique_lock lock(_mutex); _cv.wait(lock, [this] () {return _counter <= 0;}); } private: mutex _mutex; condition_variable _cv; int _counter; }; class PeriodicTaskTest: public Test { }; TEST_F(PeriodicTaskTest, DoesntDeadlockInDestructorWhenDestructedImmediately) { PeriodicTask task([](){}, 1); } TEST_F(PeriodicTaskTest, CallsCallbackAtLeast10Times) { AtomicCounter counter(10); PeriodicTask task([&counter](){ counter.decrease(); }, 0.001); counter.waitForZero(); } TEST_F(PeriodicTaskTest, DoesntCallCallbackAfterDestruction) { std::atomic callCount(0); { PeriodicTask task([&callCount](){ callCount += 1; }, 0.001); } int callCountDirectlyAfterDestruction = callCount; boost::this_thread::sleep_for(boost::chrono::seconds(1)); EXPECT_EQ(callCountDirectlyAfterDestruction, callCount); } test/blockstore/implementations/caching/cache/QueueMapTest_MemoryLeak.cpp000066400000000000000000000034571300002025200272570ustar00rootroot00000000000000#include "testutils/QueueMapTest.h" // Tests that QueueMap calls destructors correctly. // This is needed, because QueueMap does its own memory management. class QueueMapTest_MemoryLeak: public QueueMapTest { public: void EXPECT_NUM_INSTANCES(int num) { EXPECT_EQ(num, MinimalKeyType::instances); EXPECT_EQ(num, MinimalValueType::instances); } }; TEST_F(QueueMapTest_MemoryLeak, Empty) { EXPECT_NUM_INSTANCES(0); } TEST_F(QueueMapTest_MemoryLeak, AfterPushingOne) { push(2, 3); EXPECT_NUM_INSTANCES(1); } TEST_F(QueueMapTest_MemoryLeak, AfterPushingTwo) { push(2, 3); push(3, 4); EXPECT_NUM_INSTANCES(2); } TEST_F(QueueMapTest_MemoryLeak, AfterPushingTwoAndPoppingOldest) { push(2, 3); push(3, 4); pop(); EXPECT_NUM_INSTANCES(1); } TEST_F(QueueMapTest_MemoryLeak, AfterPushingTwoAndPoppingFirst) { push(2, 3); push(3, 4); pop(2); EXPECT_NUM_INSTANCES(1); } TEST_F(QueueMapTest_MemoryLeak, AfterPushingTwoAndPoppingLast) { push(2, 3); push(3, 4); pop(3); EXPECT_NUM_INSTANCES(1); } TEST_F(QueueMapTest_MemoryLeak, AfterPushingOnePoppingOne) { push(2, 3); pop(); EXPECT_NUM_INSTANCES(0); } TEST_F(QueueMapTest_MemoryLeak, AfterPushingOnePoppingOnePerKey) { push(2, 3); pop(2); EXPECT_NUM_INSTANCES(0); } TEST_F(QueueMapTest_MemoryLeak, AfterPushingOnePoppingOnePushingOne) { push(2, 3); pop(); push(3, 4); EXPECT_NUM_INSTANCES(1); } TEST_F(QueueMapTest_MemoryLeak, AfterPushingOnePoppingOnePerKeyPushingOne) { push(2, 3); pop(2); push(3, 4); EXPECT_NUM_INSTANCES(1); } TEST_F(QueueMapTest_MemoryLeak, AfterPushingOnePoppingOnePushingSame) { push(2, 3); pop(); push(2, 3); EXPECT_NUM_INSTANCES(1); } TEST_F(QueueMapTest_MemoryLeak, AfterPushingOnePoppingOnePerKeyPushingSame) { push(2, 3); pop(2); push(2, 3); EXPECT_NUM_INSTANCES(1); } test/blockstore/implementations/caching/cache/QueueMapTest_MoveConstructor.cpp000066400000000000000000000042011300002025200303520ustar00rootroot00000000000000#include #include #include "blockstore/implementations/caching/cache/QueueMap.h" #include "testutils/MinimalKeyType.h" #include "testutils/CopyableMovableValueType.h" using namespace blockstore::caching; using ::testing::Test; using cpputils::unique_ref; using cpputils::make_unique_ref; //Test that QueueMap uses a move constructor for Value if possible class QueueMapTest_MoveConstructor: public Test { public: QueueMapTest_MoveConstructor(): map(make_unique_ref>()) { CopyableMovableValueType::numCopyConstructorCalled = 0; } unique_ref> map; }; TEST_F(QueueMapTest_MoveConstructor, PushingAndPopping_MoveIntoMap) { map->push(MinimalKeyType::create(0), CopyableMovableValueType(2)); CopyableMovableValueType val = map->pop().value(); val.value(); //Access it to avoid the compiler optimizing the assignment away EXPECT_EQ(0, CopyableMovableValueType::numCopyConstructorCalled); } TEST_F(QueueMapTest_MoveConstructor, PushingAndPoppingPerKey_MoveIntoMap) { map->push(MinimalKeyType::create(0), CopyableMovableValueType(2)); CopyableMovableValueType val = map->pop(MinimalKeyType::create(0)).value(); val.value(); //Access it to avoid the compiler optimizing the assignment away EXPECT_EQ(0, CopyableMovableValueType::numCopyConstructorCalled); } TEST_F(QueueMapTest_MoveConstructor, PushingAndPopping_CopyIntoMap) { CopyableMovableValueType value(2); map->push(MinimalKeyType::create(0), value); CopyableMovableValueType val = map->pop().value(); val.value(); //Access it to avoid the compiler optimizing the assignment away EXPECT_EQ(1, CopyableMovableValueType::numCopyConstructorCalled); } TEST_F(QueueMapTest_MoveConstructor, PushingAndPoppingPerKey_CopyIntoMap) { CopyableMovableValueType value(2); map->push(MinimalKeyType::create(0), value); CopyableMovableValueType val = map->pop(MinimalKeyType::create(0)).value(); val.value(); //Access it to avoid the compiler optimizing the assignment away EXPECT_EQ(1, CopyableMovableValueType::numCopyConstructorCalled); } test/blockstore/implementations/caching/cache/QueueMapTest_Peek.cpp000066400000000000000000000014261300002025200260700ustar00rootroot00000000000000#include "testutils/QueueMapTest.h" #include class QueueMapPeekTest: public QueueMapTest {}; TEST_F(QueueMapPeekTest, PoppingFromEmpty) { EXPECT_EQ(boost::none, peek()); } TEST_F(QueueMapPeekTest, PushingOne) { push(3, 2); EXPECT_EQ(2, peek().value()); } TEST_F(QueueMapPeekTest, PushingTwo) { push(2, 3); push(3, 4); EXPECT_EQ(3, peek().value()); EXPECT_EQ(3, peek().value()); EXPECT_EQ(3, pop().value()); EXPECT_EQ(4, peek().value()); EXPECT_EQ(4, peek().value()); EXPECT_EQ(4, pop().value()); EXPECT_EQ(boost::none, peek()); EXPECT_EQ(boost::none, pop()); } TEST_F(QueueMapPeekTest, AfterPushingTwoAndPoppingFirst) { push(2, 3); push(3, 4); pop(2); EXPECT_EQ(boost::none, pop(2)); EXPECT_EQ(4, peek().value()); } test/blockstore/implementations/caching/cache/QueueMapTest_Size.cpp000066400000000000000000000026611300002025200261200ustar00rootroot00000000000000#include "testutils/QueueMapTest.h" class QueueMapTest_Size: public QueueMapTest {}; TEST_F(QueueMapTest_Size, Empty) { EXPECT_EQ(0, size()); } TEST_F(QueueMapTest_Size, AfterPushingOne) { push(2, 3); EXPECT_EQ(1, size()); } TEST_F(QueueMapTest_Size, AfterPushingTwo) { push(2, 3); push(3, 4); EXPECT_EQ(2, size()); } TEST_F(QueueMapTest_Size, AfterPushingTwoAndPoppingOldest) { push(2, 3); push(3, 4); pop(); EXPECT_EQ(1, size()); } TEST_F(QueueMapTest_Size, AfterPushingTwoAndPoppingFirst) { push(2, 3); push(3, 4); pop(2); EXPECT_EQ(1, size()); } TEST_F(QueueMapTest_Size, AfterPushingTwoAndPoppingLast) { push(2, 3); push(3, 4); pop(3); EXPECT_EQ(1, size()); } TEST_F(QueueMapTest_Size, AfterPushingOnePoppingOne) { push(2, 3); pop(); EXPECT_EQ(0, size()); } TEST_F(QueueMapTest_Size, AfterPushingOnePoppingOnePerKey) { push(2, 3); pop(2); EXPECT_EQ(0, size()); } TEST_F(QueueMapTest_Size, AfterPushingOnePoppingOnePushingOne) { push(2, 3); pop(); push(3, 4); EXPECT_EQ(1, size()); } TEST_F(QueueMapTest_Size, AfterPushingOnePoppingOnePerKeyPushingOne) { push(2, 3); pop(2); push(3, 4); EXPECT_EQ(1, size()); } TEST_F(QueueMapTest_Size, AfterPushingOnePoppingOnePushingSame) { push(2, 3); pop(); push(2, 3); EXPECT_EQ(1, size()); } TEST_F(QueueMapTest_Size, AfterPushingOnePoppingOnePerKeyPushingSame) { push(2, 3); pop(2); push(2, 3); EXPECT_EQ(1, size()); } test/blockstore/implementations/caching/cache/QueueMapTest_Values.cpp000066400000000000000000000070361300002025200264460ustar00rootroot00000000000000#include "testutils/QueueMapTest.h" #include class QueueMapTest_Values: public QueueMapTest {}; TEST_F(QueueMapTest_Values, PoppingFromEmpty) { EXPECT_EQ(boost::none, pop()); } TEST_F(QueueMapTest_Values, PoppingFromEmptyPerKey) { EXPECT_EQ(boost::none, pop(2)); } TEST_F(QueueMapTest_Values, PoppingNonexistingPerKey) { push(3, 2); EXPECT_EQ(boost::none, pop(2)); } TEST_F(QueueMapTest_Values, PushingOne) { push(3, 2); EXPECT_EQ(2, pop(3).value()); EXPECT_EQ(boost::none, pop()); } TEST_F(QueueMapTest_Values, PushingTwo) { push(2, 3); push(3, 4); EXPECT_EQ(3, pop().value()); EXPECT_EQ(4, pop().value()); EXPECT_EQ(boost::none, pop()); } TEST_F(QueueMapTest_Values, AfterPushingTwoAndPoppingFirst) { push(2, 3); push(3, 4); pop(2); EXPECT_EQ(boost::none, pop(2)); EXPECT_EQ(4, pop(3).value()); EXPECT_EQ(boost::none, pop()); } TEST_F(QueueMapTest_Values, AfterPushingTwoAndPoppingLast) { push(2, 3); push(3, 4); pop(3); EXPECT_EQ(boost::none, pop(3)); EXPECT_EQ(3, pop(2).value()); EXPECT_EQ(boost::none, pop()); } TEST_F(QueueMapTest_Values, AfterPushingOnePoppingOne) { push(2, 3); pop(); EXPECT_EQ(boost::none, pop()); EXPECT_EQ(boost::none, pop(2)); } TEST_F(QueueMapTest_Values, AfterPushingOnePoppingOnePerKey) { push(2, 3); pop(2); EXPECT_EQ(boost::none, pop()); EXPECT_EQ(boost::none, pop(2)); } TEST_F(QueueMapTest_Values, AfterPushingOnePoppingOnePushingOne) { push(2, 3); pop(); push(3, 4); EXPECT_EQ(boost::none, pop(2)); EXPECT_EQ(4, pop(3).value()); EXPECT_EQ(boost::none, pop()); } TEST_F(QueueMapTest_Values, AfterPushingOnePoppingOnePerKeyPushingOne) { push(2, 3); pop(2); push(3, 4); EXPECT_EQ(boost::none, pop(2)); EXPECT_EQ(4, pop(3).value()); EXPECT_EQ(boost::none, pop()); } TEST_F(QueueMapTest_Values, PushingSomePoppingMiddlePerKey) { push(1, 2); push(2, 3); push(3, 4); push(4, 5); push(5, 6); EXPECT_EQ(3, pop(2).value()); EXPECT_EQ(5, pop(4).value()); EXPECT_EQ(2, pop().value()); EXPECT_EQ(4, pop().value()); EXPECT_EQ(6, pop().value()); EXPECT_EQ(boost::none, pop()); } TEST_F(QueueMapTest_Values, PushingSomePoppingFirstPerKey) { push(1, 2); push(2, 3); push(3, 4); push(4, 5); push(5, 6); EXPECT_EQ(2, pop(1).value()); EXPECT_EQ(3, pop(2).value()); EXPECT_EQ(4, pop().value()); EXPECT_EQ(5, pop().value()); EXPECT_EQ(6, pop().value()); EXPECT_EQ(boost::none, pop()); } TEST_F(QueueMapTest_Values, PushingSomePoppingLastPerKey) { push(1, 2); push(2, 3); push(3, 4); push(4, 5); push(5, 6); EXPECT_EQ(6, pop(5).value()); EXPECT_EQ(5, pop(4).value()); EXPECT_EQ(2, pop().value()); EXPECT_EQ(3, pop().value()); EXPECT_EQ(4, pop().value()); EXPECT_EQ(boost::none, pop()); } //This test forces the underlying datastructure (std::map or std::unordered_map) to grow and reallocate memory. //So it tests, that QueueMap still works after reallocating memory. TEST_F(QueueMapTest_Values, ManyValues) { //Push 1 million entries for (int i = 0; i < 1000000; ++i) { push(i, 2*i); } //pop every other one by key for (int i = 0; i < 1000000; i += 2) { EXPECT_EQ(2*i, pop(i).value()); } //pop the rest in queue order for (int i = 1; i < 1000000; i += 2) { EXPECT_EQ(2*i, peek().value()); EXPECT_EQ(2*i, pop().value()); } EXPECT_EQ(0, size()); EXPECT_EQ(boost::none, pop()); EXPECT_EQ(boost::none, peek()); } TEST_F(QueueMapTest_Values, PushAlreadyExistingValue) { push(2, 3); EXPECT_ANY_THROW( push(2, 4); ); } test/blockstore/implementations/caching/cache/testutils/000077500000000000000000000000001300002025200240735ustar00rootroot00000000000000test/blockstore/implementations/caching/cache/testutils/CacheTest.cpp000066400000000000000000000005451300002025200264460ustar00rootroot00000000000000#include "CacheTest.h" void CacheTest::push(int key, int value) { return _cache.push(MinimalKeyType::create(key), MinimalValueType::create(value)); } boost::optional CacheTest::pop(int key) { boost::optional entry = _cache.pop(MinimalKeyType::create(key)); if (!entry) { return boost::none; } return entry->value(); } test/blockstore/implementations/caching/cache/testutils/CacheTest.h000066400000000000000000000020021300002025200261010ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_TEST_IMPLEMENTATIONS_CACHING_CACHE_TESTUTILS_QUEUEMAPTEST_H_ #define MESSMER_BLOCKSTORE_TEST_IMPLEMENTATIONS_CACHING_CACHE_TESTUTILS_QUEUEMAPTEST_H_ #include #include "blockstore/implementations/caching/cache/Cache.h" #include "MinimalKeyType.h" #include "MinimalValueType.h" #include // This class is a parent class for tests on QueueMap. // It offers functions to work with a QueueMap test object which is built using types having only the minimal type requirements. // Furthermore, the class checks that there are no memory leaks left after destructing the QueueMap (by counting leftover instances of Keys/Values). class CacheTest: public ::testing::Test { public: CacheTest(): _cache() {} void push(int key, int value); boost::optional pop(int key); static constexpr unsigned int MAX_ENTRIES = 100; using Cache = blockstore::caching::Cache; private: Cache _cache; }; #endif test/blockstore/implementations/caching/cache/testutils/CopyableMovableValueType.cpp000066400000000000000000000001431300002025200315000ustar00rootroot00000000000000#include "CopyableMovableValueType.h" int CopyableMovableValueType::numCopyConstructorCalled = 0; test/blockstore/implementations/caching/cache/testutils/CopyableMovableValueType.h000066400000000000000000000020201300002025200311410ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_TEST_IMPLEMENTATIONS_CACHING_CACHE_TESTUTILS_COPYABLEMOVABLEVALUETYPE_H_ #define MESSMER_BLOCKSTORE_TEST_IMPLEMENTATIONS_CACHING_CACHE_TESTUTILS_COPYABLEMOVABLEVALUETYPE_H_ class CopyableMovableValueType { public: static int numCopyConstructorCalled; CopyableMovableValueType(int value): _value(value) {} CopyableMovableValueType(const CopyableMovableValueType &rhs): CopyableMovableValueType(rhs._value) { ++numCopyConstructorCalled; } CopyableMovableValueType &operator=(const CopyableMovableValueType &rhs) { _value = rhs._value; ++numCopyConstructorCalled; return *this; } CopyableMovableValueType(CopyableMovableValueType &&rhs): CopyableMovableValueType(rhs._value) { //Don't increase numCopyConstructorCalled } CopyableMovableValueType &operator=(CopyableMovableValueType &&rhs) { //Don't increase numCopyConstructorCalled _value = rhs._value; return *this; } int value() const { return _value; } private: int _value; }; #endif test/blockstore/implementations/caching/cache/testutils/MinimalKeyType.cpp000066400000000000000000000001001300002025200274670ustar00rootroot00000000000000#include "MinimalKeyType.h" int MinimalKeyType::instances = 0; test/blockstore/implementations/caching/cache/testutils/MinimalKeyType.h000066400000000000000000000016601300002025200271500ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_TEST_IMPLEMENTATIONS_CACHING_CACHE_TESTUTILS_MINIMALKEYTYPE_H_ #define MESSMER_BLOCKSTORE_TEST_IMPLEMENTATIONS_CACHING_CACHE_TESTUTILS_MINIMALKEYTYPE_H_ #include // This is a not-default-constructible Key type class MinimalKeyType { public: static int instances; static MinimalKeyType create(int value) { return MinimalKeyType(value); } MinimalKeyType(const MinimalKeyType &rhs): MinimalKeyType(rhs.value()) { } ~MinimalKeyType() { --instances; } int value() const { return _value; } private: MinimalKeyType(int value): _value(value) { ++instances; } int _value; }; namespace std { template <> struct hash { size_t operator()(const MinimalKeyType &obj) const { return obj.value(); } }; } inline bool operator==(const MinimalKeyType &lhs, const MinimalKeyType &rhs) { return lhs.value() == rhs.value(); } #endif test/blockstore/implementations/caching/cache/testutils/MinimalValueType.cpp000066400000000000000000000001041300002025200300170ustar00rootroot00000000000000#include "MinimalValueType.h" int MinimalValueType::instances = 0; test/blockstore/implementations/caching/cache/testutils/MinimalValueType.h000066400000000000000000000023301300002025200274670ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_TEST_IMPLEMENTATIONS_CACHING_CACHE_TESTUTILS_MINIMALVALUETYPE_H_ #define MESSMER_BLOCKSTORE_TEST_IMPLEMENTATIONS_CACHING_CACHE_TESTUTILS_MINIMALVALUETYPE_H_ #include #include #include // This is a not-default-constructible non-copyable but moveable Value type class MinimalValueType { public: static int instances; static MinimalValueType create(int value) { return MinimalValueType(value); } MinimalValueType(MinimalValueType &&rhs): MinimalValueType(rhs.value()) { rhs._isMoved = true; } MinimalValueType &operator=(MinimalValueType &&rhs) { _value = rhs.value(); _isMoved = false; rhs._isMoved = true; return *this; } ~MinimalValueType() { ASSERT(!_isDestructed, "Object was already destructed before"); --instances; _isDestructed = true; } int value() const { ASSERT(!_isMoved && !_isDestructed, "Object is invalid"); return _value; } private: MinimalValueType(int value): _value(value), _isMoved(false), _isDestructed(false) { ++instances; } int _value; bool _isMoved; bool _isDestructed; DISALLOW_COPY_AND_ASSIGN(MinimalValueType); }; #endif test/blockstore/implementations/caching/cache/testutils/QueueMapTest.cpp000066400000000000000000000020251300002025200271600ustar00rootroot00000000000000#include "QueueMapTest.h" QueueMapTest::QueueMapTest(): _map(cpputils::make_unique_ref>()) { MinimalKeyType::instances = 0; MinimalValueType::instances = 0; } QueueMapTest::~QueueMapTest() { cpputils::destruct(std::move(_map)); EXPECT_EQ(0, MinimalKeyType::instances); EXPECT_EQ(0, MinimalValueType::instances); } void QueueMapTest::push(int key, int value) { _map->push(MinimalKeyType::create(key), MinimalValueType::create(value)); } boost::optional QueueMapTest::pop() { auto elem = _map->pop(); if (!elem) { return boost::none; } return elem.value().value(); } boost::optional QueueMapTest::pop(int key) { auto elem = _map->pop(MinimalKeyType::create(key)); if (!elem) { return boost::none; } return elem.value().value(); } boost::optional QueueMapTest::peek() { auto elem = _map->peek(); if (!elem) { return boost::none; } return elem.value().value(); } int QueueMapTest::size() { return _map->size(); } test/blockstore/implementations/caching/cache/testutils/QueueMapTest.h000066400000000000000000000021061300002025200266250ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_TEST_IMPLEMENTATIONS_CACHING_CACHE_TESTUTILS_QUEUEMAPTEST_H_ #define MESSMER_BLOCKSTORE_TEST_IMPLEMENTATIONS_CACHING_CACHE_TESTUTILS_QUEUEMAPTEST_H_ #include #include #include "blockstore/implementations/caching/cache/QueueMap.h" #include "MinimalKeyType.h" #include "MinimalValueType.h" #include // This class is a parent class for tests on QueueMap. // It offers functions to work with a QueueMap test object which is built using types having only the minimal type requirements. // Furthermore, the class checks that there are no memory leaks left after destructing the QueueMap (by counting leftover instances of Keys/Values). class QueueMapTest: public ::testing::Test { public: QueueMapTest(); ~QueueMapTest(); void push(int key, int value); boost::optional pop(); boost::optional pop(int key); boost::optional peek(); int size(); private: cpputils::unique_ref> _map; }; #endif test/blockstore/implementations/compressing/000077500000000000000000000000001300002025200217255ustar00rootroot00000000000000test/blockstore/implementations/compressing/CompressingBlockStoreTest.cpp000066400000000000000000000022141300002025200275510ustar00rootroot00000000000000#include "blockstore/implementations/compressing/CompressingBlockStore.h" #include "blockstore/implementations/compressing/compressors/Gzip.h" #include "blockstore/implementations/compressing/compressors/RunLengthEncoding.h" #include "blockstore/implementations/testfake/FakeBlockStore.h" #include "../../testutils/BlockStoreTest.h" #include using ::testing::Test; using blockstore::BlockStore; using blockstore::compressing::CompressingBlockStore; using blockstore::compressing::Gzip; using blockstore::compressing::RunLengthEncoding; using blockstore::testfake::FakeBlockStore; using cpputils::make_unique_ref; using cpputils::unique_ref; template class CompressingBlockStoreTestFixture: public BlockStoreTestFixture { public: unique_ref createBlockStore() override { return make_unique_ref>(make_unique_ref()); } }; INSTANTIATE_TYPED_TEST_CASE_P(Compressing_Gzip, BlockStoreTest, CompressingBlockStoreTestFixture); INSTANTIATE_TYPED_TEST_CASE_P(Compressing_RunLengthEncoding, BlockStoreTest, CompressingBlockStoreTestFixture); test/blockstore/implementations/compressing/compressors/000077500000000000000000000000001300002025200243045ustar00rootroot00000000000000test/blockstore/implementations/compressing/compressors/testutils/000077500000000000000000000000001300002025200263445ustar00rootroot00000000000000test/blockstore/implementations/compressing/compressors/testutils/CompressorTest.cpp000066400000000000000000000064261300002025200320540ustar00rootroot00000000000000#include #include "blockstore/implementations/compressing/compressors/Gzip.h" #include "blockstore/implementations/compressing/compressors/RunLengthEncoding.h" #include using namespace blockstore::compressing; using cpputils::Data; using cpputils::DataFixture; template class CompressorTest: public ::testing::Test { public: void EXPECT_COMPRESS_AND_DECOMPRESS_IS_IDENTITY(const Data &data) { Data compressed = Compressor::Compress(data); Data decompressed = Compressor::Decompress(compressed.data(), compressed.size()); EXPECT_EQ(data, decompressed); } }; TYPED_TEST_CASE_P(CompressorTest); TYPED_TEST_P(CompressorTest, Empty) { Data empty(0); this->EXPECT_COMPRESS_AND_DECOMPRESS_IS_IDENTITY(empty); } TYPED_TEST_P(CompressorTest, ArbitraryData) { Data fixture = DataFixture::generate(10240); this->EXPECT_COMPRESS_AND_DECOMPRESS_IS_IDENTITY(fixture); } TYPED_TEST_P(CompressorTest, Zeroes) { Data zeroes(10240); zeroes.FillWithZeroes(); this->EXPECT_COMPRESS_AND_DECOMPRESS_IS_IDENTITY(zeroes); } TYPED_TEST_P(CompressorTest, Runs) { Data data(4096); std::memset(data.dataOffset(0), 0xF2, 1024); std::memset(data.dataOffset(1024), 0x00, 1024); std::memset(data.dataOffset(2048), 0x01, 2048); this->EXPECT_COMPRESS_AND_DECOMPRESS_IS_IDENTITY(data); } TYPED_TEST_P(CompressorTest, RunsAndArbitrary) { Data data(4096); std::memset(data.dataOffset(0), 0xF2, 1024); std::memcpy(data.dataOffset(1024), DataFixture::generate(1024).data(), 1024); std::memset(data.dataOffset(2048), 0x01, 2048); this->EXPECT_COMPRESS_AND_DECOMPRESS_IS_IDENTITY(data); } TYPED_TEST_P(CompressorTest, LargeData) { // this is larger than what fits into 16bit (16bit are for example used as run length indicator in RunLengthEncoding) Data fixture = DataFixture::generate(200000); this->EXPECT_COMPRESS_AND_DECOMPRESS_IS_IDENTITY(fixture); } TYPED_TEST_P(CompressorTest, LargeRuns) { // each run is larger than what fits into 16bit (16bit are for example used as run length indicator in RunLengthEncoding) constexpr size_t RUN_SIZE = 200000; Data data(3*RUN_SIZE); std::memset(data.dataOffset(0), 0xF2, RUN_SIZE); std::memset(data.dataOffset(RUN_SIZE), 0x00, RUN_SIZE); std::memset(data.dataOffset(2*RUN_SIZE), 0x01, RUN_SIZE); this->EXPECT_COMPRESS_AND_DECOMPRESS_IS_IDENTITY(data); } TYPED_TEST_P(CompressorTest, LargeRunsAndArbitrary) { // each run is larger than what fits into 16bit (16bit are for example used as run length indicator in RunLengthEncoding) constexpr size_t RUN_SIZE = 200000; Data data(3*RUN_SIZE); std::memset(data.dataOffset(0), 0xF2, RUN_SIZE); std::memcpy(data.dataOffset(RUN_SIZE), DataFixture::generate(RUN_SIZE).data(), RUN_SIZE); std::memset(data.dataOffset(2*RUN_SIZE), 0x01, RUN_SIZE); this->EXPECT_COMPRESS_AND_DECOMPRESS_IS_IDENTITY(data); } REGISTER_TYPED_TEST_CASE_P(CompressorTest, Empty, ArbitraryData, Zeroes, Runs, RunsAndArbitrary, LargeData, LargeRuns, LargeRunsAndArbitrary ); INSTANTIATE_TYPED_TEST_CASE_P(Gzip, CompressorTest, Gzip); INSTANTIATE_TYPED_TEST_CASE_P(RunLengthEncoding, CompressorTest, RunLengthEncoding); test/blockstore/implementations/encrypted/000077500000000000000000000000001300002025200213715ustar00rootroot00000000000000test/blockstore/implementations/encrypted/EncryptedBlockStoreTest_Generic.cpp000066400000000000000000000033011300002025200303130ustar00rootroot00000000000000#include #include #include "blockstore/implementations/encrypted/EncryptedBlockStore.h" #include "blockstore/implementations/testfake/FakeBlockStore.h" #include "../../testutils/BlockStoreTest.h" //TODO Move FakeAuthenticatedCipher out of test folder to normal folder. Dependencies should not point into tests of other modules. #include "../../../cpp-utils/crypto/symmetric/testutils/FakeAuthenticatedCipher.h" #include using ::testing::Test; using blockstore::BlockStore; using blockstore::encrypted::EncryptedBlockStore; using blockstore::testfake::FakeBlockStore; using cpputils::AES256_GCM; using cpputils::AES256_CFB; using cpputils::FakeAuthenticatedCipher; using cpputils::Data; using cpputils::DataFixture; using cpputils::make_unique_ref; using cpputils::unique_ref; template class EncryptedBlockStoreTestFixture: public BlockStoreTestFixture { public: unique_ref createBlockStore() override { return make_unique_ref>(make_unique_ref(), createKeyFixture()); } private: static typename Cipher::EncryptionKey createKeyFixture(int seed = 0) { Data data = DataFixture::generate(Cipher::EncryptionKey::BINARY_LENGTH, seed); return Cipher::EncryptionKey::FromBinary(data.data()); } }; INSTANTIATE_TYPED_TEST_CASE_P(Encrypted_FakeCipher, BlockStoreTest, EncryptedBlockStoreTestFixture); INSTANTIATE_TYPED_TEST_CASE_P(Encrypted_AES256_GCM, BlockStoreTest, EncryptedBlockStoreTestFixture); INSTANTIATE_TYPED_TEST_CASE_P(Encrypted_AES256_CFB, BlockStoreTest, EncryptedBlockStoreTestFixture); test/blockstore/implementations/encrypted/EncryptedBlockStoreTest_Specific.cpp000066400000000000000000000127401300002025200304730ustar00rootroot00000000000000#include #include "../../../cpp-utils/crypto/symmetric/testutils/FakeAuthenticatedCipher.h" #include "blockstore/implementations/encrypted/EncryptedBlockStore.h" #include "blockstore/implementations/testfake/FakeBlockStore.h" #include "blockstore/utils/BlockStoreUtils.h" #include using ::testing::Test; using cpputils::DataFixture; using cpputils::Data; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::FakeAuthenticatedCipher; using blockstore::testfake::FakeBlockStore; using namespace blockstore::encrypted; class EncryptedBlockStoreTest: public Test { public: static constexpr unsigned int BLOCKSIZE = 1024; EncryptedBlockStoreTest(): baseBlockStore(new FakeBlockStore), blockStore(make_unique_ref>(std::move(cpputils::nullcheck(std::unique_ptr(baseBlockStore)).value()), FakeAuthenticatedCipher::Key1())), data(DataFixture::generate(BLOCKSIZE)) { } FakeBlockStore *baseBlockStore; unique_ref> blockStore; Data data; blockstore::Key CreateBlockDirectlyWithFixtureAndReturnKey() { return CreateBlockReturnKey(data); } blockstore::Key CreateBlockReturnKey(const Data &initData) { return blockStore->create(initData)->key(); } blockstore::Key CreateBlockWriteFixtureToItAndReturnKey() { auto block = blockStore->create(Data(data.size())); block->write(data.data(), 0, data.size()); return block->key(); } void ModifyBaseBlock(const blockstore::Key &key) { auto block = baseBlockStore->load(key).value(); uint8_t middle_byte = ((byte*)block->data())[10]; uint8_t new_middle_byte = middle_byte + 1; block->write(&new_middle_byte, 10, 1); } blockstore::Key CopyBaseBlock(const blockstore::Key &key) { auto source = baseBlockStore->load(key).value(); return blockstore::utils::copyToNewBlock(baseBlockStore, *source)->key(); } private: DISALLOW_COPY_AND_ASSIGN(EncryptedBlockStoreTest); }; TEST_F(EncryptedBlockStoreTest, LoadingWithSameKeyWorks_WriteOnCreate) { auto key = CreateBlockDirectlyWithFixtureAndReturnKey(); auto loaded = blockStore->load(key); EXPECT_NE(boost::none, loaded); EXPECT_EQ(data.size(), (*loaded)->size()); EXPECT_EQ(0, std::memcmp(data.data(), (*loaded)->data(), data.size())); } TEST_F(EncryptedBlockStoreTest, LoadingWithSameKeyWorks_WriteSeparately) { auto key = CreateBlockWriteFixtureToItAndReturnKey(); auto loaded = blockStore->load(key); EXPECT_NE(boost::none, loaded); EXPECT_EQ(data.size(), (*loaded)->size()); EXPECT_EQ(0, std::memcmp(data.data(), (*loaded)->data(), data.size())); } TEST_F(EncryptedBlockStoreTest, LoadingWithDifferentKeyDoesntWork_WriteOnCreate) { auto key = CreateBlockDirectlyWithFixtureAndReturnKey(); blockStore->__setKey(FakeAuthenticatedCipher::Key2()); auto loaded = blockStore->load(key); EXPECT_EQ(boost::none, loaded); } TEST_F(EncryptedBlockStoreTest, LoadingWithDifferentKeyDoesntWork_WriteSeparately) { auto key = CreateBlockWriteFixtureToItAndReturnKey(); blockStore->__setKey(FakeAuthenticatedCipher::Key2()); auto loaded = blockStore->load(key); EXPECT_EQ(boost::none, loaded); } TEST_F(EncryptedBlockStoreTest, LoadingModifiedBlockFails_WriteOnCreate) { auto key = CreateBlockDirectlyWithFixtureAndReturnKey(); ModifyBaseBlock(key); auto loaded = blockStore->load(key); EXPECT_EQ(boost::none, loaded); } TEST_F(EncryptedBlockStoreTest, LoadingModifiedBlockFails_WriteSeparately) { auto key = CreateBlockWriteFixtureToItAndReturnKey(); ModifyBaseBlock(key); auto loaded = blockStore->load(key); EXPECT_EQ(boost::none, loaded); } TEST_F(EncryptedBlockStoreTest, LoadingWithDifferentBlockIdFails_WriteOnCreate) { auto key = CreateBlockDirectlyWithFixtureAndReturnKey(); auto key2 = CopyBaseBlock(key); auto loaded = blockStore->load(key2); EXPECT_EQ(boost::none, loaded); } TEST_F(EncryptedBlockStoreTest, LoadingWithDifferentBlockIdFails_WriteSeparately) { auto key = CreateBlockWriteFixtureToItAndReturnKey(); auto key2 = CopyBaseBlock(key); auto loaded = blockStore->load(key2); EXPECT_EQ(boost::none, loaded); } TEST_F(EncryptedBlockStoreTest, PhysicalBlockSize_zerophysical) { EXPECT_EQ(0u, blockStore->blockSizeFromPhysicalBlockSize(0)); } TEST_F(EncryptedBlockStoreTest, PhysicalBlockSize_zerovirtual) { auto key = CreateBlockReturnKey(Data(0)); auto base = baseBlockStore->load(key).value(); EXPECT_EQ(0u, blockStore->blockSizeFromPhysicalBlockSize(base->size())); } TEST_F(EncryptedBlockStoreTest, PhysicalBlockSize_negativeboundaries) { // This tests that a potential if/else in blockSizeFromPhysicalBlockSize that catches negative values has the // correct boundary set. We test the highest value that is negative and the smallest value that is positive. auto physicalSizeForVirtualSizeZero = baseBlockStore->load(CreateBlockReturnKey(Data(0))).value()->size(); if (physicalSizeForVirtualSizeZero > 0) { EXPECT_EQ(0u, blockStore->blockSizeFromPhysicalBlockSize(physicalSizeForVirtualSizeZero - 1)); } EXPECT_EQ(0u, blockStore->blockSizeFromPhysicalBlockSize(physicalSizeForVirtualSizeZero)); EXPECT_EQ(1u, blockStore->blockSizeFromPhysicalBlockSize(physicalSizeForVirtualSizeZero + 1)); } TEST_F(EncryptedBlockStoreTest, PhysicalBlockSize_positive) { auto key = CreateBlockReturnKey(Data(10*1024)); auto base = baseBlockStore->load(key).value(); EXPECT_EQ(10*1024u, blockStore->blockSizeFromPhysicalBlockSize(base->size())); } test/blockstore/implementations/inmemory/000077500000000000000000000000001300002025200212335ustar00rootroot00000000000000test/blockstore/implementations/inmemory/InMemoryBlockStoreTest.cpp000066400000000000000000000021671300002025200263340ustar00rootroot00000000000000#include "blockstore/implementations/inmemory/InMemoryBlock.h" #include "blockstore/implementations/inmemory/InMemoryBlockStore.h" #include "../../testutils/BlockStoreTest.h" #include "../../testutils/BlockStoreWithRandomKeysTest.h" #include #include using blockstore::BlockStore; using blockstore::BlockStoreWithRandomKeys; using blockstore::inmemory::InMemoryBlockStore; using cpputils::unique_ref; using cpputils::make_unique_ref; class InMemoryBlockStoreTestFixture: public BlockStoreTestFixture { public: unique_ref createBlockStore() override { return make_unique_ref(); } }; INSTANTIATE_TYPED_TEST_CASE_P(InMemory, BlockStoreTest, InMemoryBlockStoreTestFixture); class InMemoryBlockStoreWithRandomKeysTestFixture: public BlockStoreWithRandomKeysTestFixture { public: unique_ref createBlockStore() override { return make_unique_ref(); } }; INSTANTIATE_TYPED_TEST_CASE_P(InMemory, BlockStoreWithRandomKeysTest, InMemoryBlockStoreWithRandomKeysTestFixture); test/blockstore/implementations/ondisk/000077500000000000000000000000001300002025200206635ustar00rootroot00000000000000test/blockstore/implementations/ondisk/OnDiskBlockStoreTest_Generic.cpp000066400000000000000000000024261300002025200270460ustar00rootroot00000000000000#include "blockstore/implementations/ondisk/OnDiskBlock.h" #include "blockstore/implementations/ondisk/OnDiskBlockStore.h" #include "../../testutils/BlockStoreTest.h" #include "../../testutils/BlockStoreWithRandomKeysTest.h" #include #include using blockstore::BlockStore; using blockstore::BlockStoreWithRandomKeys; using blockstore::ondisk::OnDiskBlockStore; using cpputils::TempDir; using cpputils::unique_ref; using cpputils::make_unique_ref; class OnDiskBlockStoreTestFixture: public BlockStoreTestFixture { public: OnDiskBlockStoreTestFixture(): tempdir() {} unique_ref createBlockStore() override { return make_unique_ref(tempdir.path()); } private: TempDir tempdir; }; INSTANTIATE_TYPED_TEST_CASE_P(OnDisk, BlockStoreTest, OnDiskBlockStoreTestFixture); class OnDiskBlockStoreWithRandomKeysTestFixture: public BlockStoreWithRandomKeysTestFixture { public: OnDiskBlockStoreWithRandomKeysTestFixture(): tempdir() {} unique_ref createBlockStore() override { return make_unique_ref(tempdir.path()); } private: TempDir tempdir; }; INSTANTIATE_TYPED_TEST_CASE_P(OnDisk, BlockStoreWithRandomKeysTest, OnDiskBlockStoreWithRandomKeysTestFixture); test/blockstore/implementations/ondisk/OnDiskBlockStoreTest_Specific.cpp000066400000000000000000000047411300002025200272210ustar00rootroot00000000000000#include #include "blockstore/implementations/ondisk/OnDiskBlockStore.h" #include using ::testing::Test; using cpputils::TempDir; using cpputils::Data; using std::ifstream; using blockstore::Key; using namespace blockstore::ondisk; class OnDiskBlockStoreTest: public Test { public: OnDiskBlockStoreTest(): baseDir(), blockStore(baseDir.path()) { } TempDir baseDir; OnDiskBlockStore blockStore; blockstore::Key CreateBlockReturnKey(const Data &initData) { return blockStore.create(initData)->key(); } uint64_t getPhysicalBlockSize(const Key &key) { ifstream stream((baseDir.path() / key.ToString().substr(0,3) / key.ToString().substr(3)).c_str()); stream.seekg(0, stream.end); return stream.tellg(); } }; TEST_F(OnDiskBlockStoreTest, PhysicalBlockSize_zerophysical) { EXPECT_EQ(0u, blockStore.blockSizeFromPhysicalBlockSize(0)); } TEST_F(OnDiskBlockStoreTest, PhysicalBlockSize_zerovirtual) { auto key = CreateBlockReturnKey(Data(0)); auto baseSize = getPhysicalBlockSize(key); EXPECT_EQ(0u, blockStore.blockSizeFromPhysicalBlockSize(baseSize)); } TEST_F(OnDiskBlockStoreTest, PhysicalBlockSize_negativeboundaries) { // This tests that a potential if/else in blockSizeFromPhysicalBlockSize that catches negative values has the // correct boundary set. We test the highest value that is negative and the smallest value that is positive. auto physicalSizeForVirtualSizeZero = getPhysicalBlockSize(CreateBlockReturnKey(Data(0))); if (physicalSizeForVirtualSizeZero > 0) { EXPECT_EQ(0u, blockStore.blockSizeFromPhysicalBlockSize(physicalSizeForVirtualSizeZero - 1)); } EXPECT_EQ(0u, blockStore.blockSizeFromPhysicalBlockSize(physicalSizeForVirtualSizeZero)); EXPECT_EQ(1u, blockStore.blockSizeFromPhysicalBlockSize(physicalSizeForVirtualSizeZero + 1)); } TEST_F(OnDiskBlockStoreTest, PhysicalBlockSize_positive) { auto key = CreateBlockReturnKey(Data(10*1024)); auto baseSize = getPhysicalBlockSize(key); EXPECT_EQ(10*1024u, blockStore.blockSizeFromPhysicalBlockSize(baseSize)); } TEST_F(OnDiskBlockStoreTest, NumBlocksIsCorrectAfterAddingTwoBlocksWithSameKeyPrefix) { const Key key1 = Key::FromString("4CE72ECDD20877A12ADBF4E3927C0A13"); const Key key2 = Key::FromString("4CE72ECDD20877A12ADBF4E3927C0A14"); EXPECT_NE(boost::none, blockStore.tryCreate(key1, cpputils::Data(0))); EXPECT_NE(boost::none, blockStore.tryCreate(key2, cpputils::Data(0))); EXPECT_EQ(2u, blockStore.numBlocks()); } test/blockstore/implementations/ondisk/OnDiskBlockTest/000077500000000000000000000000001300002025200236655ustar00rootroot00000000000000test/blockstore/implementations/ondisk/OnDiskBlockTest/OnDiskBlockCreateTest.cpp000066400000000000000000000057351300002025200305310ustar00rootroot00000000000000#include "blockstore/implementations/ondisk/OnDiskBlock.h" #include #include #include using ::testing::Test; using ::testing::WithParamInterface; using ::testing::Values; using cpputils::Data; using cpputils::TempFile; using cpputils::TempDir; using cpputils::unique_ref; using namespace blockstore; using namespace blockstore::ondisk; namespace bf = boost::filesystem; class OnDiskBlockCreateTest: public Test { public: OnDiskBlockCreateTest() // Don't create the temp file yet (therefore pass false to the TempFile constructor) : dir(), key(Key::FromString("1491BB4932A389EE14BC7090AC772972")), file(dir.path() / key.ToString().substr(0,3) / key.ToString().substr(3), false) { } TempDir dir; Key key; TempFile file; }; TEST_F(OnDiskBlockCreateTest, CreatingBlockCreatesFile) { EXPECT_FALSE(bf::exists(file.path())); auto block = OnDiskBlock::CreateOnDisk(dir.path(), key, Data(0)); EXPECT_TRUE(bf::exists(file.path())); EXPECT_TRUE(bf::is_regular_file(file.path())); } TEST_F(OnDiskBlockCreateTest, CreatingExistingBlockReturnsNull) { auto block1 = OnDiskBlock::CreateOnDisk(dir.path(), key, Data(0)); auto block2 = OnDiskBlock::CreateOnDisk(dir.path(), key, Data(0)); EXPECT_TRUE((bool)block1); EXPECT_FALSE((bool)block2); } class OnDiskBlockCreateSizeTest: public OnDiskBlockCreateTest, public WithParamInterface { public: unique_ref block; Data ZEROES; OnDiskBlockCreateSizeTest(): block(OnDiskBlock::CreateOnDisk(dir.path(), key, std::move(Data(GetParam()).FillWithZeroes())).value()), ZEROES(block->size()) { ZEROES.FillWithZeroes(); } }; INSTANTIATE_TEST_CASE_P(OnDiskBlockCreateSizeTest, OnDiskBlockCreateSizeTest, Values(0, 1, 5, 1024, 10*1024*1024)); TEST_P(OnDiskBlockCreateSizeTest, OnDiskSizeIsCorrect) { Data fileContent = Data::LoadFromFile(file.path()).value(); EXPECT_EQ(GetParam() + OnDiskBlock::formatVersionHeaderSize(), fileContent.size()); } TEST_P(OnDiskBlockCreateSizeTest, OnDiskBlockIsZeroedOut) { Data fileContent = Data::LoadFromFile(file.path()).value(); Data fileContentWithoutHeader(fileContent.size() - OnDiskBlock::formatVersionHeaderSize()); std::memcpy(fileContentWithoutHeader.data(), fileContent.dataOffset(OnDiskBlock::formatVersionHeaderSize()), fileContentWithoutHeader.size()); EXPECT_EQ(ZEROES, fileContentWithoutHeader); } // This test is also tested by OnDiskBlockStoreTest, but there the block is created using the BlockStore interface. // Here, we create it using OnDiskBlock::CreateOnDisk() TEST_P(OnDiskBlockCreateSizeTest, InMemorySizeIsCorrect) { EXPECT_EQ(GetParam(), block->size()); } // This test is also tested by OnDiskBlockStoreTest, but there the block is created using the BlockStore interface. // Here, we create it using OnDiskBlock::CreateOnDisk() TEST_P(OnDiskBlockCreateSizeTest, InMemoryBlockIsZeroedOut) { EXPECT_EQ(0, std::memcmp(ZEROES.data(), block->data(), block->size())); } test/blockstore/implementations/ondisk/OnDiskBlockTest/OnDiskBlockFlushTest.cpp000066400000000000000000000076331300002025200304060ustar00rootroot00000000000000#include "blockstore/implementations/ondisk/OnDiskBlock.h" #include #include #include #include using ::testing::Test; using ::testing::WithParamInterface; using ::testing::Values; using cpputils::Data; using cpputils::DataFixture; using cpputils::TempFile; using cpputils::TempDir; using cpputils::unique_ref; using namespace blockstore; using namespace blockstore::ondisk; namespace bf = boost::filesystem; class OnDiskBlockFlushTest: public Test, public WithParamInterface { public: OnDiskBlockFlushTest() // Don't create the temp file yet (therefore pass false to the TempFile constructor) : dir(), key(Key::FromString("1491BB4932A389EE14BC7090AC772972")), file(dir.path() / key.ToString().substr(0,3) / key.ToString().substr(3), false), randomData(DataFixture::generate(GetParam())) { } TempDir dir; Key key; TempFile file; Data randomData; unique_ref CreateBlockAndLoadItFromDisk() { { OnDiskBlock::CreateOnDisk(dir.path(), key, randomData.copy()).value(); } return OnDiskBlock::LoadFromDisk(dir.path(), key).value(); } unique_ref CreateBlock() { return OnDiskBlock::CreateOnDisk(dir.path(), key, randomData.copy()).value(); } void WriteDataToBlock(const unique_ref &block) { block->write(randomData.data(), 0, randomData.size()); } void EXPECT_BLOCK_DATA_CORRECT(const unique_ref &block) { EXPECT_EQ(randomData.size(), block->size()); EXPECT_EQ(0, std::memcmp(randomData.data(), block->data(), randomData.size())); } void EXPECT_STORED_FILE_DATA_CORRECT() { Data fileContent = Data::LoadFromFile(file.path()).value(); Data fileContentWithoutHeader(fileContent.size() - OnDiskBlock::formatVersionHeaderSize()); std::memcpy(fileContentWithoutHeader.data(), fileContent.dataOffset(OnDiskBlock::formatVersionHeaderSize()), fileContentWithoutHeader.size()); EXPECT_EQ(randomData, fileContentWithoutHeader); } }; INSTANTIATE_TEST_CASE_P(OnDiskBlockFlushTest, OnDiskBlockFlushTest, Values((size_t)0, (size_t)1, (size_t)1024, (size_t)4096, (size_t)10*1024*1024)); // This test is also tested by OnDiskBlockStoreTest, but there the block is created using the BlockStore interface. // Here, we create it using OnDiskBlock::CreateOnDisk() TEST_P(OnDiskBlockFlushTest, AfterCreate_FlushingDoesntChangeBlock) { auto block = CreateBlock(); WriteDataToBlock(block); EXPECT_BLOCK_DATA_CORRECT(block); } // This test is also tested by OnDiskBlockStoreTest, but there the block is created using the BlockStore interface. // Here, we create it using OnDiskBlock::CreateOnDisk() / OnDiskBlock::LoadFromDisk() TEST_P(OnDiskBlockFlushTest, AfterLoad_FlushingDoesntChangeBlock) { auto block = CreateBlockAndLoadItFromDisk(); WriteDataToBlock(block); EXPECT_BLOCK_DATA_CORRECT(block); } TEST_P(OnDiskBlockFlushTest, AfterCreate_FlushingWritesCorrectData) { auto block = CreateBlock(); WriteDataToBlock(block); EXPECT_STORED_FILE_DATA_CORRECT(); } TEST_P(OnDiskBlockFlushTest, AfterLoad_FlushingWritesCorrectData) { auto block = CreateBlockAndLoadItFromDisk(); WriteDataToBlock(block); EXPECT_STORED_FILE_DATA_CORRECT(); } // This test is also tested by OnDiskBlockStoreTest, but there it can only checks block content by loading it again. // Here, we check the content on disk. TEST_P(OnDiskBlockFlushTest, AfterCreate_FlushesWhenDestructed) { { auto block = CreateBlock(); WriteDataToBlock(block); } EXPECT_STORED_FILE_DATA_CORRECT(); } // This test is also tested by OnDiskBlockStoreTest, but there it can only checks block content by loading it again. // Here, we check the content on disk. TEST_P(OnDiskBlockFlushTest, AfterLoad_FlushesWhenDestructed) { { auto block = CreateBlockAndLoadItFromDisk(); WriteDataToBlock(block); } EXPECT_STORED_FILE_DATA_CORRECT(); } test/blockstore/implementations/ondisk/OnDiskBlockTest/OnDiskBlockLoadTest.cpp000066400000000000000000000043001300002025200301700ustar00rootroot00000000000000#include "blockstore/implementations/ondisk/OnDiskBlock.h" #include #include "blockstore/utils/FileDoesntExistException.h" #include #include #include #include #include #include using ::testing::Test; using ::testing::WithParamInterface; using ::testing::Values; using std::ofstream; using std::ios; using cpputils::Data; using cpputils::DataFixture; using cpputils::TempFile; using cpputils::TempDir; using cpputils::unique_ref; using namespace blockstore; using namespace blockstore::ondisk; namespace bf = boost::filesystem; class OnDiskBlockLoadTest: public Test, public WithParamInterface { public: OnDiskBlockLoadTest(): dir(), key(Key::FromString("1491BB4932A389EE14BC7090AC772972")), file(dir.path() / key.ToString(), false) { } TempDir dir; Key key; TempFile file; void CreateBlockWithSize(size_t size) { Data data(size); OnDiskBlock::CreateOnDisk(dir.path(), key, std::move(data)); } void StoreData(Data data) { OnDiskBlock::CreateOnDisk(dir.path(), key, std::move(data)); } unique_ref LoadBlock() { return OnDiskBlock::LoadFromDisk(dir.path(), key).value(); } void EXPECT_BLOCK_DATA_EQ(const Data &expected, const OnDiskBlock &actual) { EXPECT_EQ(expected.size(), actual.size()); EXPECT_EQ(0, std::memcmp(expected.data(), actual.data(), expected.size())); } }; INSTANTIATE_TEST_CASE_P(OnDiskBlockLoadTest, OnDiskBlockLoadTest, Values(0, 1, 5, 1024, 10*1024*1024)); TEST_P(OnDiskBlockLoadTest, LoadsCorrectSize) { CreateBlockWithSize(GetParam()); auto block = LoadBlock(); EXPECT_EQ(GetParam(), block->size()); } TEST_P(OnDiskBlockLoadTest, LoadedDataIsCorrect) { Data randomData = DataFixture::generate(GetParam()); StoreData(randomData.copy()); auto block = LoadBlock(); EXPECT_BLOCK_DATA_EQ(randomData, *block); } TEST_F(OnDiskBlockLoadTest, LoadNotExistingBlock) { Key key2 = Key::FromString("272EE5517627CFA147A971A8E6E747E0"); EXPECT_EQ(boost::none, OnDiskBlock::LoadFromDisk(dir.path(), key2)); } test/blockstore/implementations/parallelaccess/000077500000000000000000000000001300002025200223525ustar00rootroot00000000000000test/blockstore/implementations/parallelaccess/ParallelAccessBlockStoreTest_Generic.cpp000066400000000000000000000015451300002025200322250ustar00rootroot00000000000000#include "blockstore/implementations/parallelaccess/ParallelAccessBlockStore.h" #include "blockstore/implementations/testfake/FakeBlockStore.h" #include "../../testutils/BlockStoreTest.h" #include using blockstore::BlockStore; using blockstore::parallelaccess::ParallelAccessBlockStore; using blockstore::testfake::FakeBlockStore; using cpputils::make_unique_ref; using cpputils::unique_ref; class ParallelAccessBlockStoreTestFixture: public BlockStoreTestFixture { public: unique_ref createBlockStore() override { return make_unique_ref(make_unique_ref()); } }; INSTANTIATE_TYPED_TEST_CASE_P(ParallelAccess, BlockStoreTest, ParallelAccessBlockStoreTestFixture); //TODO Add specific tests ensuring that loading the same block twice doesn't load it twice from the underlying blockstore test/blockstore/implementations/parallelaccess/ParallelAccessBlockStoreTest_Specific.cpp000066400000000000000000000042761300002025200324020ustar00rootroot00000000000000#include #include "blockstore/implementations/parallelaccess/ParallelAccessBlockStore.h" #include "blockstore/implementations/testfake/FakeBlockStore.h" using ::testing::Test; using cpputils::Data; using cpputils::unique_ref; using cpputils::make_unique_ref; using blockstore::testfake::FakeBlockStore; using namespace blockstore::parallelaccess; class ParallelAccessBlockStoreTest: public Test { public: ParallelAccessBlockStoreTest(): baseBlockStore(new FakeBlockStore), blockStore(std::move(cpputils::nullcheck(std::unique_ptr(baseBlockStore)).value())) { } FakeBlockStore *baseBlockStore; ParallelAccessBlockStore blockStore; blockstore::Key CreateBlockReturnKey(const Data &initData) { return blockStore.create(initData)->key(); } }; TEST_F(ParallelAccessBlockStoreTest, PhysicalBlockSize_zerophysical) { EXPECT_EQ(0u, blockStore.blockSizeFromPhysicalBlockSize(0)); } TEST_F(ParallelAccessBlockStoreTest, PhysicalBlockSize_zerovirtual) { auto key = CreateBlockReturnKey(Data(0)); auto base = baseBlockStore->load(key).value(); EXPECT_EQ(0u, blockStore.blockSizeFromPhysicalBlockSize(base->size())); } TEST_F(ParallelAccessBlockStoreTest, PhysicalBlockSize_negativeboundaries) { // This tests that a potential if/else in blockSizeFromPhysicalBlockSize that catches negative values has the // correct boundary set. We test the highest value that is negative and the smallest value that is positive. auto physicalSizeForVirtualSizeZero = baseBlockStore->load(CreateBlockReturnKey(Data(0))).value()->size(); if (physicalSizeForVirtualSizeZero > 0) { EXPECT_EQ(0u, blockStore.blockSizeFromPhysicalBlockSize(physicalSizeForVirtualSizeZero - 1)); } EXPECT_EQ(0u, blockStore.blockSizeFromPhysicalBlockSize(physicalSizeForVirtualSizeZero)); EXPECT_EQ(1u, blockStore.blockSizeFromPhysicalBlockSize(physicalSizeForVirtualSizeZero + 1)); } TEST_F(ParallelAccessBlockStoreTest, PhysicalBlockSize_positive) { auto key = CreateBlockReturnKey(Data(10*1024)); auto base = baseBlockStore->load(key).value(); EXPECT_EQ(10*1024u, blockStore.blockSizeFromPhysicalBlockSize(base->size())); } test/blockstore/implementations/testfake/000077500000000000000000000000001300002025200212025ustar00rootroot00000000000000test/blockstore/implementations/testfake/TestFakeBlockStoreTest.cpp000066400000000000000000000021221300002025200262410ustar00rootroot00000000000000#include "blockstore/implementations/testfake/FakeBlock.h" #include "blockstore/implementations/testfake/FakeBlockStore.h" #include "../../testutils/BlockStoreTest.h" #include "../../testutils/BlockStoreWithRandomKeysTest.h" #include #include using blockstore::BlockStore; using blockstore::BlockStoreWithRandomKeys; using blockstore::testfake::FakeBlockStore; using cpputils::unique_ref; using cpputils::make_unique_ref; class FakeBlockStoreTestFixture: public BlockStoreTestFixture { public: unique_ref createBlockStore() override { return make_unique_ref(); } }; INSTANTIATE_TYPED_TEST_CASE_P(TestFake, BlockStoreTest, FakeBlockStoreTestFixture); class FakeBlockStoreWithRandomKeysTestFixture: public BlockStoreWithRandomKeysTestFixture { public: unique_ref createBlockStore() override { return make_unique_ref(); } }; INSTANTIATE_TYPED_TEST_CASE_P(TestFake, BlockStoreWithRandomKeysTest, FakeBlockStoreWithRandomKeysTestFixture); test/blockstore/interface/000077500000000000000000000000001300002025200161245ustar00rootroot00000000000000test/blockstore/interface/BlockStoreTest.cpp000066400000000000000000000002311300002025200215330ustar00rootroot00000000000000/* * Tests that the header can be included without needing additional header includes as dependencies. */ #include "blockstore/interface/BlockStore.h" test/blockstore/interface/BlockTest.cpp000066400000000000000000000002241300002025200205200ustar00rootroot00000000000000/* * Tests that the header can be included without needing additional header includes as dependencies. */ #include "blockstore/interface/Block.h" test/blockstore/interface/helpers/000077500000000000000000000000001300002025200175665ustar00rootroot00000000000000test/blockstore/interface/helpers/BlockStoreWithRandomKeysTest.cpp000066400000000000000000000114041300002025200260320ustar00rootroot00000000000000#include "blockstore/interface/helpers/BlockStoreWithRandomKeys.h" #include #include #include using ::testing::Test; using ::testing::_; using ::testing::Return; using ::testing::Invoke; using ::testing::Eq; using ::testing::ByRef; using std::string; using cpputils::Data; using cpputils::DataFixture; using cpputils::unique_ref; using boost::optional; using namespace blockstore; class BlockStoreWithRandomKeysMock: public BlockStoreWithRandomKeys { public: optional> tryCreate(const Key &key, Data data) { return cpputils::nullcheck(std::unique_ptr(do_create(key, data))); } MOCK_METHOD2(do_create, Block*(const Key &, const Data &data)); optional> load(const Key &key) { return cpputils::nullcheck(std::unique_ptr(do_load(key))); } MOCK_METHOD1(do_load, Block*(const Key &)); void remove(unique_ref block) {UNUSED(block);} MOCK_CONST_METHOD0(numBlocks, uint64_t()); MOCK_CONST_METHOD0(estimateNumFreeBytes, uint64_t()); MOCK_CONST_METHOD1(blockSizeFromPhysicalBlockSize, uint64_t(uint64_t)); }; class BlockMock: public Block { public: BlockMock(): Block(cpputils::Random::PseudoRandom().getFixedSize()) {} MOCK_CONST_METHOD0(data, const void*()); MOCK_METHOD3(write, void(const void*, uint64_t, uint64_t)); MOCK_METHOD0(flush, void()); MOCK_CONST_METHOD0(size, size_t()); MOCK_METHOD1(resize, void(size_t)); MOCK_CONST_METHOD0(key, const Key&()); }; class BlockStoreWithRandomKeysTest: public Test { public: BlockStoreWithRandomKeysTest() :blockStoreMock(), blockStore(blockStoreMock), key(Key::FromString("1491BB4932A389EE14BC7090AC772972")) {} BlockStoreWithRandomKeysMock blockStoreMock; BlockStore &blockStore; const blockstore::Key key; Data createDataWithSize(size_t size) { Data fixture(DataFixture::generate(size)); Data data(size); std::memcpy(data.data(), fixture.data(), size); return data; } }; TEST_F(BlockStoreWithRandomKeysTest, DataIsPassedThrough0) { Data data = createDataWithSize(0); EXPECT_CALL(blockStoreMock, do_create(_, Eq(ByRef(data)))).WillOnce(Return(new BlockMock)); blockStore.create(data); } TEST_F(BlockStoreWithRandomKeysTest, DataIsPassedThrough1) { Data data = createDataWithSize(1); EXPECT_CALL(blockStoreMock, do_create(_, Eq(ByRef(data)))).WillOnce(Return(new BlockMock)); blockStore.create(data); } TEST_F(BlockStoreWithRandomKeysTest, DataIsPassedThrough1024) { Data data = createDataWithSize(1024); EXPECT_CALL(blockStoreMock, do_create(_, Eq(ByRef(data)))).WillOnce(Return(new BlockMock)); blockStore.create(data); } TEST_F(BlockStoreWithRandomKeysTest, KeyHasCorrectSize) { EXPECT_CALL(blockStoreMock, do_create(_, _)).WillOnce(Invoke([](const Key &key, const Data &) { EXPECT_EQ(Key::STRING_LENGTH, key.ToString().size()); return new BlockMock; })); blockStore.create(createDataWithSize(1024)); } TEST_F(BlockStoreWithRandomKeysTest, TwoBlocksGetDifferentKeys) { Key first_key = key; EXPECT_CALL(blockStoreMock, do_create(_, _)) .WillOnce(Invoke([&first_key](const Key &key, const Data &) { first_key = key; return new BlockMock; })) .WillOnce(Invoke([&first_key](const Key &key, const Data &) { EXPECT_NE(first_key, key); return new BlockMock; })); Data data = createDataWithSize(1024); blockStore.create(data); blockStore.create(data); } TEST_F(BlockStoreWithRandomKeysTest, WillTryADifferentKeyIfKeyAlreadyExists) { Key first_key = key; Data data = createDataWithSize(1024); EXPECT_CALL(blockStoreMock, do_create(_, Eq(ByRef(data)))) .WillOnce(Invoke([&first_key](const Key &key, const Data &) { first_key = key; return nullptr; })) //TODO Check that this test case fails when the second do_create call gets different data .WillOnce(Invoke([&first_key](const Key &key, const Data &) { EXPECT_NE(first_key, key); return new BlockMock; })); blockStore.create(data); } TEST_F(BlockStoreWithRandomKeysTest, WillTryADifferentKeyIfKeyAlreadyExistsTwoTimes) { Key first_key = key; Data data = createDataWithSize(1024); EXPECT_CALL(blockStoreMock, do_create(_, Eq(ByRef(data)))) .WillOnce(Invoke([&first_key](const Key &key, const Data &) { first_key = key; return nullptr; })) //TODO Check that this test case fails when the second/third do_create calls get different data .WillOnce(Invoke([&first_key](const Key &key, const Data &) { first_key = key; return nullptr; })) .WillOnce(Invoke([&first_key](const Key &key, const Data &) { EXPECT_NE(first_key, key); return new BlockMock; })); blockStore.create(data); } test/blockstore/testutils/000077500000000000000000000000001300002025200162245ustar00rootroot00000000000000test/blockstore/testutils/BlockStoreTest.h000066400000000000000000000177401300002025200213150ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_TEST_IMPLEMENTATIONS_TESTUTILS_BLOCKSTORETEST_H_ #define MESSMER_BLOCKSTORE_TEST_IMPLEMENTATIONS_TESTUTILS_BLOCKSTORETEST_H_ #include #include #include "blockstore/interface/BlockStore.h" class BlockStoreTestFixture { public: virtual ~BlockStoreTestFixture() {} virtual cpputils::unique_ref createBlockStore() = 0; }; template class BlockStoreTest: public ::testing::Test { public: BlockStoreTest() :fixture() {} BOOST_STATIC_ASSERT_MSG( (std::is_base_of::value), "Given test fixture for instantiating the (type parameterized) BlockStoreTest must inherit from BlockStoreTestFixture" ); ConcreteBlockStoreTestFixture fixture; void TestBlockIsUsable(cpputils::unique_ref block, blockstore::BlockStore *blockStore) { // Write full block space and check it was correctly written cpputils::Data fixture = cpputils::DataFixture::generate(block->size()); block->write(fixture.data(), 0, fixture.size()); EXPECT_EQ(0, std::memcmp(fixture.data(), block->data(), fixture.size())); // Store and reload block and check data is still correct auto key = block->key(); cpputils::destruct(std::move(block)); block = blockStore->load(key).value(); EXPECT_EQ(0, std::memcmp(fixture.data(), block->data(), fixture.size())); } }; TYPED_TEST_CASE_P(BlockStoreTest); TYPED_TEST_P(BlockStoreTest, TwoCreatedBlocksHaveDifferentKeys) { auto blockStore = this->fixture.createBlockStore(); auto block1 = blockStore->create(cpputils::Data(1024)); auto block2 = blockStore->create(cpputils::Data(1024)); EXPECT_NE(block1->key(), block2->key()); } TYPED_TEST_P(BlockStoreTest, BlockIsNotLoadableAfterDeleting) { auto blockStore = this->fixture.createBlockStore(); auto blockkey = blockStore->create(cpputils::Data(1024))->key(); auto block = blockStore->load(blockkey); EXPECT_NE(boost::none, block); blockStore->remove(std::move(*block)); EXPECT_EQ(boost::none, blockStore->load(blockkey)); } TYPED_TEST_P(BlockStoreTest, NumBlocksIsCorrectOnEmptyBlockstore) { auto blockStore = this->fixture.createBlockStore(); EXPECT_EQ(0u, blockStore->numBlocks()); } TYPED_TEST_P(BlockStoreTest, NumBlocksIsCorrectAfterAddingOneBlock) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->create(cpputils::Data(1)); EXPECT_EQ(1u, blockStore->numBlocks()); } TYPED_TEST_P(BlockStoreTest, NumBlocksIsCorrectAfterAddingOneBlock_AfterClosingBlock) { auto blockStore = this->fixture.createBlockStore(); blockStore->create(cpputils::Data(1)); EXPECT_EQ(1u, blockStore->numBlocks()); } TYPED_TEST_P(BlockStoreTest, NumBlocksIsCorrectAfterRemovingTheLastBlock) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->create(cpputils::Data(1)); blockStore->remove(std::move(block)); EXPECT_EQ(0u, blockStore->numBlocks()); } TYPED_TEST_P(BlockStoreTest, NumBlocksIsCorrectAfterAddingTwoBlocks) { auto blockStore = this->fixture.createBlockStore(); auto block1 = blockStore->create(cpputils::Data(1)); auto block2 = blockStore->create(cpputils::Data(0)); EXPECT_EQ(2u, blockStore->numBlocks()); } TYPED_TEST_P(BlockStoreTest, NumBlocksIsCorrectAfterAddingTwoBlocks_AfterClosingFirstBlock) { auto blockStore = this->fixture.createBlockStore(); blockStore->create(cpputils::Data(1)); auto block2 = blockStore->create(cpputils::Data(0)); EXPECT_EQ(2u, blockStore->numBlocks()); } TYPED_TEST_P(BlockStoreTest, NumBlocksIsCorrectAfterAddingTwoBlocks_AfterClosingSecondBlock) { auto blockStore = this->fixture.createBlockStore(); auto block1 = blockStore->create(cpputils::Data(1)); blockStore->create(cpputils::Data(0)); EXPECT_EQ(2u, blockStore->numBlocks()); } TYPED_TEST_P(BlockStoreTest, NumBlocksIsCorrectAfterAddingTwoBlocks_AfterClosingBothBlocks) { auto blockStore = this->fixture.createBlockStore(); blockStore->create(cpputils::Data(1)); blockStore->create(cpputils::Data(0)); EXPECT_EQ(2u, blockStore->numBlocks()); } TYPED_TEST_P(BlockStoreTest, NumBlocksIsCorrectAfterRemovingABlock) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->create(cpputils::Data(1)); blockStore->create(cpputils::Data(1)); blockStore->remove(std::move(block)); EXPECT_EQ(1u, blockStore->numBlocks()); } TYPED_TEST_P(BlockStoreTest, CanRemoveModifiedBlock) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->create(cpputils::Data(5)); block->write("data", 0, 4); blockStore->remove(std::move(block)); EXPECT_EQ(0u, blockStore->numBlocks()); } TYPED_TEST_P(BlockStoreTest, Resize_Larger_FromZero) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->create(cpputils::Data(0)); block->resize(10); EXPECT_EQ(10u, block->size()); } TYPED_TEST_P(BlockStoreTest, Resize_Larger_FromZero_BlockIsStillUsable) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->create(cpputils::Data(0)); block->resize(10); this->TestBlockIsUsable(std::move(block), blockStore.get()); } TYPED_TEST_P(BlockStoreTest, Resize_Larger) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->create(cpputils::Data(10)); block->resize(20); EXPECT_EQ(20u, block->size()); } TYPED_TEST_P(BlockStoreTest, Resize_Larger_BlockIsStillUsable) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->create(cpputils::Data(10)); block->resize(20); this->TestBlockIsUsable(std::move(block), blockStore.get()); } TYPED_TEST_P(BlockStoreTest, Resize_Smaller) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->create(cpputils::Data(10)); block->resize(5); EXPECT_EQ(5u, block->size()); } TYPED_TEST_P(BlockStoreTest, Resize_Smaller_BlockIsStillUsable) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->create(cpputils::Data(10)); block->resize(5); this->TestBlockIsUsable(std::move(block), blockStore.get()); } TYPED_TEST_P(BlockStoreTest, Resize_Smaller_ToZero) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->create(cpputils::Data(10)); block->resize(0); EXPECT_EQ(0u, block->size()); } TYPED_TEST_P(BlockStoreTest, Resize_Smaller_ToZero_BlockIsStillUsable) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->create(cpputils::Data(10)); block->resize(0); this->TestBlockIsUsable(std::move(block), blockStore.get()); } #include "BlockStoreTest_Size.h" #include "BlockStoreTest_Data.h" REGISTER_TYPED_TEST_CASE_P(BlockStoreTest, CreatedBlockHasCorrectSize, LoadingUnchangedBlockHasCorrectSize, CreatedBlockData, LoadingUnchangedBlockData, LoadedBlockIsCorrect, // LoadedBlockIsCorrectWhenLoadedDirectlyAfterFlushing, AfterCreate_FlushingDoesntChangeBlock, AfterLoad_FlushingDoesntChangeBlock, AfterCreate_FlushesWhenDestructed, AfterLoad_FlushesWhenDestructed, LoadNonExistingBlock, TwoCreatedBlocksHaveDifferentKeys, BlockIsNotLoadableAfterDeleting, NumBlocksIsCorrectOnEmptyBlockstore, NumBlocksIsCorrectAfterAddingOneBlock, NumBlocksIsCorrectAfterAddingOneBlock_AfterClosingBlock, NumBlocksIsCorrectAfterRemovingTheLastBlock, NumBlocksIsCorrectAfterAddingTwoBlocks, NumBlocksIsCorrectAfterAddingTwoBlocks_AfterClosingFirstBlock, NumBlocksIsCorrectAfterAddingTwoBlocks_AfterClosingSecondBlock, NumBlocksIsCorrectAfterAddingTwoBlocks_AfterClosingBothBlocks, NumBlocksIsCorrectAfterRemovingABlock, WriteAndReadImmediately, WriteAndReadAfterLoading, OverwriteAndRead, CanRemoveModifiedBlock, Resize_Larger_FromZero, Resize_Larger_FromZero_BlockIsStillUsable, Resize_Larger, Resize_Larger_BlockIsStillUsable, Resize_Smaller, Resize_Smaller_BlockIsStillUsable, Resize_Smaller_ToZero, Resize_Smaller_ToZero_BlockIsStillUsable ); #endif test/blockstore/testutils/BlockStoreTest_Data.h000066400000000000000000000112221300002025200222330ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_TEST_TESTUTILS_BLOCKSTORETEST_DATA_H_ #define MESSMER_BLOCKSTORE_TEST_TESTUTILS_BLOCKSTORETEST_DATA_H_ // This file is meant to be included by BlockStoreTest.h only struct DataRange { size_t blocksize; off_t offset; size_t count; }; class BlockStoreDataParametrizedTest { public: BlockStoreDataParametrizedTest(cpputils::unique_ref blockStore_, const DataRange &testData_) : blockStore(std::move(blockStore_)), testData(testData_), foregroundData(cpputils::DataFixture::generate(testData.count, 0)), backgroundData(cpputils::DataFixture::generate(testData.blocksize, 1)) { } void TestWriteAndReadImmediately() { auto block = blockStore->create(cpputils::Data(testData.blocksize).FillWithZeroes()); block->write(foregroundData.data(), testData.offset, testData.count); EXPECT_DATA_READS_AS(foregroundData, *block, testData.offset, testData.count); EXPECT_DATA_IS_ZEROES_OUTSIDE_OF(*block, testData.offset, testData.count); } void TestWriteAndReadAfterLoading() { blockstore::Key key = CreateBlockWriteToItAndReturnKey(foregroundData); auto loaded_block = blockStore->load(key).value(); EXPECT_DATA_READS_AS(foregroundData, *loaded_block, testData.offset, testData.count); EXPECT_DATA_IS_ZEROES_OUTSIDE_OF(*loaded_block, testData.offset, testData.count); } void TestOverwriteAndRead() { auto block = blockStore->create(cpputils::Data(testData.blocksize)); block->write(backgroundData.data(), 0, testData.blocksize); block->write(foregroundData.data(), testData.offset, testData.count); EXPECT_DATA_READS_AS(foregroundData, *block, testData.offset, testData.count); EXPECT_DATA_READS_AS_OUTSIDE_OF(backgroundData, *block, testData.offset, testData.count); } private: cpputils::unique_ref blockStore; DataRange testData; cpputils::Data foregroundData; cpputils::Data backgroundData; blockstore::Key CreateBlockWriteToItAndReturnKey(const cpputils::Data &to_write) { auto newblock = blockStore->create(cpputils::Data(testData.blocksize).FillWithZeroes()); newblock->write(to_write.data(), testData.offset, testData.count); return newblock->key(); } void EXPECT_DATA_READS_AS(const cpputils::Data &expected, const blockstore::Block &block, off_t offset, size_t count) { cpputils::Data read(count); std::memcpy(read.data(), (uint8_t*)block.data() + offset, count); EXPECT_EQ(expected, read); } void EXPECT_DATA_READS_AS_OUTSIDE_OF(const cpputils::Data &expected, const blockstore::Block &block, off_t start, size_t count) { cpputils::Data begin(start); cpputils::Data end(testData.blocksize - count - start); std::memcpy(begin.data(), expected.data(), start); std::memcpy(end.data(), (uint8_t*)expected.data()+start+count, end.size()); EXPECT_DATA_READS_AS(begin, block, 0, start); EXPECT_DATA_READS_AS(end, block, start + count, end.size()); } void EXPECT_DATA_IS_ZEROES_OUTSIDE_OF(const blockstore::Block &block, off_t start, size_t count) { cpputils::Data ZEROES(testData.blocksize); ZEROES.FillWithZeroes(); EXPECT_DATA_READS_AS_OUTSIDE_OF(ZEROES, block, start, count); } }; inline std::vector DATA_RANGES() { return { DataRange{1024, 0, 1024}, // full size leaf, access beginning to end DataRange{1024, 100, 1024 - 200}, // full size leaf, access middle to middle DataRange{1024, 0, 1024 - 100}, // full size leaf, access beginning to middle DataRange{1024, 100, 1024 - 100}, // full size leaf, access middle to end DataRange{1024 - 100, 0, 1024 - 100}, // non-full size leaf, access beginning to end DataRange{1024 - 100, 100, 1024 - 300}, // non-full size leaf, access middle to middle DataRange{1024 - 100, 0, 1024 - 200}, // non-full size leaf, access beginning to middle DataRange{1024 - 100, 100, 1024 - 200} // non-full size leaf, access middle to end }; }; #define TYPED_TEST_P_FOR_ALL_DATA_RANGES(TestName) \ TYPED_TEST_P(BlockStoreTest, TestName) { \ for (auto dataRange: DATA_RANGES()) { \ BlockStoreDataParametrizedTest(this->fixture.createBlockStore(), dataRange) \ .Test##TestName(); \ } \ } TYPED_TEST_P_FOR_ALL_DATA_RANGES(WriteAndReadImmediately); TYPED_TEST_P_FOR_ALL_DATA_RANGES(WriteAndReadAfterLoading); TYPED_TEST_P_FOR_ALL_DATA_RANGES(OverwriteAndRead); #endif test/blockstore/testutils/BlockStoreTest_Size.h000066400000000000000000000143151300002025200223020ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_TEST_TESTUTILS_BLOCKSTORETEST_SIZE_H_ #define MESSMER_BLOCKSTORE_TEST_TESTUTILS_BLOCKSTORETEST_SIZE_H_ // This file is meant to be included by BlockStoreTest.h only #include #include class BlockStoreSizeParameterizedTest { public: BlockStoreSizeParameterizedTest(cpputils::unique_ref blockStore_, size_t size_): blockStore(std::move(blockStore_)), size(size_) {} void TestCreatedBlockHasCorrectSize() { auto block = CreateBlock(); EXPECT_EQ(size, block->size()); } void TestLoadingUnchangedBlockHasCorrectSize() { blockstore::Key key = CreateBlock()->key(); auto loaded_block = blockStore->load(key).value(); EXPECT_EQ(size, loaded_block->size()); } void TestCreatedBlockData() { cpputils::Data data = cpputils::DataFixture::generate(size); auto block = blockStore->create(data); EXPECT_EQ(0, std::memcmp(data.data(), block->data(), size)); } void TestLoadingUnchangedBlockData() { cpputils::Data data = cpputils::DataFixture::generate(size); blockstore::Key key = blockStore->create(data)->key(); auto loaded_block = blockStore->load(key).value(); EXPECT_EQ(0, std::memcmp(data.data(), loaded_block->data(), size)); } void TestLoadedBlockIsCorrect() { cpputils::Data randomData = cpputils::DataFixture::generate(size); auto loaded_block = StoreDataToBlockAndLoadIt(randomData); EXPECT_EQ(size, loaded_block->size()); EXPECT_EQ(0, std::memcmp(randomData.data(), loaded_block->data(), size)); } void TestLoadedBlockIsCorrectWhenLoadedDirectlyAfterFlushing() { cpputils::Data randomData = cpputils::DataFixture::generate(size); auto loaded_block = StoreDataToBlockAndLoadItDirectlyAfterFlushing(randomData); EXPECT_EQ(size, loaded_block->size()); EXPECT_EQ(0, std::memcmp(randomData.data(), loaded_block->data(), size)); } void TestAfterCreate_FlushingDoesntChangeBlock() { cpputils::Data randomData = cpputils::DataFixture::generate(size); auto block = CreateBlock(); WriteDataToBlock(block.get(), randomData); block->flush(); EXPECT_BLOCK_DATA_CORRECT(*block, randomData); } void TestAfterLoad_FlushingDoesntChangeBlock() { cpputils::Data randomData = cpputils::DataFixture::generate(size); auto block = CreateBlockAndLoadIt(); WriteDataToBlock(block.get(), randomData); block->flush(); EXPECT_BLOCK_DATA_CORRECT(*block, randomData); } void TestAfterCreate_FlushesWhenDestructed() { cpputils::Data randomData = cpputils::DataFixture::generate(size); blockstore::Key key = blockstore::Key::Null(); { auto block = blockStore->create(cpputils::Data(size)); key = block->key(); WriteDataToBlock(block.get(), randomData); } auto loaded_block = blockStore->load(key).value(); EXPECT_BLOCK_DATA_CORRECT(*loaded_block, randomData); } void TestAfterLoad_FlushesWhenDestructed() { cpputils::Data randomData = cpputils::DataFixture::generate(size); blockstore::Key key = blockstore::Key::Null(); { key = CreateBlock()->key(); auto block = blockStore->load(key).value(); WriteDataToBlock(block.get(), randomData); } auto loaded_block = blockStore->load(key).value(); EXPECT_BLOCK_DATA_CORRECT(*loaded_block, randomData); } void TestLoadNonExistingBlock() { EXPECT_EQ(boost::none, blockStore->load(key)); } private: const blockstore::Key key = blockstore::Key::FromString("1491BB4932A389EE14BC7090AC772972"); cpputils::unique_ref blockStore; size_t size; cpputils::Data ZEROES(size_t size) { cpputils::Data ZEROES(size); ZEROES.FillWithZeroes(); return ZEROES; } cpputils::unique_ref StoreDataToBlockAndLoadIt(const cpputils::Data &data) { blockstore::Key key = StoreDataToBlockAndGetKey(data); return blockStore->load(key).value(); } blockstore::Key StoreDataToBlockAndGetKey(const cpputils::Data &data) { return blockStore->create(data)->key(); } cpputils::unique_ref StoreDataToBlockAndLoadItDirectlyAfterFlushing(const cpputils::Data &data) { auto block = blockStore->create(data); block->flush(); return blockStore->load(block->key()).value(); } cpputils::unique_ref CreateBlockAndLoadIt() { blockstore::Key key = CreateBlock()->key(); return blockStore->load(key).value(); } cpputils::unique_ref CreateBlock() { return blockStore->create(cpputils::Data(size)); } void WriteDataToBlock(blockstore::Block *block, const cpputils::Data &randomData) { block->write(randomData.data(), 0, randomData.size()); } void EXPECT_BLOCK_DATA_CORRECT(const blockstore::Block &block, const cpputils::Data &randomData) { EXPECT_EQ(randomData.size(), block.size()); EXPECT_EQ(0, std::memcmp(randomData.data(), block.data(), randomData.size())); } }; constexpr std::initializer_list SIZES = {0, 1, 1024, 4096, 10*1024*1024}; #define TYPED_TEST_P_FOR_ALL_SIZES(TestName) \ TYPED_TEST_P(BlockStoreTest, TestName) { \ for (auto size: SIZES) { \ BlockStoreSizeParameterizedTest(this->fixture.createBlockStore(), size) \ .Test##TestName(); \ } \ } \ TYPED_TEST_P_FOR_ALL_SIZES(CreatedBlockHasCorrectSize); TYPED_TEST_P_FOR_ALL_SIZES(LoadingUnchangedBlockHasCorrectSize); TYPED_TEST_P_FOR_ALL_SIZES(CreatedBlockData); TYPED_TEST_P_FOR_ALL_SIZES(LoadingUnchangedBlockData); TYPED_TEST_P_FOR_ALL_SIZES(LoadedBlockIsCorrect); //TYPED_TEST_P_FOR_ALL_SIZES(LoadedBlockIsCorrectWhenLoadedDirectlyAfterFlushing); TYPED_TEST_P_FOR_ALL_SIZES(AfterCreate_FlushingDoesntChangeBlock); TYPED_TEST_P_FOR_ALL_SIZES(AfterLoad_FlushingDoesntChangeBlock); TYPED_TEST_P_FOR_ALL_SIZES(AfterCreate_FlushesWhenDestructed); TYPED_TEST_P_FOR_ALL_SIZES(AfterLoad_FlushesWhenDestructed); TYPED_TEST_P_FOR_ALL_SIZES(LoadNonExistingBlock); #endif test/blockstore/testutils/BlockStoreWithRandomKeysTest.h000066400000000000000000000070121300002025200241350ustar00rootroot00000000000000#pragma once #ifndef MESSMER_BLOCKSTORE_TEST_TESTUTILS_BLOCKSTOREWITHRANDOMKEYSTEST_H_ #define MESSMER_BLOCKSTORE_TEST_TESTUTILS_BLOCKSTOREWITHRANDOMKEYSTEST_H_ #include #include "blockstore/interface/BlockStore.h" class BlockStoreWithRandomKeysTestFixture { public: virtual ~BlockStoreWithRandomKeysTestFixture() {} virtual cpputils::unique_ref createBlockStore() = 0; }; template class BlockStoreWithRandomKeysTest: public ::testing::Test { public: BlockStoreWithRandomKeysTest(): fixture() {} BOOST_STATIC_ASSERT_MSG( (std::is_base_of::value), "Given test fixture for instantiating the (type parameterized) BlockStoreWithRandomKeysTest must inherit from BlockStoreWithRandomKeysTestFixture" ); blockstore::Key key = blockstore::Key::FromString("1491BB4932A389EE14BC7090AC772972"); const std::vector SIZES = {0, 1, 1024, 4096, 10*1024*1024}; ConcreteBlockStoreWithRandomKeysTestFixture fixture; }; TYPED_TEST_CASE_P(BlockStoreWithRandomKeysTest); TYPED_TEST_P(BlockStoreWithRandomKeysTest, CreateTwoBlocksWithSameKeyAndSameSize) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->tryCreate(this->key, cpputils::Data(1024)); (*block)->flush(); //TODO Ideally, flush shouldn't be necessary here. auto block2 = blockStore->tryCreate(this->key, cpputils::Data(1024)); EXPECT_NE(boost::none, block); EXPECT_EQ(boost::none, block2); } TYPED_TEST_P(BlockStoreWithRandomKeysTest, CreateTwoBlocksWithSameKeyAndDifferentSize) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->tryCreate(this->key, cpputils::Data(1024)); (*block)->flush(); //TODO Ideally, flush shouldn't be necessary here. auto block2 = blockStore->tryCreate(this->key, cpputils::Data(4096)); EXPECT_NE(boost::none, block); EXPECT_EQ(boost::none, block2); } TYPED_TEST_P(BlockStoreWithRandomKeysTest, CreateTwoBlocksWithSameKeyAndFirstNullSize) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->tryCreate(this->key, cpputils::Data(0)); (*block)->flush(); //TODO Ideally, flush shouldn't be necessary here. auto block2 = blockStore->tryCreate(this->key, cpputils::Data(1024)); EXPECT_NE(boost::none, block); EXPECT_EQ(boost::none, block2); } TYPED_TEST_P(BlockStoreWithRandomKeysTest, CreateTwoBlocksWithSameKeyAndSecondNullSize) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->tryCreate(this->key, cpputils::Data(1024)); (*block)->flush(); //TODO Ideally, flush shouldn't be necessary here. auto block2 = blockStore->tryCreate(this->key, cpputils::Data(0)); EXPECT_NE(boost::none, block); EXPECT_EQ(boost::none, block2); } TYPED_TEST_P(BlockStoreWithRandomKeysTest, CreateTwoBlocksWithSameKeyAndBothNullSize) { auto blockStore = this->fixture.createBlockStore(); auto block = blockStore->tryCreate(this->key, cpputils::Data(0)); (*block)->flush(); //TODO Ideally, flush shouldn't be necessary here. auto block2 = blockStore->tryCreate(this->key, cpputils::Data(0)); EXPECT_NE(boost::none, block); EXPECT_EQ(boost::none, block2); } REGISTER_TYPED_TEST_CASE_P(BlockStoreWithRandomKeysTest, CreateTwoBlocksWithSameKeyAndSameSize, CreateTwoBlocksWithSameKeyAndDifferentSize, CreateTwoBlocksWithSameKeyAndFirstNullSize, CreateTwoBlocksWithSameKeyAndSecondNullSize, CreateTwoBlocksWithSameKeyAndBothNullSize ); #endif test/blockstore/utils/000077500000000000000000000000001300002025200153245ustar00rootroot00000000000000test/blockstore/utils/BlockStoreUtilsTest.cpp000066400000000000000000000067131300002025200217670ustar00rootroot00000000000000#include "blockstore/implementations/testfake/FakeBlockStore.h" #include #include "blockstore/utils/BlockStoreUtils.h" #include #include using ::testing::Test; using ::testing::WithParamInterface; using ::testing::Values; using cpputils::Data; using cpputils::DataFixture; using cpputils::unique_ref; using cpputils::make_unique_ref; using namespace blockstore; using namespace blockstore::utils; using blockstore::testfake::FakeBlockStore; class BlockStoreUtilsTest: public Test { public: unsigned int SIZE = 1024 * 1024; BlockStoreUtilsTest(): ZEROES(SIZE), dataFixture(DataFixture::generate(SIZE)), blockStore(make_unique_ref()) { ZEROES.FillWithZeroes(); } Data ZEROES; Data dataFixture; unique_ref blockStore; }; TEST_F(BlockStoreUtilsTest, FillWithZeroes) { auto block = blockStore->create(Data(SIZE)); block->write(dataFixture.data(), 0, SIZE); EXPECT_NE(0, std::memcmp(ZEROES.data(), block->data(), SIZE)); fillWithZeroes(block.get()); EXPECT_EQ(0, std::memcmp(ZEROES.data(), block->data(), SIZE)); } class BlockStoreUtilsTest_CopyToNewBlock: public BlockStoreUtilsTest {}; TEST_F(BlockStoreUtilsTest_CopyToNewBlock, CopyEmptyBlock) { auto block = blockStore->create(Data(0)); auto block2 = copyToNewBlock(blockStore.get(), *block); EXPECT_EQ(0u, block2->size()); } TEST_F(BlockStoreUtilsTest_CopyToNewBlock, CopyZeroBlock) { auto block = blockStore->create(ZEROES); auto block2 = copyToNewBlock(blockStore.get(), *block); EXPECT_EQ(SIZE, block2->size()); EXPECT_EQ(0, std::memcmp(ZEROES.data(), block2->data(), SIZE)); } TEST_F(BlockStoreUtilsTest_CopyToNewBlock, CopyDataBlock) { auto block = blockStore->create(Data(SIZE)); block->write(dataFixture.data(), 0, SIZE); auto block2 = copyToNewBlock(blockStore.get(), *block); EXPECT_EQ(SIZE, block2->size()); EXPECT_EQ(0, std::memcmp(dataFixture.data(), block2->data(), SIZE)); } TEST_F(BlockStoreUtilsTest_CopyToNewBlock, OriginalBlockUnchanged) { auto block = blockStore->create(Data(SIZE)); block->write(dataFixture.data(), 0, SIZE); auto block2 = copyToNewBlock(blockStore.get(), *block); EXPECT_EQ(SIZE, block->size()); EXPECT_EQ(0, std::memcmp(dataFixture.data(), block->data(), SIZE)); } class BlockStoreUtilsTest_CopyToExistingBlock: public BlockStoreUtilsTest {}; TEST_F(BlockStoreUtilsTest_CopyToExistingBlock, CopyEmptyBlock) { auto block = blockStore->create(Data(0)); auto block2 = blockStore->create(Data(0)); copyTo(block2.get(), *block); } TEST_F(BlockStoreUtilsTest_CopyToExistingBlock, CopyZeroBlock) { auto block = blockStore->create(ZEROES); auto block2 = blockStore->create(Data(SIZE)); block2->write(dataFixture.data(), 0, SIZE); copyTo(block2.get(), *block); EXPECT_EQ(0, std::memcmp(ZEROES.data(), block2->data(), SIZE)); } TEST_F(BlockStoreUtilsTest_CopyToExistingBlock, CopyDataBlock) { auto block = blockStore->create(Data(SIZE)); block->write(dataFixture.data(), 0, SIZE); auto block2 = blockStore->create(Data(SIZE)); copyTo(block2.get(), *block); EXPECT_EQ(0, std::memcmp(dataFixture.data(), block2->data(), SIZE)); } TEST_F(BlockStoreUtilsTest_CopyToExistingBlock, OriginalBlockUnchanged) { auto block = blockStore->create(Data(SIZE)); block->write(dataFixture.data(), 0, SIZE); auto block2 = blockStore->create(Data(SIZE)); copyTo(block2.get(), *block); EXPECT_EQ(0, std::memcmp(dataFixture.data(), block->data(), SIZE)); } test/cpp-utils/000077500000000000000000000000001300002025200137355ustar00rootroot00000000000000test/cpp-utils/CMakeLists.txt000066400000000000000000000034531300002025200165020ustar00rootroot00000000000000project (cpp-utils-test) set(SOURCES EitherIncludeTest.cpp crypto/symmetric/CipherTest.cpp crypto/symmetric/testutils/FakeAuthenticatedCipher.cpp crypto/kdf/SCryptTest.cpp crypto/kdf/SCryptParametersTest.cpp MacrosIncludeTest.cpp pointer/unique_ref_test.cpp pointer/cast_include_test.cpp pointer/cast_test.cpp pointer/unique_ref_boost_optional_gtest_workaround_include_test.cpp pointer/optional_ownership_ptr_include_test.cpp pointer/optional_ownership_ptr_test.cpp pointer/unique_ref_include_test.cpp process/daemonize_include_test.cpp process/subprocess_include_test.cpp tempfile/TempFileTest.cpp tempfile/TempFileIncludeTest.cpp tempfile/TempDirIncludeTest.cpp tempfile/TempDirTest.cpp network/CurlHttpClientTest.cpp network/FakeHttpClientTest.cpp io/ConsoleIncludeTest.cpp io/ConsoleTest_AskYesNo.cpp io/ConsoleTest_Print.cpp io/ConsoleTest_Ask.cpp random/RandomIncludeTest.cpp lock/LockPoolIncludeTest.cpp lock/ConditionBarrierIncludeTest.cpp lock/MutexPoolLockIncludeTest.cpp data/FixedSizeDataTest.cpp data/DataFixtureIncludeTest.cpp data/DataFixtureTest.cpp data/DataTest.cpp data/FixedSizeDataIncludeTest.cpp data/DataIncludeTest.cpp logging/LoggingLevelTest.cpp logging/LoggerTest.cpp logging/LoggingTest.cpp logging/LoggerIncludeTest.cpp logging/LoggingIncludeTest.cpp EitherTest.cpp assert/assert_release_test.cpp assert/backtrace_include_test.cpp assert/assert_include_test.cpp assert/assert_debug_test.cpp ) add_executable(${PROJECT_NAME} ${SOURCES}) target_link_libraries(${PROJECT_NAME} googletest cpp-utils) add_test(${PROJECT_NAME} ${PROJECT_NAME}) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) test/cpp-utils/EitherIncludeTest.cpp000066400000000000000000000001521300002025200200230ustar00rootroot00000000000000#include "cpp-utils/either.h" //Test that either can be included without needing additional dependencies test/cpp-utils/EitherTest.cpp000066400000000000000000000401331300002025200165220ustar00rootroot00000000000000#include #include #include #include "cpp-utils/either.h" #include "cpp-utils/macros.h" #include //TODO Go through all test cases and think about whether it makes sense to add the same test case but with primitive types. using std::ostringstream; using std::string; using std::vector; using std::pair; using std::make_pair; using namespace cpputils; using ::testing::Test; class OnlyMoveable { public: OnlyMoveable(int value_): value(value_) {} OnlyMoveable(OnlyMoveable &&source): value(source.value) {source.value = -1;} bool operator==(const OnlyMoveable &rhs) const { return value == rhs.value; } int value; private: DISALLOW_COPY_AND_ASSIGN(OnlyMoveable); }; template struct StoreWith1ByteFlag { T val; char flag; }; class EitherTest: public Test { public: template void EXPECT_IS_LEFT(const either &val) { EXPECT_TRUE(val.is_left()); EXPECT_FALSE(val.is_right()); } template void EXPECT_IS_RIGHT(const either &val) { EXPECT_FALSE(val.is_left()); EXPECT_TRUE(val.is_right()); } template void EXPECT_LEFT_IS(const Expected &expected, either &value) { EXPECT_IS_LEFT(value); EXPECT_EQ(expected, value.left()); EXPECT_EQ(expected, value.left_opt().get()); EXPECT_EQ(boost::none, value.right_opt()); const either &const_value = value; EXPECT_EQ(expected, const_value.left()); EXPECT_EQ(expected, const_value.left_opt().get()); EXPECT_EQ(boost::none, const_value.right_opt()); } template void EXPECT_RIGHT_IS(const Expected &expected, either &value) { EXPECT_IS_RIGHT(value); EXPECT_EQ(expected, value.right()); EXPECT_EQ(expected, value.right_opt().get()); EXPECT_EQ(boost::none, value.left_opt()); const either &const_value = value; EXPECT_EQ(expected, const_value.right()); EXPECT_EQ(expected, const_value.right_opt().get()); EXPECT_EQ(boost::none, const_value.left_opt()); } }; template void TestSpaceUsage() { EXPECT_EQ(std::max(sizeof(StoreWith1ByteFlag), sizeof(StoreWith1ByteFlag)), sizeof(either)); } TEST_F(EitherTest, SpaceUsage) { TestSpaceUsage(); TestSpaceUsage(); TestSpaceUsage(); TestSpaceUsage(); TestSpaceUsage>(); } TEST_F(EitherTest, LeftCanBeConstructed) { either val = 3; UNUSED(val); } TEST_F(EitherTest, RightCanBeConstructed) { either val = string("string"); UNUSED(val); } TEST_F(EitherTest, IsLeft) { either val = 3; EXPECT_IS_LEFT(val); } TEST_F(EitherTest, IsRight) { either val = string("string"); EXPECT_IS_RIGHT(val); } TEST_F(EitherTest, LeftIsStored) { either val = 3; EXPECT_LEFT_IS(3, val); } TEST_F(EitherTest, RightIsStored) { either val = string("string"); EXPECT_RIGHT_IS("string", val); } TEST_F(EitherTest, LeftCanBeMoveContructed) { either val = OnlyMoveable(1); UNUSED(val); } TEST_F(EitherTest, RightCanBeMoveContructed) { either val = OnlyMoveable(1); UNUSED(val); } TEST_F(EitherTest, IsLeftWhenMoveContructed) { either val = OnlyMoveable(1); EXPECT_IS_LEFT(val); } TEST_F(EitherTest, IsRightWhenMoveContructed) { either val = OnlyMoveable(1); EXPECT_IS_RIGHT(val); } TEST_F(EitherTest, LeftIsStoredWhenMoveContructed) { either val = OnlyMoveable(2); EXPECT_LEFT_IS(OnlyMoveable(2), val); } TEST_F(EitherTest, RightIsStoredWhenMoveContructed) { either val = OnlyMoveable(3); EXPECT_RIGHT_IS(OnlyMoveable(3), val); } TEST_F(EitherTest, LeftCanBeCopied) { either val = string("string"); either val2 = val; EXPECT_LEFT_IS("string", val2); } TEST_F(EitherTest, CopyingLeftDoesntChangeSource) { either val = string("string"); either val2 = val; EXPECT_LEFT_IS("string", val); } TEST_F(EitherTest, RightCanBeCopied) { either val = string("string"); either val2 = val; EXPECT_RIGHT_IS("string", val2); } TEST_F(EitherTest, CopyingRightDoesntChangeSource) { either val = string("string"); either val2 = val; EXPECT_RIGHT_IS("string", val); } TEST_F(EitherTest, LeftCanBeMoved) { either val = OnlyMoveable(5); either val2 = std::move(val); EXPECT_LEFT_IS(OnlyMoveable(5), val2); } TEST_F(EitherTest, RightCanBeMoved) { either val = OnlyMoveable(5); either val2 = std::move(val); EXPECT_RIGHT_IS(OnlyMoveable(5), val2); } TEST_F(EitherTest, LeftCanBeAssigned) { either val = string("string"); either val2 = string("otherstring"); val2 = val; EXPECT_LEFT_IS("string", val2); } TEST_F(EitherTest, RightCanBeAssigned) { either val = string("string"); either val2 = string("otherstring"); val2 = val; EXPECT_RIGHT_IS("string", val2); } TEST_F(EitherTest, LeftCanBeMoveAssigned) { either val = OnlyMoveable(3); either val2 = OnlyMoveable(4); val2 = std::move(val); EXPECT_LEFT_IS(OnlyMoveable(3), val2); } TEST_F(EitherTest, RightCanBeMoveAssigned) { either val = OnlyMoveable(3); either val2 = OnlyMoveable(4); val2 = std::move(val); EXPECT_RIGHT_IS(OnlyMoveable(3), val2); } TEST_F(EitherTest, LeftCanBeDirectlyAssigned) { either val = string("string"); val = string("otherstring"); EXPECT_LEFT_IS("otherstring", val); } TEST_F(EitherTest, RightCanBeDirectlyAssigned) { either val = string("string"); val = string("otherstring"); EXPECT_RIGHT_IS("otherstring", val); } TEST_F(EitherTest, LeftCanBeDirectlyMoveAssigned) { either val = OnlyMoveable(3); val = OnlyMoveable(5); EXPECT_LEFT_IS(OnlyMoveable(5), val); } TEST_F(EitherTest, RightCanBeDirectlyMoveAssigned) { either val = OnlyMoveable(3); val = OnlyMoveable(5); EXPECT_RIGHT_IS(OnlyMoveable(5), val); } TEST_F(EitherTest, ModifyLeft) { either val = string("mystring1"); val.left() = "mystring2"; EXPECT_LEFT_IS("mystring2", val); } TEST_F(EitherTest, ModifyRight) { either val = string("mystring1"); val.right() = "mystring2"; EXPECT_RIGHT_IS("mystring2", val); } TEST_F(EitherTest, ModifyLeftOpt) { either val = string("mystring1"); val.left_opt().get() = "mystring2"; EXPECT_LEFT_IS("mystring2", val); } TEST_F(EitherTest, ModifyRightOpt) { either val = string("mystring1"); val.right_opt().get() = "mystring2"; EXPECT_RIGHT_IS("mystring2", val); } TEST_F(EitherTest, LeftEquals) { either val1 = string("mystring"); either val2 = string("mystring"); EXPECT_TRUE(val1 == val2); EXPECT_TRUE(val2 == val1); EXPECT_FALSE(val1 != val2); EXPECT_FALSE(val2 != val1); } TEST_F(EitherTest, LeftNotEquals) { either val1 = string("mystring"); either val2 = string("mystring2"); EXPECT_TRUE(val1 != val2); EXPECT_TRUE(val2 != val1); EXPECT_FALSE(val1 == val2); EXPECT_FALSE(val2 == val1); } TEST_F(EitherTest, RightEquals) { either val1 = string("mystring"); either val2 = string("mystring"); EXPECT_TRUE(val1 == val2); EXPECT_TRUE(val2 == val1); EXPECT_FALSE(val1 != val2); EXPECT_FALSE(val2 != val1); } TEST_F(EitherTest, RightNotEquals) { either val1 = string("mystring"); either val2 = string("mystring2"); EXPECT_TRUE(val1 != val2); EXPECT_TRUE(val2 != val1); EXPECT_FALSE(val1 == val2); EXPECT_FALSE(val2 == val1); } TEST_F(EitherTest, LeftNotEqualsRight) { either val1 = string("mystring"); either val2 = 3; EXPECT_TRUE(val1 != val2); EXPECT_TRUE(val2 != val1); EXPECT_FALSE(val1 == val2); EXPECT_FALSE(val2 == val1); } TEST_F(EitherTest, OutputLeft) { ostringstream str; str << either("mystring"); EXPECT_EQ("Left(mystring)", str.str()); } TEST_F(EitherTest, OutputRight) { ostringstream str; str << either("mystring"); EXPECT_EQ("Right(mystring)", str.str()); } TEST_F(EitherTest, MakeLeft) { either var = make_left("mystring"); EXPECT_LEFT_IS("mystring", var); } TEST_F(EitherTest, MakeLeft_OnlyMoveable) { either var = make_left(4); EXPECT_LEFT_IS(OnlyMoveable(4), var); } TEST_F(EitherTest, MakeLeft_MultiParam) { either, int> var = make_left, int>(4, 5); EXPECT_LEFT_IS(make_pair(4,5), var); } TEST_F(EitherTest, MakeRight) { either var = make_right("mystring"); EXPECT_RIGHT_IS("mystring", var); } TEST_F(EitherTest, MakeRight_OnlyMoveable) { either var = make_right(4); EXPECT_RIGHT_IS(OnlyMoveable(4), var); } TEST_F(EitherTest, MakeRight_MultiParam) { either> var = make_right>(4, 5); EXPECT_RIGHT_IS(make_pair(4,5), var); } TEST_F(EitherTest, LeftCanBeQueriedAsRvalue) { OnlyMoveable val = make_left(3).left(); EXPECT_EQ(OnlyMoveable(3), val); } TEST_F(EitherTest, RightCanBeQueriedAsRvalue) { OnlyMoveable val = make_right(3).right(); EXPECT_EQ(OnlyMoveable(3), val); } TEST_F(EitherTest, LeftOptCanBeQueriedAsRvalue) { OnlyMoveable val = make_left(3).left_opt().value(); EXPECT_EQ(OnlyMoveable(3), val); } TEST_F(EitherTest, RightOptCanBeQueriedAsRvalue) { OnlyMoveable val = make_right(3).right_opt().value(); EXPECT_EQ(OnlyMoveable(3), val); } class DestructorCallback { public: MOCK_CONST_METHOD0(call, void()); void EXPECT_CALLED(int times = 1) { EXPECT_CALL(*this, call()).Times(times); } }; class ClassWithDestructorCallback { public: ClassWithDestructorCallback(const DestructorCallback *destructorCallback) : _destructorCallback(destructorCallback) {} ClassWithDestructorCallback(const ClassWithDestructorCallback &rhs): _destructorCallback(rhs._destructorCallback) {} ~ClassWithDestructorCallback() { _destructorCallback->call(); } private: const DestructorCallback *_destructorCallback; ClassWithDestructorCallback &operator=(const ClassWithDestructorCallback &rhs) = delete; }; class OnlyMoveableClassWithDestructorCallback { public: OnlyMoveableClassWithDestructorCallback(const DestructorCallback *destructorCallback) : _destructorCallback(destructorCallback) { } OnlyMoveableClassWithDestructorCallback(OnlyMoveableClassWithDestructorCallback &&source): _destructorCallback(source._destructorCallback) {} ~OnlyMoveableClassWithDestructorCallback() { _destructorCallback->call(); } private: DISALLOW_COPY_AND_ASSIGN(OnlyMoveableClassWithDestructorCallback); const DestructorCallback *_destructorCallback; }; class EitherTest_Destructor: public EitherTest { }; TEST_F(EitherTest_Destructor, LeftDestructorIsCalled) { DestructorCallback destructorCallback; destructorCallback.EXPECT_CALLED(2); //Once for the temp object, once when the either class destructs ClassWithDestructorCallback temp(&destructorCallback); either var = temp; } TEST_F(EitherTest_Destructor, RightDestructorIsCalled) { DestructorCallback destructorCallback; destructorCallback.EXPECT_CALLED(2); //Once for the temp object, once when the either class destructs ClassWithDestructorCallback temp(&destructorCallback); either var = temp; } TEST_F(EitherTest_Destructor, LeftDestructorIsCalledAfterCopying) { DestructorCallback destructorCallback; destructorCallback.EXPECT_CALLED(3); //Once for the temp object, once for var1 and once for var2 ClassWithDestructorCallback temp(&destructorCallback); either var1 = temp; either var2 = var1; } TEST_F(EitherTest_Destructor, RightDestructorIsCalledAfterCopying) { DestructorCallback destructorCallback; destructorCallback.EXPECT_CALLED(3); //Once for the temp object, once for var1 and once for var2 ClassWithDestructorCallback temp(&destructorCallback); either var1 = temp; either var2 = var1; } TEST_F(EitherTest_Destructor, LeftDestructorIsCalledAfterMoving) { DestructorCallback destructorCallback; destructorCallback.EXPECT_CALLED(3); //Once for the temp object, once for var1 and once for var2 OnlyMoveableClassWithDestructorCallback temp(&destructorCallback); either var1 = std::move(temp); either var2 = std::move(var1); } TEST_F(EitherTest_Destructor, RightDestructorIsCalledAfterMoving) { DestructorCallback destructorCallback; destructorCallback.EXPECT_CALLED(3); //Once for the temp object, once for var1 and once for var2 OnlyMoveableClassWithDestructorCallback temp(&destructorCallback); either var1 = std::move(temp); either var2 = std::move(var1); } TEST_F(EitherTest_Destructor, LeftDestructorIsCalledAfterAssignment) { DestructorCallback destructorCallback1; DestructorCallback destructorCallback2; destructorCallback1.EXPECT_CALLED(2); //Once for the temp1 object, once at the assignment destructorCallback2.EXPECT_CALLED(3); //Once for the temp2 object, once in destructor of var2, once in destructor of var1 ClassWithDestructorCallback temp1(&destructorCallback1); either var1 = temp1; ClassWithDestructorCallback temp2(&destructorCallback2); either var2 = temp2; var1 = var2; } TEST_F(EitherTest_Destructor, RightDestructorIsCalledAfterAssignment) { DestructorCallback destructorCallback1; DestructorCallback destructorCallback2; destructorCallback1.EXPECT_CALLED(2); //Once for the temp1 object, once at the assignment destructorCallback2.EXPECT_CALLED(3); //Once for the temp2 object, once in destructor of var2, once in destructor of var1 ClassWithDestructorCallback temp1(&destructorCallback1); either var1 = temp1; ClassWithDestructorCallback temp2(&destructorCallback2); either var2 = temp2; var1 = var2; } TEST_F(EitherTest_Destructor, LeftDestructorIsCalledAfterMoveAssignment) { DestructorCallback destructorCallback1; DestructorCallback destructorCallback2; destructorCallback1.EXPECT_CALLED(2); //Once for the temp1 object, once at the assignment destructorCallback2.EXPECT_CALLED(3); //Once for the temp2 object, once in destructor of var2, once in destructor of var1 OnlyMoveableClassWithDestructorCallback temp1(&destructorCallback1); either var1 = std::move(temp1); OnlyMoveableClassWithDestructorCallback temp2(&destructorCallback2); either var2 = std::move(temp2); var1 = std::move(var2); } TEST_F(EitherTest_Destructor, RightDestructorIsCalledAfterMoveAssignment) { DestructorCallback destructorCallback1; DestructorCallback destructorCallback2; destructorCallback1.EXPECT_CALLED(2); //Once for the temp1 object, once at the assignment destructorCallback2.EXPECT_CALLED(3); //Once for the temp2 object, once in destructor of var2, once in destructor of var1 OnlyMoveableClassWithDestructorCallback temp1(&destructorCallback1); either var1 = std::move(temp1); OnlyMoveableClassWithDestructorCallback temp2(&destructorCallback2); either var2 = std::move(temp2); var1 = std::move(var2); } test/cpp-utils/MacrosIncludeTest.cpp000066400000000000000000000001551300002025200200320ustar00rootroot00000000000000#include "cpp-utils/macros.h" // Test that macros.h can be included without needing additional dependencies test/cpp-utils/assert/000077500000000000000000000000001300002025200152365ustar00rootroot00000000000000test/cpp-utils/assert/assert_debug_test.cpp000066400000000000000000000010461300002025200214510ustar00rootroot00000000000000#include #include //Include the ASSERT macro for a debug build #undef NDEBUG #include "cpp-utils/assert/assert.h" using testing::MatchesRegex; TEST(AssertTest_DebugBuild, DoesntDieIfTrue) { ASSERT(true, "bla"); } TEST(AssertTest_DebugBuild, DiesIfFalse) { EXPECT_DEATH( ASSERT(false, "bla"), "" ); } TEST(AssertTest_DebugBuild, AssertMessage) { EXPECT_DEATH( ASSERT(2==5, "my message"), "Assertion \\[2==5\\] failed in .*/assert_debug_test.cpp:[0-9]+: my message" ); } test/cpp-utils/assert/assert_include_test.cpp000066400000000000000000000001611300002025200220030ustar00rootroot00000000000000#include "cpp-utils/assert/assert.h" // Test the header can be included without needing additional dependencies test/cpp-utils/assert/assert_release_test.cpp000066400000000000000000000012571300002025200220070ustar00rootroot00000000000000#include #include //Include the ASSERT macro for a release build #ifndef NDEBUG #define NDEBUG #endif #include "cpp-utils/assert/assert.h" using testing::MatchesRegex; TEST(AssertTest_ReleaseBuild, DoesntThrowIfTrue) { ASSERT(true, "bla"); } TEST(AssertTest_ReleaseBuild, ThrowsIfFalse) { EXPECT_THROW( ASSERT(false, "bla"), cpputils::AssertFailed ); } TEST(AssertTest_ReleaseBuild, AssertMessage) { try { ASSERT(2==5, "my message"); FAIL(); } catch (const cpputils::AssertFailed &e) { EXPECT_THAT(e.what(), MatchesRegex( "Assertion \\[2==5\\] failed in .*/assert_release_test.cpp:25: my message.*" )); } }test/cpp-utils/assert/backtrace_include_test.cpp000066400000000000000000000001651300002025200224250ustar00rootroot00000000000000#include "cpp-utils/assert/backtrace.h" // Test the header can be included without needing additional dependencies test/cpp-utils/crypto/000077500000000000000000000000001300002025200152555ustar00rootroot00000000000000test/cpp-utils/crypto/kdf/000077500000000000000000000000001300002025200160215ustar00rootroot00000000000000test/cpp-utils/crypto/kdf/SCryptParametersTest.cpp000066400000000000000000000044421300002025200226410ustar00rootroot00000000000000#include #include #include #include using namespace cpputils; class SCryptParametersTest : public ::testing::Test { public: SCryptParameters SaveAndLoad(const SCryptParameters &source) { Data serialized = source.serialize(); return SCryptParameters::deserialize(serialized); } }; TEST_F(SCryptParametersTest, Salt) { SCryptParameters cfg(DataFixture::generate(32), 0, 0, 0); EXPECT_EQ(DataFixture::generate(32), cfg.salt()); } TEST_F(SCryptParametersTest, Salt_Move) { SCryptParameters cfg(DataFixture::generate(32), 0, 0, 0); SCryptParameters moved = std::move(cfg); EXPECT_EQ(DataFixture::generate(32), moved.salt()); } TEST_F(SCryptParametersTest, Salt_SaveAndLoad) { SCryptParameters cfg(DataFixture::generate(32), 0, 0, 0); SCryptParameters loaded = SaveAndLoad(cfg); EXPECT_EQ(DataFixture::generate(32), loaded.salt()); } TEST_F(SCryptParametersTest, N) { SCryptParameters cfg(Data(0), 1024, 0, 0); EXPECT_EQ(1024u, cfg.N()); } TEST_F(SCryptParametersTest, N_Move) { SCryptParameters cfg(Data(0), 1024, 0, 0); SCryptParameters moved = std::move(cfg); EXPECT_EQ(1024u, moved.N()); } TEST_F(SCryptParametersTest, N_SaveAndLoad) { SCryptParameters cfg(Data(0), 1024, 0, 0); SCryptParameters loaded = SaveAndLoad(cfg); EXPECT_EQ(1024u, loaded.N()); } TEST_F(SCryptParametersTest, r) { SCryptParameters cfg(Data(0), 0, 8, 0); EXPECT_EQ(8u, cfg.r()); } TEST_F(SCryptParametersTest, r_Move) { SCryptParameters cfg(Data(0), 0, 8, 0); SCryptParameters moved = std::move(cfg); EXPECT_EQ(8u, moved.r()); } TEST_F(SCryptParametersTest, r_SaveAndLoad) { SCryptParameters cfg(Data(0), 0, 8, 0); SCryptParameters loaded = SaveAndLoad(cfg); EXPECT_EQ(8u, loaded.r()); } TEST_F(SCryptParametersTest, p) { SCryptParameters cfg(Data(0), 0, 0, 16); EXPECT_EQ(16u, cfg.p()); } TEST_F(SCryptParametersTest, p_Move) { SCryptParameters cfg(Data(0), 0, 0, 16); SCryptParameters moved = std::move(cfg); EXPECT_EQ(16u, moved.p()); } TEST_F(SCryptParametersTest, p_SaveAndLoad) { SCryptParameters cfg(Data(0), 0, 0, 16); SCryptParameters loaded = SaveAndLoad(cfg); EXPECT_EQ(16u, loaded.p()); }test/cpp-utils/crypto/kdf/SCryptTest.cpp000066400000000000000000000052071300002025200206150ustar00rootroot00000000000000#include #include "cpp-utils/crypto/kdf/Scrypt.h" using namespace cpputils; using std::string; class SCryptTest : public ::testing::Test { public: unique_ref scryptForNewKey = SCrypt::forNewKey(SCrypt::TestSettings); unique_ref scryptForExistingKey = SCrypt::forExistingKey(scryptForNewKey->kdfParameters()); SCryptParameters kdfParameters(const SCrypt &scrypt) { SCryptParameters result = SCryptParameters::deserialize(scrypt.kdfParameters()); return result; } }; TEST_F(SCryptTest, GeneratedKeyIsReproductible_448) { auto derivedKey = scryptForNewKey->deriveKey<56>("mypassword"); auto rederivedKey = scryptForExistingKey->deriveKey<56>("mypassword"); EXPECT_EQ(derivedKey, rederivedKey); } TEST_F(SCryptTest, GeneratedKeyIsReproductible_256) { auto derivedKey = scryptForNewKey->deriveKey<32>("mypassword"); auto rederivedKey = scryptForExistingKey->deriveKey<32>("mypassword"); EXPECT_EQ(derivedKey, rederivedKey); } TEST_F(SCryptTest, GeneratedKeyIsReproductible_128) { auto derivedKey = scryptForNewKey->deriveKey<16>("mypassword"); auto rederivedKey = scryptForExistingKey->deriveKey<16>("mypassword"); EXPECT_EQ(derivedKey, rederivedKey); } TEST_F(SCryptTest, GeneratedKeyIsReproductible_DefaultSettings) { auto derivedKey = scryptForNewKey->deriveKey<16>("mypassword"); auto rederivedKey = scryptForExistingKey->deriveKey<16>("mypassword"); EXPECT_EQ(derivedKey, rederivedKey); } TEST_F(SCryptTest, DifferentPasswordResultsInDifferentKey) { auto derivedKey = scryptForNewKey->deriveKey<16>("mypassword"); auto rederivedKey = scryptForExistingKey->deriveKey<16>("mypassword2"); EXPECT_NE(derivedKey, rederivedKey); } TEST_F(SCryptTest, UsesCorrectSettings) { auto scrypt = SCrypt::forNewKey(SCrypt::TestSettings); auto derivedKey = scrypt->deriveKey<16>("mypassword"); SCryptParameters parameters = kdfParameters(*scrypt); EXPECT_EQ(SCrypt::TestSettings.SALT_LEN, parameters.salt().size()); EXPECT_EQ(SCrypt::TestSettings.N, parameters.N()); EXPECT_EQ(SCrypt::TestSettings.r, parameters.r()); EXPECT_EQ(SCrypt::TestSettings.p, parameters.p()); } TEST_F(SCryptTest, UsesCorrectDefaultSettings) { auto scrypt = SCrypt::forNewKey(SCrypt::DefaultSettings); auto derivedKey = scrypt->deriveKey<16>("mypassword"); SCryptParameters parameters = kdfParameters(*scrypt); EXPECT_EQ(SCrypt::DefaultSettings.SALT_LEN, parameters.salt().size()); EXPECT_EQ(SCrypt::DefaultSettings.N, parameters.N()); EXPECT_EQ(SCrypt::DefaultSettings.r, parameters.r()); EXPECT_EQ(SCrypt::DefaultSettings.p, parameters.p()); } test/cpp-utils/crypto/symmetric/000077500000000000000000000000001300002025200172715ustar00rootroot00000000000000test/cpp-utils/crypto/symmetric/CipherTest.cpp000066400000000000000000000256141300002025200220570ustar00rootroot00000000000000#include #include "cpp-utils/crypto/symmetric/Cipher.h" #include "cpp-utils/crypto/symmetric/ciphers.h" #include "testutils/FakeAuthenticatedCipher.h" #include "cpp-utils/data/DataFixture.h" #include "cpp-utils/data/Data.h" #include using namespace cpputils; using std::string; template class CipherTest: public ::testing::Test { public: BOOST_CONCEPT_ASSERT((CipherConcept)); typename Cipher::EncryptionKey encKey = createKeyFixture(); static typename Cipher::EncryptionKey createKeyFixture(int seed = 0) { Data data = DataFixture::generate(Cipher::EncryptionKey::BINARY_LENGTH, seed); return Cipher::EncryptionKey::FromBinary(data.data()); } void CheckEncryptThenDecryptIsIdentity(const Data &plaintext) { Data ciphertext = Encrypt(plaintext); Data decrypted = Decrypt(ciphertext); EXPECT_EQ(plaintext, decrypted); } void CheckEncryptIsIndeterministic(const Data &plaintext) { Data ciphertext = Encrypt(plaintext); Data ciphertext2 = Encrypt(plaintext); EXPECT_NE(ciphertext, ciphertext2); } void CheckEncryptedSize(const Data &plaintext) { Data ciphertext = Encrypt(plaintext); EXPECT_EQ(Cipher::ciphertextSize(plaintext.size()), ciphertext.size()); } void ExpectDoesntDecrypt(const Data &ciphertext) { auto decrypted = Cipher::decrypt((byte*)ciphertext.data(), ciphertext.size(), this->encKey); EXPECT_FALSE(decrypted); } Data Encrypt(const Data &plaintext) { return Cipher::encrypt((byte*)plaintext.data(), plaintext.size(), this->encKey); } Data Decrypt(const Data &ciphertext) { return Cipher::decrypt((byte*)ciphertext.data(), ciphertext.size(), this->encKey).value(); } static Data CreateZeroes(unsigned int size) { return std::move(Data(size).FillWithZeroes()); } static Data CreateData(unsigned int size, unsigned int seed = 0) { return DataFixture::generate(size, seed); } }; TYPED_TEST_CASE_P(CipherTest); constexpr std::initializer_list SIZES = {0, 1, 100, 1024, 5000, 1048576, 20971520}; TYPED_TEST_P(CipherTest, Size) { for (auto size: SIZES) { EXPECT_EQ(size, TypeParam::ciphertextSize(TypeParam::plaintextSize(size))); EXPECT_EQ(size, TypeParam::plaintextSize(TypeParam::ciphertextSize(size))); } } TYPED_TEST_P(CipherTest, EncryptThenDecrypt_Zeroes) { for (auto size: SIZES) { Data plaintext = this->CreateZeroes(size); this->CheckEncryptThenDecryptIsIdentity(plaintext); } } TYPED_TEST_P(CipherTest, EncryptThenDecrypt_Data) { for (auto size: SIZES) { Data plaintext = this->CreateData(size); this->CheckEncryptThenDecryptIsIdentity(plaintext); } } TYPED_TEST_P(CipherTest, EncryptIsIndeterministic_Zeroes) { for (auto size: SIZES) { Data plaintext = this->CreateZeroes(size); this->CheckEncryptIsIndeterministic(plaintext); } } TYPED_TEST_P(CipherTest, EncryptIsIndeterministic_Data) { for (auto size: SIZES) { Data plaintext = this->CreateData(size); this->CheckEncryptIsIndeterministic(plaintext); } } TYPED_TEST_P(CipherTest, EncryptedSize) { for (auto size: SIZES) { Data plaintext = this->CreateData(size); this->CheckEncryptedSize(plaintext); } } TYPED_TEST_P(CipherTest, TryDecryptDataThatIsTooSmall) { Data tooSmallCiphertext(TypeParam::ciphertextSize(0) - 1); this->ExpectDoesntDecrypt(tooSmallCiphertext); } TYPED_TEST_P(CipherTest, TryDecryptDataThatIsMuchTooSmall_0) { static_assert(TypeParam::ciphertextSize(0) > 0, "If this fails, the test case doesn't make sense."); Data tooSmallCiphertext(0); this->ExpectDoesntDecrypt(tooSmallCiphertext); } TYPED_TEST_P(CipherTest, TryDecryptDataThatIsMuchTooSmall_1) { static_assert(TypeParam::ciphertextSize(0) > 1, "If this fails, the test case doesn't make sense."); Data tooSmallCiphertext(1); this->ExpectDoesntDecrypt(tooSmallCiphertext); } REGISTER_TYPED_TEST_CASE_P(CipherTest, Size, EncryptThenDecrypt_Zeroes, EncryptThenDecrypt_Data, EncryptIsIndeterministic_Zeroes, EncryptIsIndeterministic_Data, EncryptedSize, TryDecryptDataThatIsTooSmall, TryDecryptDataThatIsMuchTooSmall_0, TryDecryptDataThatIsMuchTooSmall_1 ); template class AuthenticatedCipherTest: public CipherTest { public: Data zeroes1 = CipherTest::CreateZeroes(1); Data plaintext1 = CipherTest::CreateData(1); Data zeroes2 = CipherTest::CreateZeroes(100 * 1024); Data plaintext2 = CipherTest::CreateData(100 * 1024); }; TYPED_TEST_CASE_P(AuthenticatedCipherTest); TYPED_TEST_P(AuthenticatedCipherTest, ModifyFirstByte_Zeroes_Size1) { Data ciphertext = this->Encrypt(this->zeroes1); *(byte*)ciphertext.data() = *(byte*)ciphertext.data() + 1; this->ExpectDoesntDecrypt(ciphertext); } TYPED_TEST_P(AuthenticatedCipherTest, ModifyFirstByte_Data_Size1) { Data ciphertext = this->Encrypt(this->plaintext1); *(byte*)ciphertext.data() = *(byte*)ciphertext.data() + 1; this->ExpectDoesntDecrypt(ciphertext); } TYPED_TEST_P(AuthenticatedCipherTest, ModifyFirstByte_Zeroes) { Data ciphertext = this->Encrypt(this->zeroes2); *(byte*)ciphertext.data() = *(byte*)ciphertext.data() + 1; this->ExpectDoesntDecrypt(ciphertext); } TYPED_TEST_P(AuthenticatedCipherTest, ModifyFirstByte_Data) { Data ciphertext = this->Encrypt(this->plaintext2); *(byte*)ciphertext.data() = *(byte*)ciphertext.data() + 1; this->ExpectDoesntDecrypt(ciphertext); } TYPED_TEST_P(AuthenticatedCipherTest, ModifyLastByte_Zeroes) { Data ciphertext = this->Encrypt(this->zeroes2); ((byte*)ciphertext.data())[ciphertext.size() - 1] = ((byte*)ciphertext.data())[ciphertext.size() - 1] + 1; this->ExpectDoesntDecrypt(ciphertext); } TYPED_TEST_P(AuthenticatedCipherTest, ModifyLastByte_Data) { Data ciphertext = this->Encrypt(this->plaintext2); ((byte*)ciphertext.data())[ciphertext.size() - 1] = ((byte*)ciphertext.data())[ciphertext.size() - 1] + 1; this->ExpectDoesntDecrypt(ciphertext); } TYPED_TEST_P(AuthenticatedCipherTest, ModifyMiddleByte_Zeroes) { Data ciphertext = this->Encrypt(this->zeroes2); ((byte*)ciphertext.data())[ciphertext.size()/2] = ((byte*)ciphertext.data())[ciphertext.size()/2] + 1; this->ExpectDoesntDecrypt(ciphertext); } TYPED_TEST_P(AuthenticatedCipherTest, ModifyMiddleByte_Data) { Data ciphertext = this->Encrypt(this->plaintext2); ((byte*)ciphertext.data())[ciphertext.size()/2] = ((byte*)ciphertext.data())[ciphertext.size()/2] + 1; this->ExpectDoesntDecrypt(ciphertext); } TYPED_TEST_P(AuthenticatedCipherTest, TryDecryptZeroesData) { this->ExpectDoesntDecrypt(this->zeroes2); } TYPED_TEST_P(AuthenticatedCipherTest, TryDecryptRandomData) { this->ExpectDoesntDecrypt(this->plaintext2); } REGISTER_TYPED_TEST_CASE_P(AuthenticatedCipherTest, ModifyFirstByte_Zeroes_Size1, ModifyFirstByte_Zeroes, ModifyFirstByte_Data_Size1, ModifyFirstByte_Data, ModifyLastByte_Zeroes, ModifyLastByte_Data, ModifyMiddleByte_Zeroes, ModifyMiddleByte_Data, TryDecryptZeroesData, TryDecryptRandomData ); INSTANTIATE_TYPED_TEST_CASE_P(Fake, CipherTest, FakeAuthenticatedCipher); INSTANTIATE_TYPED_TEST_CASE_P(Fake, AuthenticatedCipherTest, FakeAuthenticatedCipher); INSTANTIATE_TYPED_TEST_CASE_P(AES256_CFB, CipherTest, AES256_CFB); //CFB mode is not authenticated INSTANTIATE_TYPED_TEST_CASE_P(AES256_GCM, CipherTest, AES256_GCM); INSTANTIATE_TYPED_TEST_CASE_P(AES256_GCM, AuthenticatedCipherTest, AES256_GCM); INSTANTIATE_TYPED_TEST_CASE_P(AES128_CFB, CipherTest, AES128_CFB); //CFB mode is not authenticated INSTANTIATE_TYPED_TEST_CASE_P(AES128_GCM, CipherTest, AES128_GCM); INSTANTIATE_TYPED_TEST_CASE_P(AES128_GCM, AuthenticatedCipherTest, AES128_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Twofish256_CFB, CipherTest, Twofish256_CFB); //CFB mode is not authenticated INSTANTIATE_TYPED_TEST_CASE_P(Twofish256_GCM, CipherTest, Twofish256_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Twofish256_GCM, AuthenticatedCipherTest, Twofish256_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Twofish128_CFB, CipherTest, Twofish128_CFB); //CFB mode is not authenticated INSTANTIATE_TYPED_TEST_CASE_P(Twofish128_GCM, CipherTest, Twofish128_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Twofish128_GCM, AuthenticatedCipherTest, Twofish128_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Serpent256_CFB, CipherTest, Serpent256_CFB); //CFB mode is not authenticated INSTANTIATE_TYPED_TEST_CASE_P(Serpent256_GCM, CipherTest, Serpent256_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Serpent256_GCM, AuthenticatedCipherTest, Serpent256_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Serpent128_CFB, CipherTest, Serpent128_CFB); //CFB mode is not authenticated INSTANTIATE_TYPED_TEST_CASE_P(Serpent128_GCM, CipherTest, Serpent128_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Serpent128_GCM, AuthenticatedCipherTest, Serpent128_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Cast256_CFB, CipherTest, Cast256_CFB); //CFB mode is not authenticated INSTANTIATE_TYPED_TEST_CASE_P(Cast256_GCM, CipherTest, Cast256_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Cast256_GCM, AuthenticatedCipherTest, Cast256_GCM); #if CRYPTOPP_VERSION != 564 INSTANTIATE_TYPED_TEST_CASE_P(Mars448_CFB, CipherTest, Mars448_CFB); //CFB mode is not authenticated INSTANTIATE_TYPED_TEST_CASE_P(Mars448_GCM, CipherTest, Mars448_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Mars448_GCM, AuthenticatedCipherTest, Mars448_GCM); #endif INSTANTIATE_TYPED_TEST_CASE_P(Mars256_CFB, CipherTest, Mars256_CFB); //CFB mode is not authenticated INSTANTIATE_TYPED_TEST_CASE_P(Mars256_GCM, CipherTest, Mars256_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Mars256_GCM, AuthenticatedCipherTest, Mars256_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Mars128_CFB, CipherTest, Mars128_CFB); //CFB mode is not authenticated INSTANTIATE_TYPED_TEST_CASE_P(Mars128_GCM, CipherTest, Mars128_GCM); INSTANTIATE_TYPED_TEST_CASE_P(Mars128_GCM, AuthenticatedCipherTest, Mars128_GCM); // Test cipher names TEST(CipherNameTest, TestCipherNames) { EXPECT_EQ("aes-256-gcm", string(AES256_GCM::NAME)); EXPECT_EQ("aes-256-cfb", string(AES256_CFB::NAME)); EXPECT_EQ("aes-128-gcm", string(AES128_GCM::NAME)); EXPECT_EQ("aes-128-cfb", string(AES128_CFB::NAME)); EXPECT_EQ("twofish-256-gcm", string(Twofish256_GCM::NAME)); EXPECT_EQ("twofish-256-cfb", string(Twofish256_CFB::NAME)); EXPECT_EQ("twofish-128-gcm", string(Twofish128_GCM::NAME)); EXPECT_EQ("twofish-128-cfb", string(Twofish128_CFB::NAME)); EXPECT_EQ("serpent-256-gcm", string(Serpent256_GCM::NAME)); EXPECT_EQ("serpent-256-cfb", string(Serpent256_CFB::NAME)); EXPECT_EQ("serpent-128-gcm", string(Serpent128_GCM::NAME)); EXPECT_EQ("serpent-128-cfb", string(Serpent128_CFB::NAME)); EXPECT_EQ("cast-256-gcm", string(Cast256_GCM::NAME)); EXPECT_EQ("cast-256-cfb", string(Cast256_CFB::NAME)); #if CRYPTOPP_VERSION != 564 EXPECT_EQ("mars-448-gcm", string(Mars448_GCM::NAME)); EXPECT_EQ("mars-448-cfb", string(Mars448_CFB::NAME)); #endif EXPECT_EQ("mars-256-gcm", string(Mars256_GCM::NAME)); EXPECT_EQ("mars-256-cfb", string(Mars256_CFB::NAME)); EXPECT_EQ("mars-128-gcm", string(Mars128_GCM::NAME)); EXPECT_EQ("mars-128-cfb", string(Mars128_CFB::NAME)); } test/cpp-utils/crypto/symmetric/testutils/000077500000000000000000000000001300002025200213315ustar00rootroot00000000000000test/cpp-utils/crypto/symmetric/testutils/FakeAuthenticatedCipher.cpp000066400000000000000000000001601300002025200265360ustar00rootroot00000000000000#include "FakeAuthenticatedCipher.h" namespace cpputils { constexpr unsigned int FakeKey::BINARY_LENGTH; } test/cpp-utils/crypto/symmetric/testutils/FakeAuthenticatedCipher.h000066400000000000000000000076601300002025200262170ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_TEST_CRYPTO_SYMMETRIC_TESTUTILS_FAKEAUTHENTICATEDCIPHER_H_ #define MESSMER_CPPUTILS_TEST_CRYPTO_SYMMETRIC_TESTUTILS_FAKEAUTHENTICATEDCIPHER_H_ #include "cpp-utils/crypto/symmetric/Cipher.h" #include "cpp-utils/data/FixedSizeData.h" #include "cpp-utils/data/Data.h" #include "cpp-utils/random/RandomGenerator.h" namespace cpputils { struct FakeKey { static FakeKey FromBinary(const void *data) { return FakeKey{*(uint8_t *) data}; } static constexpr unsigned int BINARY_LENGTH = 1; uint8_t value; }; // This is a fake cipher that uses an indeterministic caesar chiffre and a 4-byte parity for a simple authentication mechanism class FakeAuthenticatedCipher { public: BOOST_CONCEPT_ASSERT((CipherConcept)); using EncryptionKey = FakeKey; static EncryptionKey CreateKey(RandomGenerator &randomGenerator) { auto data = randomGenerator.getFixedSize<1>(); return FakeKey{*((uint8_t *) data.data())}; } static EncryptionKey Key1() { return FakeKey{5}; } static EncryptionKey Key2() { return FakeKey{63}; } static constexpr unsigned int ciphertextSize(unsigned int plaintextBlockSize) { return plaintextBlockSize + 5; } static constexpr unsigned int plaintextSize(unsigned int ciphertextBlockSize) { return ciphertextBlockSize - 5; } static Data encrypt(const byte *plaintext, unsigned int plaintextSize, const EncryptionKey &encKey) { Data result(ciphertextSize(plaintextSize)); //Add a random IV uint8_t iv = rand(); std::memcpy(result.data(), &iv, 1); //Use caesar chiffre on plaintext _caesar((byte *) result.data() + 1, plaintext, plaintextSize, encKey.value + iv); //Add parity information int32_t parity = _parity((byte *) result.data(), plaintextSize + 1); std::memcpy((byte *) result.data() + plaintextSize + 1, &parity, 4); return result; } static boost::optional decrypt(const byte *ciphertext, unsigned int ciphertextSize, const EncryptionKey &encKey) { //We need at least 5 bytes (iv + parity) if (ciphertextSize < 5) { return boost::none; } //Check parity int32_t expectedParity = _parity(ciphertext, plaintextSize(ciphertextSize) + 1); int32_t actualParity = *(int32_t * )(ciphertext + plaintextSize(ciphertextSize) + 1); if (expectedParity != actualParity) { return boost::none; } //Decrypt caesar chiffre from ciphertext int32_t iv = *(int32_t *) ciphertext; Data result(plaintextSize(ciphertextSize)); _caesar((byte *) result.data(), ciphertext + 1, plaintextSize(ciphertextSize), -(encKey.value + iv)); return std::move(result); } static constexpr const char *NAME = "FakeAuthenticatedCipher"; private: static int32_t _parity(const byte *data, unsigned int size) { int32_t parity = 34343435; // some init value const int32_t *intData = reinterpret_cast(data); unsigned int intSize = size / sizeof(int32_t); for (unsigned int i = 0; i < intSize; ++i) { parity = ((int64_t)parity) + intData[i]; } unsigned int remainingBytes = size - 4 * intSize; for (unsigned int i = 0; i < remainingBytes; ++i) { parity = ((int64_t)parity) + (data[4 * intSize + i] << (24 - 8 * i)); } return parity; } static void _caesar(byte *dst, const byte *src, unsigned int size, uint8_t key) { for (unsigned int i = 0; i < size; ++i) { dst[i] = src[i] + key; } } }; } #endif test/cpp-utils/data/000077500000000000000000000000001300002025200146465ustar00rootroot00000000000000test/cpp-utils/data/DataFixtureIncludeTest.cpp000066400000000000000000000001631300002025200217360ustar00rootroot00000000000000#include "cpp-utils/data/DataFixture.h" // Test the header can be included without needing additional dependenciestest/cpp-utils/data/DataFixtureTest.cpp000066400000000000000000000045551300002025200204430ustar00rootroot00000000000000#include #include "cpp-utils/data/Data.h" #include "cpp-utils/data/DataFixture.h" using ::testing::Test; using ::testing::WithParamInterface; using ::testing::Values; namespace bf = boost::filesystem; using namespace cpputils; class DataFixtureTest: public Test { }; TEST_F(DataFixtureTest, CreateEmptyFixture) { Data data = DataFixture::generate(0); EXPECT_EQ(0u, data.size()); } TEST_F(DataFixtureTest, CreateOneByteFixture) { Data data = DataFixture::generate(1); EXPECT_EQ(1u, data.size()); } TEST_F(DataFixtureTest, CreateLargerFixture) { Data data = DataFixture::generate(20 * 1024 * 1024); EXPECT_EQ(20u * 1024u * 1024u, data.size()); } TEST_F(DataFixtureTest, FixturesAreDeterministic_DefaultSeed) { Data data1 = DataFixture::generate(1024 * 1024); Data data2 = DataFixture::generate(1024 * 1024); EXPECT_EQ(data1, data2); } TEST_F(DataFixtureTest, FixturesAreDeterministic_SeedIs5) { Data data1 = DataFixture::generate(1024 * 1024, 5); Data data2 = DataFixture::generate(1024 * 1024, 5); EXPECT_EQ(data1, data2); } TEST_F(DataFixtureTest, DifferentSeedIsDifferentFixture) { Data data1 = DataFixture::generate(1024 * 1024, 0); Data data2 = DataFixture::generate(1024 * 1024, 1); EXPECT_NE(data1, data2); } TEST_F(DataFixtureTest, FixturesAreDeterministic_DifferentSize_DefaultSeed_1) { Data data1 = DataFixture::generate(1024); Data data2 = DataFixture::generate(1); EXPECT_EQ(0, std::memcmp(data1.data(), data2.data(), 1)); } TEST_F(DataFixtureTest, FixturesAreDeterministic_DifferentSize_DefaultSeed_2) { Data data1 = DataFixture::generate(1024); Data data2 = DataFixture::generate(501); //Intentionally not 64bit-aligned, because the generate() function generates 64bit values for performance EXPECT_EQ(0, std::memcmp(data1.data(), data2.data(), 501)); } TEST_F(DataFixtureTest, FixturesAreDeterministic_DifferentSize_SeedIs5_1) { Data data1 = DataFixture::generate(1024, 5); Data data2 = DataFixture::generate(1, 5); EXPECT_EQ(0, std::memcmp(data1.data(), data2.data(), 1)); } TEST_F(DataFixtureTest, FixturesAreDeterministic_DifferentSize_SeedIs5_2) { Data data1 = DataFixture::generate(1024, 5); Data data2 = DataFixture::generate(501, 5); //Intentionally not 64bit-aligned, because the generate() function generates 64bit values for performance EXPECT_EQ(0, std::memcmp(data1.data(), data2.data(), 501)); } test/cpp-utils/data/DataIncludeTest.cpp000066400000000000000000000001541300002025200203670ustar00rootroot00000000000000#include "cpp-utils/data/Data.h" // Test the header can be included without needing additional dependenciestest/cpp-utils/data/DataTest.cpp000066400000000000000000000131501300002025200170630ustar00rootroot00000000000000#include "cpp-utils/data/DataFixture.h" #include "cpp-utils/data/Data.h" #include #include "cpp-utils/tempfile/TempFile.h" #include using ::testing::Test; using ::testing::WithParamInterface; using ::testing::Values; using cpputils::TempFile; using std::ifstream; using std::ofstream; namespace bf = boost::filesystem; using namespace cpputils; class DataTest: public Test { public: bool DataIsZeroes(const Data &data) { for (size_t i = 0; i != data.size(); ++ i) { if (((char*)data.data())[i] != 0) { return false; } } return true; } }; class DataTestWithSizeParam: public DataTest, public WithParamInterface { public: Data randomData; DataTestWithSizeParam(): randomData(DataFixture::generate(GetParam())) {} static void StoreData(const Data &data, const bf::path &filepath) { ofstream file(filepath.c_str(), std::ios::binary | std::ios::trunc); file.write((char*)data.data(), data.size()); } static void EXPECT_STORED_FILE_DATA_CORRECT(const Data &data, const bf::path &filepath) { EXPECT_EQ(data.size(), bf::file_size(filepath)); ifstream file(filepath.c_str(), std::ios::binary); char *read_data = new char[data.size()]; file.read(read_data, data.size()); EXPECT_EQ(0, std::memcmp(data.data(), read_data, data.size())); delete[] read_data; } }; INSTANTIATE_TEST_CASE_P(DataTestWithSizeParam, DataTestWithSizeParam, Values(0, 1, 2, 1024, 4096, 10*1024*1024)); TEST_P(DataTestWithSizeParam, ZeroInitializedDataIsDifferentToRandomData) { if (GetParam() != 0) { Data data(GetParam()); data.FillWithZeroes(); EXPECT_NE(randomData, data); } } // Working on a large data area without a crash is a good indicator that we // are actually working on memory that was validly allocated for us. TEST_P(DataTestWithSizeParam, WriteAndCheck) { Data data = randomData.copy(); EXPECT_EQ(randomData, data); } TEST_P(DataTestWithSizeParam, Size) { Data data(GetParam()); EXPECT_EQ(GetParam(), data.size()); } TEST_P(DataTestWithSizeParam, CheckStoredFile) { TempFile file; randomData.StoreToFile(file.path()); EXPECT_STORED_FILE_DATA_CORRECT(randomData, file.path()); } TEST_P(DataTestWithSizeParam, CheckLoadedData) { TempFile file; StoreData(randomData, file.path()); Data data = Data::LoadFromFile(file.path()).value(); EXPECT_EQ(randomData, data); } TEST_P(DataTestWithSizeParam, StoreDoesntChangeData) { Data data = randomData.copy(); TempFile file; data.StoreToFile(file.path()); EXPECT_EQ(randomData, data); } TEST_P(DataTestWithSizeParam, StoreAndLoad) { TempFile file; randomData.StoreToFile(file.path()); Data loaded_data = Data::LoadFromFile(file.path()).value(); EXPECT_EQ(randomData, loaded_data); } TEST_P(DataTestWithSizeParam, Copy) { Data copy = randomData.copy(); EXPECT_EQ(randomData, copy); } TEST_F(DataTest, ChangingCopyDoesntChangeOriginal) { Data original = DataFixture::generate(1024); Data copy = original.copy(); ((uint8_t*)copy.data())[0] = ((uint8_t*)copy.data())[0] + 1; EXPECT_EQ(DataFixture::generate(1024), original); EXPECT_NE(copy, original); } TEST_F(DataTest, InitializeWithZeroes) { Data data(10*1024); data.FillWithZeroes(); EXPECT_TRUE(DataIsZeroes(data)); } TEST_F(DataTest, FillModifiedDataWithZeroes) { Data data = DataFixture::generate(10*1024); EXPECT_FALSE(DataIsZeroes(data)); data.FillWithZeroes(); EXPECT_TRUE(DataIsZeroes(data)); } TEST_F(DataTest, MoveConstructor) { Data original = DataFixture::generate(1024); Data copy(std::move(original)); EXPECT_EQ(DataFixture::generate(1024), copy); EXPECT_EQ(nullptr, original.data()); EXPECT_EQ(0u, original.size()); } TEST_F(DataTest, MoveAssignment) { Data original = DataFixture::generate(1024); Data copy(0); copy = std::move(original); EXPECT_EQ(DataFixture::generate(1024), copy); EXPECT_EQ(nullptr, original.data()); EXPECT_EQ(0u, original.size()); } TEST_F(DataTest, Equality) { Data data1 = DataFixture::generate(1024); Data data2 = DataFixture::generate(1024); EXPECT_TRUE(data1 == data2); EXPECT_FALSE(data1 != data2); } TEST_F(DataTest, Inequality_DifferentSize) { Data data1 = DataFixture::generate(1024); Data data2 = DataFixture::generate(1023); EXPECT_FALSE(data1 == data2); EXPECT_TRUE(data1 != data2); } TEST_F(DataTest, Inequality_DifferentFirstByte) { Data data1 = DataFixture::generate(1024); Data data2 = DataFixture::generate(1024); ((uint8_t*)data2.data())[0] = ((uint8_t*)data2.data())[0] + 1; EXPECT_FALSE(data1 == data2); EXPECT_TRUE(data1 != data2); } TEST_F(DataTest, Inequality_DifferentMiddleByte) { Data data1 = DataFixture::generate(1024); Data data2 = DataFixture::generate(1024); ((uint8_t*)data2.data())[500] = ((uint8_t*)data2.data())[500] + 1; EXPECT_FALSE(data1 == data2); EXPECT_TRUE(data1 != data2); } TEST_F(DataTest, Inequality_DifferentLastByte) { Data data1 = DataFixture::generate(1024); Data data2 = DataFixture::generate(1024); ((uint8_t*)data2.data())[1023] = ((uint8_t*)data2.data())[1023] + 1; EXPECT_FALSE(data1 == data2); EXPECT_TRUE(data1 != data2); } #ifdef __x86_64__ TEST_F(DataTest, LargesizeSize) { //Needs 64bit for representation. This value isn't in the size param list, because the list is also used for read/write checks. uint64_t size = 4.5L*1024*1024*1024; Data data(size); EXPECT_EQ(size, data.size()); } #else #warning This is not a 64bit architecture. Large size data tests are disabled. #endif TEST_F(DataTest, LoadingNonexistingFile) { TempFile file(false); // Pass false to constructor, so the tempfile is not created EXPECT_FALSE(Data::LoadFromFile(file.path())); } test/cpp-utils/data/FixedSizeDataIncludeTest.cpp000066400000000000000000000001651300002025200222040ustar00rootroot00000000000000#include "cpp-utils/data/FixedSizeData.h" // Test the header can be included without needing additional dependenciestest/cpp-utils/data/FixedSizeDataTest.cpp000066400000000000000000000157771300002025200207170ustar00rootroot00000000000000#include "cpp-utils/data/DataFixture.h" #include "cpp-utils/data/FixedSizeData.h" #include "cpp-utils/data/Data.h" #include using ::testing::Test; using ::testing::WithParamInterface; using ::testing::Values; using std::string; using namespace cpputils; class FixedSizeDataTest: public Test { public: static constexpr size_t SIZE = 16; const string DATA1_AS_STRING = "1491BB4932A389EE14BC7090AC772972"; const string DATA2_AS_STRING = "272EE5517627CFA147A971A8E6E747E0"; const Data DATA3_AS_BINARY; const Data DATA4_AS_BINARY; FixedSizeDataTest() : DATA3_AS_BINARY(DataFixture::generate(SIZE, 1)), DATA4_AS_BINARY(DataFixture::generate(SIZE, 2)) {} template void EXPECT_DATA_EQ(const Data &expected, const FixedSizeData &actual) { EXPECT_EQ(expected.size(), SIZE); EXPECT_EQ(0, std::memcmp(expected.data(), actual.data(), SIZE)); } }; constexpr size_t FixedSizeDataTest::SIZE; TEST_F(FixedSizeDataTest, EqualsTrue) { FixedSizeData DATA1_1 = FixedSizeData::FromString(DATA1_AS_STRING); FixedSizeData DATA1_2 = FixedSizeData::FromString(DATA1_AS_STRING); EXPECT_TRUE(DATA1_1 == DATA1_2); EXPECT_TRUE(DATA1_2 == DATA1_1); } TEST_F(FixedSizeDataTest, EqualsFalse) { FixedSizeData DATA1_1 = FixedSizeData::FromString(DATA1_AS_STRING); FixedSizeData DATA2_1 = FixedSizeData::FromString(DATA2_AS_STRING); EXPECT_FALSE(DATA1_1 == DATA2_1); EXPECT_FALSE(DATA2_1 == DATA1_1); } TEST_F(FixedSizeDataTest, NotEqualsFalse) { FixedSizeData DATA1_1 = FixedSizeData::FromString(DATA1_AS_STRING); FixedSizeData DATA1_2 = FixedSizeData::FromString(DATA1_AS_STRING); EXPECT_FALSE(DATA1_1 != DATA1_2); EXPECT_FALSE(DATA1_2 != DATA1_1); } TEST_F(FixedSizeDataTest, NotEqualsTrue) { FixedSizeData DATA1_1 = FixedSizeData::FromString(DATA1_AS_STRING); FixedSizeData DATA2_1 = FixedSizeData::FromString(DATA2_AS_STRING); EXPECT_TRUE(DATA1_1 != DATA2_1); EXPECT_TRUE(DATA2_1 != DATA1_1); } class FixedSizeDataTestWithStringParam: public FixedSizeDataTest, public WithParamInterface {}; INSTANTIATE_TEST_CASE_P(FixedSizeDataTestWithStringParam, FixedSizeDataTestWithStringParam, Values("2898B4B8A13CA63CBE0F0278CCE465DB", "6FFEBAD90C0DAA2B79628F0627CE9841")); TEST_P(FixedSizeDataTestWithStringParam, FromAndToString) { FixedSizeData data = FixedSizeData::FromString(GetParam()); EXPECT_EQ(GetParam(), data.ToString()); } TEST_P(FixedSizeDataTestWithStringParam, ToAndFromString) { FixedSizeData data = FixedSizeData::FromString(GetParam()); FixedSizeData data2 = FixedSizeData::FromString(data.ToString()); EXPECT_EQ(data, data2); } class FixedSizeDataTestWithBinaryParam: public FixedSizeDataTest, public WithParamInterface { public: static const Data VALUE1; static const Data VALUE2; }; const Data FixedSizeDataTestWithBinaryParam::VALUE1(DataFixture::generate(SIZE, 3)); const Data FixedSizeDataTestWithBinaryParam::VALUE2(DataFixture::generate(SIZE, 4)); INSTANTIATE_TEST_CASE_P(FixedSizeDataTestWithBinaryParam, FixedSizeDataTestWithBinaryParam, Values(&FixedSizeDataTestWithBinaryParam::VALUE1, &FixedSizeDataTestWithBinaryParam::VALUE2)); TEST_P(FixedSizeDataTestWithBinaryParam, FromBinary) { FixedSizeData data = FixedSizeData::FromBinary((uint8_t*)GetParam()->data()); EXPECT_DATA_EQ(*GetParam(), data); } TEST_P(FixedSizeDataTestWithBinaryParam, FromAndToBinary) { FixedSizeData data = FixedSizeData::FromBinary((uint8_t*)GetParam()->data()); Data output(FixedSizeData::BINARY_LENGTH); data.ToBinary(output.data()); EXPECT_EQ(*GetParam(), output); } TEST_P(FixedSizeDataTestWithBinaryParam, ToAndFromBinary) { FixedSizeData data = FixedSizeData::FromBinary((uint8_t*)GetParam()->data()); Data stored(FixedSizeData::BINARY_LENGTH); data.ToBinary(stored.data()); FixedSizeData loaded = FixedSizeData::FromBinary(stored.data()); EXPECT_EQ(data, loaded); } class FixedSizeDataTestWithParam: public FixedSizeDataTest, public WithParamInterface> {}; INSTANTIATE_TEST_CASE_P(FixedSizeDataTestWithParam, FixedSizeDataTestWithParam, Values(FixedSizeData::FromString("2898B4B8A13CA63CBE0F0278CCE465DB"), FixedSizeData::FromString("6FFEBAD90C0DAA2B79628F0627CE9841"))); TEST_P(FixedSizeDataTestWithParam, CopyConstructor) { FixedSizeData copy(GetParam()); EXPECT_EQ(GetParam(), copy); } TEST_P(FixedSizeDataTestWithParam, Take_Half) { FixedSizeData source(GetParam()); FixedSizeData taken = source.take(); EXPECT_EQ(0, std::memcmp(source.data(), taken.data(), SIZE/2)); } TEST_P(FixedSizeDataTestWithParam, Drop_Half) { FixedSizeData source(GetParam()); FixedSizeData taken = source.drop(); EXPECT_EQ(0, std::memcmp(source.data() + SIZE/2, taken.data(), SIZE/2)); } TEST_P(FixedSizeDataTestWithParam, Take_One) { FixedSizeData source(GetParam()); FixedSizeData<1> taken = source.take<1>(); EXPECT_EQ(0, std::memcmp(source.data(), taken.data(), 1)); } TEST_P(FixedSizeDataTestWithParam, Drop_One) { FixedSizeData source(GetParam()); FixedSizeData taken = source.drop<1>(); EXPECT_EQ(0, std::memcmp(source.data() + 1, taken.data(), SIZE-1)); } TEST_P(FixedSizeDataTestWithParam, Take_Nothing) { FixedSizeData source(GetParam()); FixedSizeData<0> taken = source.take<0>(); } TEST_P(FixedSizeDataTestWithParam, Drop_Nothing) { FixedSizeData source(GetParam()); FixedSizeData taken = source.drop<0>(); EXPECT_EQ(0, std::memcmp(source.data(), taken.data(), SIZE)); } TEST_P(FixedSizeDataTestWithParam, Take_All) { FixedSizeData source(GetParam()); FixedSizeData taken = source.take(); EXPECT_EQ(0, std::memcmp(source.data(), taken.data(), SIZE)); } TEST_P(FixedSizeDataTestWithParam, Drop_All) { FixedSizeData source(GetParam()); FixedSizeData<0> taken = source.drop(); } TEST_F(FixedSizeDataTest, CopyConstructorDoesntChangeSource) { FixedSizeData data1 = FixedSizeData::FromString(DATA1_AS_STRING); FixedSizeData data2(data1); EXPECT_EQ(DATA1_AS_STRING, data1.ToString()); } TEST_P(FixedSizeDataTestWithParam, IsEqualAfterAssignment1) { FixedSizeData data2 = FixedSizeData::FromString(DATA2_AS_STRING); EXPECT_NE(GetParam(), data2); data2 = GetParam(); EXPECT_EQ(GetParam(), data2); } TEST_F(FixedSizeDataTest, AssignmentDoesntChangeSource) { FixedSizeData data1 = FixedSizeData::FromString(DATA1_AS_STRING); FixedSizeData data2 = FixedSizeData::FromString(DATA2_AS_STRING); data2 = data1; EXPECT_EQ(DATA1_AS_STRING, data1.ToString()); } // This tests that a FixedSizeData object is very lightweight // (it is meant to be kept on stack and passed around) TEST_F(FixedSizeDataTest, IsLightweightObject) { EXPECT_EQ(FixedSizeData::BINARY_LENGTH, sizeof(FixedSizeData)); } test/cpp-utils/io/000077500000000000000000000000001300002025200143445ustar00rootroot00000000000000test/cpp-utils/io/ConsoleIncludeTest.cpp000066400000000000000000000001561300002025200206200ustar00rootroot00000000000000#include "cpp-utils/io/Console.h" // Test the header can be included without needing additional dependencies test/cpp-utils/io/ConsoleTest.h000066400000000000000000000045111300002025200167600ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_TEST_IO_CONSOLETEST_H #define MESSMER_CPPUTILS_TEST_IO_CONSOLETEST_H #include #include "cpp-utils/io/IOStreamConsole.h" #include #include #include "cpp-utils/io/pipestream.h" class ConsoleThread { public: ConsoleThread(std::ostream &ostr, std::istream &istr): _console(ostr, istr) {} std::future ask(const std::string &question, const std::vector &options) { return std::async(std::launch::async, [this, question, options]() { return _console.ask(question, options); }); } std::future askYesNo(const std::string &question) { return std::async(std::launch::async, [this, question]() { return _console.askYesNo(question, true); }); } void print(const std::string &output) { _console.print(output); } private: cpputils::IOStreamConsole _console; }; class ConsoleTest: public ::testing::Test { public: ConsoleTest(): _inputStr(), _outputStr(), _input(&_inputStr), _output(&_outputStr), _console(_output, _input) {} void EXPECT_OUTPUT_LINES(std::initializer_list lines) { for (const std::string &line : lines) { EXPECT_OUTPUT_LINE(line); } } void EXPECT_OUTPUT_LINE(const std::string &expected, char delimiter = '\n', const std::string &expected_after_delimiter = "") { std::string actual; std::getline(_output, actual, delimiter); EXPECT_EQ(expected, actual); for (char expected_char : expected_after_delimiter) { char actual_char; _output.get(actual_char); EXPECT_EQ(expected_char, actual_char); } } void sendInputLine(const std::string &line) { _input << line << "\n" << std::flush; } std::future ask(const std::string &question, const std::vector &options) { return _console.ask(question, options); } std::future askYesNo(const std::string &question) { return _console.askYesNo(question); } void print(const std::string &output) { _console.print(output); } private: cpputils::pipestream _inputStr; cpputils::pipestream _outputStr; std::iostream _input; std::iostream _output; ConsoleThread _console; }; #endif test/cpp-utils/io/ConsoleTest_Ask.cpp000066400000000000000000000124771300002025200201230ustar00rootroot00000000000000#include "ConsoleTest.h" using std::stringstream; using std::string; using std::vector; using std::istream; using std::ostream; using std::future; using std::initializer_list; class ConsoleTest_Ask: public ConsoleTest {}; TEST_F(ConsoleTest_Ask, CrashesWithoutOptions) { EXPECT_THROW( (ask("My Question?", {}).get()), std::invalid_argument ); } TEST_F(ConsoleTest_Ask, OneOption) { auto chosen = ask("My Question?", {"First Option"}); EXPECT_OUTPUT_LINES({ "My Question?", " [1] First Option" }); EXPECT_OUTPUT_LINE("Your choice [1-1]", ':', " "); sendInputLine("1"); EXPECT_EQ(0u, chosen.get()); } TEST_F(ConsoleTest_Ask, TwoOptions_ChooseFirst) { auto chosen = ask("My Question?", {"First Option", "Second Option"}); EXPECT_OUTPUT_LINES({ "My Question?", " [1] First Option", " [2] Second Option" }); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("1"); EXPECT_EQ(0u, chosen.get()); } TEST_F(ConsoleTest_Ask, TwoOptions_ChooseSecond) { auto chosen = ask("My Question?", {"First Option", "Second Option"}); EXPECT_OUTPUT_LINES({ "My Question?", " [1] First Option", " [2] Second Option" }); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("2"); EXPECT_EQ(1u, chosen.get()); } TEST_F(ConsoleTest_Ask, ThreeOptions_ChooseFirst) { auto chosen = ask("My Other Question?", {"1st Option", "2nd Option", "3rd Option"}); EXPECT_OUTPUT_LINES({ "My Other Question?", " [1] 1st Option", " [2] 2nd Option", " [3] 3rd Option" }); EXPECT_OUTPUT_LINE("Your choice [1-3]", ':', " "); sendInputLine("1"); EXPECT_EQ(0u, chosen.get()); } TEST_F(ConsoleTest_Ask, ThreeOptions_ChooseSecond) { auto chosen = ask("My Question?", {"1st Option", "2nd Option", "3rd Option"}); EXPECT_OUTPUT_LINES({ "My Question?", " [1] 1st Option", " [2] 2nd Option", " [3] 3rd Option" }); EXPECT_OUTPUT_LINE("Your choice [1-3]", ':', " "); sendInputLine("2"); EXPECT_EQ(1u, chosen.get()); } TEST_F(ConsoleTest_Ask, ThreeOptions_ChooseThird) { auto chosen = ask("My Question?", {"1st Option", "2nd Option", "3rd Option"}); EXPECT_OUTPUT_LINES({ "My Question?", " [1] 1st Option", " [2] 2nd Option", " [3] 3rd Option" }); EXPECT_OUTPUT_LINE("Your choice [1-3]", ':', " "); sendInputLine("3"); EXPECT_EQ(2u, chosen.get()); } TEST_F(ConsoleTest_Ask, InputWithLeadingSpaces) { auto chosen = ask("My Question?", {"First Option", "Second Option"}); EXPECT_OUTPUT_LINES({ "My Question?", " [1] First Option", " [2] Second Option" }); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine(" 2"); EXPECT_EQ(1u, chosen.get()); } TEST_F(ConsoleTest_Ask, InputWithFollowingSpaces) { auto chosen = ask("My Question?", {"First Option", "Second Option"}); EXPECT_OUTPUT_LINES({ "My Question?", " [1] First Option", " [2] Second Option" }); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("2 "); EXPECT_EQ(1u, chosen.get()); } TEST_F(ConsoleTest_Ask, InputWithLeadingAndFollowingSpaces) { auto chosen = ask("My Question?", {"First Option", "Second Option"}); EXPECT_OUTPUT_LINES({ "My Question?", " [1] First Option", " [2] Second Option" }); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine(" 2 "); EXPECT_EQ(1u, chosen.get()); } TEST_F(ConsoleTest_Ask, InputEmptyLine) { auto chosen = ask("My Question?", {"First Option", "Second Option"}); EXPECT_OUTPUT_LINES({ "My Question?", " [1] First Option", " [2] Second Option" }); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine(""); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine(" "); // empty line with space EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("2"); EXPECT_EQ(1u, chosen.get()); } TEST_F(ConsoleTest_Ask, InputWrongNumbers) { auto chosen = ask("My Question?", {"1st Option", "2nd Option"}); EXPECT_OUTPUT_LINES({ "My Question?", " [1] 1st Option", " [2] 2nd Option", }); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("0"); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("-1"); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("3"); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("1.5"); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("1,5"); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("2"); EXPECT_EQ(1u, chosen.get()); } TEST_F(ConsoleTest_Ask, InputNonNumbers) { auto chosen = ask("My Question?", {"1st Option", "2nd Option"}); EXPECT_OUTPUT_LINES({ "My Question?", " [1] 1st Option", " [2] 2nd Option", }); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("abc"); EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("3a"); // Wrong number and string attached EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("1a"); // Right number but string attached EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("a3"); // Wrong number and string attached EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("a1"); // Right number but string attached EXPECT_OUTPUT_LINE("Your choice [1-2]", ':', " "); sendInputLine("2"); EXPECT_EQ(1u, chosen.get()); }test/cpp-utils/io/ConsoleTest_AskYesNo.cpp000066400000000000000000000062431300002025200210730ustar00rootroot00000000000000#include "ConsoleTest.h" using std::string; class ConsoleTest_AskYesNo: public ConsoleTest { public: void EXPECT_TRUE_ON_INPUT(const string &input) { EXPECT_RESULT_ON_INPUT(true, input); } void EXPECT_FALSE_ON_INPUT(const string &input) { EXPECT_RESULT_ON_INPUT(false, input); } void EXPECT_RESULT_ON_INPUT(const bool expected, const string &input) { auto chosen = askYesNo("Are you sure blablub?"); EXPECT_OUTPUT_LINES({"Are you sure blablub?"}); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine(input); EXPECT_EQ(expected, chosen.get()); } }; TEST_F(ConsoleTest_AskYesNo, Input_Yes) { EXPECT_TRUE_ON_INPUT("Yes"); } TEST_F(ConsoleTest_AskYesNo, Input_yes) { EXPECT_TRUE_ON_INPUT("yes"); } TEST_F(ConsoleTest_AskYesNo, Input_Y) { EXPECT_TRUE_ON_INPUT("Y"); } TEST_F(ConsoleTest_AskYesNo, Input_y) { EXPECT_TRUE_ON_INPUT("y"); } TEST_F(ConsoleTest_AskYesNo, Input_No) { EXPECT_FALSE_ON_INPUT("No"); } TEST_F(ConsoleTest_AskYesNo, Input_no) { EXPECT_FALSE_ON_INPUT("no"); } TEST_F(ConsoleTest_AskYesNo, Input_N) { EXPECT_FALSE_ON_INPUT("N"); } TEST_F(ConsoleTest_AskYesNo, Input_n) { EXPECT_FALSE_ON_INPUT("n"); } TEST_F(ConsoleTest_AskYesNo, InputWithLeadingSpaces) { EXPECT_TRUE_ON_INPUT(" y"); } TEST_F(ConsoleTest_AskYesNo, InputWithFollowingSpaces) { EXPECT_TRUE_ON_INPUT("y "); } TEST_F(ConsoleTest_AskYesNo, InputWithLeadingAndFollowingSpaces) { EXPECT_TRUE_ON_INPUT(" y "); } TEST_F(ConsoleTest_AskYesNo, InputEmptyLine) { auto chosen = askYesNo("My Question?"); EXPECT_OUTPUT_LINES({"My Question?"}); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine(""); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine(" "); // empty line with space EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("y"); EXPECT_EQ(true, chosen.get()); } TEST_F(ConsoleTest_AskYesNo, WrongInput) { auto chosen = askYesNo("My Question?"); EXPECT_OUTPUT_LINES({"My Question?"}); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("0"); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("1"); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("bla"); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("Y_andsomethingelse"); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("y_andsomethingelse"); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("N_andsomethingelse"); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("n_andsomethingelse"); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("Yes_andsomethingelse"); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("yes_andsomethingelse"); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("No_andsomethingelse"); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("no_andsomethingelse"); EXPECT_OUTPUT_LINE("Your choice [y/n]", ':', " "); sendInputLine("y"); EXPECT_EQ(true, chosen.get()); } test/cpp-utils/io/ConsoleTest_Print.cpp000066400000000000000000000002341300002025200204650ustar00rootroot00000000000000#include "ConsoleTest.h" TEST_F(ConsoleTest, Print) { print("Bla Blub"); EXPECT_OUTPUT_LINE("Bla Blu", 'b'); // 'b' is the delimiter for reading } test/cpp-utils/lock/000077500000000000000000000000001300002025200146655ustar00rootroot00000000000000test/cpp-utils/lock/ConditionBarrierIncludeTest.cpp000066400000000000000000000001711300002025200227710ustar00rootroot00000000000000#include "cpp-utils/lock/ConditionBarrier.h" // Test the header can be included without needing additional dependencies test/cpp-utils/lock/LockPoolIncludeTest.cpp000066400000000000000000000001611300002025200212550ustar00rootroot00000000000000#include "cpp-utils/lock/LockPool.h" // Test the header can be included without needing additional dependencies test/cpp-utils/lock/MutexPoolLockIncludeTest.cpp000066400000000000000000000001661300002025200223050ustar00rootroot00000000000000#include "cpp-utils/lock/MutexPoolLock.h" // Test the header can be included without needing additional dependencies test/cpp-utils/logging/000077500000000000000000000000001300002025200153635ustar00rootroot00000000000000test/cpp-utils/logging/LoggerIncludeTest.cpp000066400000000000000000000001621300002025200214510ustar00rootroot00000000000000#include "cpp-utils/logging/Logger.h" // Test the header can be included without needing additional dependencies test/cpp-utils/logging/LoggerTest.cpp000066400000000000000000000006611300002025200201510ustar00rootroot00000000000000#include "testutils/LoggingTest.h" /* * Contains test cases for the Logger class */ using namespace cpputils::logging; using std::string; using testing::MatchesRegex; class LoggerTest: public LoggingTest {}; TEST_F(LoggerTest, IsSingleton) { ASSERT_EQ(&logger(), &logger()); } TEST_F(LoggerTest, SetLogger) { logger().setLogger(spdlog::stderr_logger_mt("MyTestLog1")); EXPECT_EQ("MyTestLog1", logger()->name()); } test/cpp-utils/logging/LoggingIncludeTest.cpp000066400000000000000000000001631300002025200216210ustar00rootroot00000000000000#include "cpp-utils/logging/logging.h" // Test the header can be included without needing additional dependencies test/cpp-utils/logging/LoggingLevelTest.cpp000066400000000000000000000071311300002025200213070ustar00rootroot00000000000000#include "testutils/LoggingTest.h" using namespace cpputils::logging; using std::string; using testing::MatchesRegex; class LoggingLevelTest: public LoggingTest { public: void EXPECT_DEBUG_LOG_ENABLED() { LOG(DEBUG) << "My log message"; EXPECT_THAT(mockLogger.capturedLog(), MatchesRegex(".*\\[MockLogger\\].*\\[debug\\].*My log message.*")); } void EXPECT_DEBUG_LOG_DISABLED() { LOG(DEBUG) << "My log message"; EXPECT_EQ("", mockLogger.capturedLog()); } void EXPECT_INFO_LOG_ENABLED() { LOG(INFO) << "My log message"; EXPECT_THAT(mockLogger.capturedLog(), MatchesRegex(".*\\[MockLogger\\].*\\[info\\].*My log message.*")); } void EXPECT_INFO_LOG_DISABLED() { LOG(INFO) << "My log message"; EXPECT_EQ("", mockLogger.capturedLog()); } void EXPECT_WARNING_LOG_ENABLED() { LOG(WARN) << "My log message"; EXPECT_THAT(mockLogger.capturedLog(), MatchesRegex(".*\\[MockLogger\\].*\\[warning\\].*My log message.*")); } void EXPECT_WARNING_LOG_DISABLED() { LOG(WARN) << "My log message"; EXPECT_EQ("", mockLogger.capturedLog()); } void EXPECT_ERROR_LOG_ENABLED() { LOG(ERROR) << "My log message"; EXPECT_THAT(mockLogger.capturedLog(), MatchesRegex(".*\\[MockLogger\\].*\\[error\\].*My log message.*")); } void EXPECT_ERROR_LOG_DISABLED() { LOG(ERROR) << "My log message"; EXPECT_EQ("", mockLogger.capturedLog()); } }; TEST_F(LoggingLevelTest, DefaultLevelIsInfo) { setLogger(mockLogger.get()); EXPECT_DEBUG_LOG_DISABLED(); EXPECT_INFO_LOG_ENABLED(); EXPECT_WARNING_LOG_ENABLED(); EXPECT_ERROR_LOG_ENABLED(); } TEST_F(LoggingLevelTest, DEBUG_SetBeforeSettingLogger) { setLevel(DEBUG); setLogger(mockLogger.get()); EXPECT_DEBUG_LOG_ENABLED(); EXPECT_INFO_LOG_ENABLED(); EXPECT_WARNING_LOG_ENABLED(); EXPECT_ERROR_LOG_ENABLED(); } TEST_F(LoggingLevelTest, DEBUG_SetAfterSettingLogger) { setLogger(mockLogger.get()); setLevel(DEBUG); EXPECT_DEBUG_LOG_ENABLED(); EXPECT_INFO_LOG_ENABLED(); EXPECT_WARNING_LOG_ENABLED(); EXPECT_ERROR_LOG_ENABLED(); } TEST_F(LoggingLevelTest, INFO_SetBeforeSettingLogger) { setLevel(INFO); setLogger(mockLogger.get()); EXPECT_DEBUG_LOG_DISABLED(); EXPECT_INFO_LOG_ENABLED(); EXPECT_WARNING_LOG_ENABLED(); EXPECT_ERROR_LOG_ENABLED(); } TEST_F(LoggingLevelTest, INFO_SetAfterSettingLogger) { setLogger(mockLogger.get()); setLevel(INFO); EXPECT_DEBUG_LOG_DISABLED(); EXPECT_INFO_LOG_ENABLED(); EXPECT_WARNING_LOG_ENABLED(); EXPECT_ERROR_LOG_ENABLED(); } TEST_F(LoggingLevelTest, WARNING_SetBeforeSettingLogger) { setLevel(WARN); setLogger(mockLogger.get()); EXPECT_DEBUG_LOG_DISABLED(); EXPECT_INFO_LOG_DISABLED(); EXPECT_WARNING_LOG_ENABLED(); EXPECT_ERROR_LOG_ENABLED(); } TEST_F(LoggingLevelTest, WARNING_SetAfterSettingLogger) { setLogger(mockLogger.get()); setLevel(WARN); EXPECT_DEBUG_LOG_DISABLED(); EXPECT_INFO_LOG_DISABLED(); EXPECT_WARNING_LOG_ENABLED(); EXPECT_ERROR_LOG_ENABLED(); } TEST_F(LoggingLevelTest, ERROR_SetBeforeSettingLogger) { setLevel(ERROR); setLogger(mockLogger.get()); EXPECT_DEBUG_LOG_DISABLED(); EXPECT_INFO_LOG_DISABLED(); EXPECT_WARNING_LOG_DISABLED(); EXPECT_ERROR_LOG_ENABLED(); } TEST_F(LoggingLevelTest, ERROR_SetAfterSettingLogger) { setLogger(mockLogger.get()); setLevel(ERROR); EXPECT_DEBUG_LOG_DISABLED(); EXPECT_INFO_LOG_DISABLED(); EXPECT_WARNING_LOG_DISABLED(); EXPECT_ERROR_LOG_ENABLED(); } test/cpp-utils/logging/LoggingTest.cpp000066400000000000000000000047371300002025200203300ustar00rootroot00000000000000#include "testutils/LoggingTest.h" /* * Contains test cases for the following logging interface: * LOG(INFO) << "My log message" */ using namespace cpputils::logging; using std::string; using testing::MatchesRegex; TEST_F(LoggingTest, DefaultLoggerIsStderr) { string output = captureStderr([]{ LOG(INFO) << "My log message"; }); EXPECT_THAT(output, MatchesRegex(".*\\[Log\\].*\\[info\\].*My log message.*")); } TEST_F(LoggingTest, SetLogger_NewLoggerIsUsed) { setLogger(spdlog::stderr_logger_mt("MyTestLog2")); string output = captureStderr([]{ LOG(INFO) << "My log message"; }); EXPECT_THAT(output, MatchesRegex(".*\\[MyTestLog2\\].*\\[info\\].*My log message.*")); } TEST_F(LoggingTest, SetNonStderrLogger_LogsToNewLogger) { setLogger(mockLogger.get()); logger()->info() << "My log message"; EXPECT_THAT(mockLogger.capturedLog(), MatchesRegex(".*\\[MockLogger\\].*\\[info\\].*My log message.*")); } TEST_F(LoggingTest, SetNonStderrLogger_DoesNotLogToStderr) { setLogger(mockLogger.get()); string output = captureStderr([] { logger()->info() << "My log message"; }); EXPECT_EQ("", output); } TEST_F(LoggingTest, InfoLog) { setLogger(mockLogger.get()); LOG(INFO) << "My log message"; EXPECT_THAT(mockLogger.capturedLog(), MatchesRegex(".*\\[MockLogger\\].*\\[info\\].*My log message.*")); } TEST_F(LoggingTest, WarningLog) { setLogger(mockLogger.get()); LOG(WARN) << "My log message"; EXPECT_THAT(mockLogger.capturedLog(), MatchesRegex(".*\\[MockLogger\\].*\\[warning\\].*My log message.*")); } TEST_F(LoggingTest, DebugLog) { setLevel(DEBUG); setLogger(mockLogger.get()); LOG(DEBUG) << "My log message"; EXPECT_THAT(mockLogger.capturedLog(), MatchesRegex(".*\\[MockLogger\\].*\\[debug\\].*My log message.*")); } TEST_F(LoggingTest, ErrorLog) { setLogger(mockLogger.get()); LOG(ERROR) << "My log message"; EXPECT_THAT(mockLogger.capturedLog(), MatchesRegex(".*\\[MockLogger\\].*\\[error\\].*My log message.*")); } void logAndExit(const string &message) { LOG(INFO) << message; exit(1); } // fork() only forks the main thread. This test ensures that logging doesn't depend on threads that suddenly aren't // there anymore after a fork(). TEST_F(LoggingTest, LoggingAlsoWorksAfterFork) { setLogger(spdlog::stderr_logger_mt("StderrLogger")); EXPECT_EXIT( logAndExit("My log message"), ::testing::ExitedWithCode(1), "My log message" ); } test/cpp-utils/logging/testutils/000077500000000000000000000000001300002025200174235ustar00rootroot00000000000000test/cpp-utils/logging/testutils/LoggingTest.h000066400000000000000000000023321300002025200220220ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CPPUTILS_TEST_LOGGING_TESTUTILS_LOGGINGTEST_H #define MESSMER_CPPUTILS_TEST_LOGGING_TESTUTILS_LOGGINGTEST_H #include #include #include "cpp-utils/logging/logging.h" class MockLogger final { public: MockLogger(): _capturedLogData(), _sink(std::make_shared>(_capturedLogData, true)), _logger(spdlog::create("MockLogger", {_sink})) { } ~MockLogger() { spdlog::drop("MockLogger"); }; std::shared_ptr get() { return _logger; } std::string capturedLog() const { return _capturedLogData.str(); } private: std::ostringstream _capturedLogData; std::shared_ptr> _sink; std::shared_ptr _logger; }; class LoggingTest: public ::testing::Test { public: LoggingTest(): mockLogger() {} std::string captureStderr(std::function func) { testing::internal::CaptureStderr(); func(); return testing::internal::GetCapturedStderr(); } ~LoggingTest() { cpputils::logging::reset(); } MockLogger mockLogger; }; #endif test/cpp-utils/network/000077500000000000000000000000001300002025200154265ustar00rootroot00000000000000test/cpp-utils/network/CurlHttpClientTest.cpp000066400000000000000000000017241300002025200217020ustar00rootroot00000000000000#include #include #include "cpp-utils/network/CurlHttpClient.h" #include "cpp-utils/pointer/unique_ref_boost_optional_gtest_workaround.h" using std::string; using boost::none; using testing::MatchesRegex; using namespace cpputils; TEST(CurlHttpClientTest, InvalidProtocol) { EXPECT_EQ(none, CurlHttpClient().get("invalid://example.com")); } TEST(CurlHttpClientTest, InvalidTld) { EXPECT_EQ(none, CurlHttpClient().get("http://example.invalidtld")); } TEST(CurlHttpClientTest, InvalidDomain) { EXPECT_EQ(none, CurlHttpClient().get("http://this_is_a_not_existing_domain.com")); } TEST(CurlHttpClientTest, ValidHttp) { string content = CurlHttpClient().get("http://example.com").value(); EXPECT_THAT(content, MatchesRegex(".*Example Domain.*")); } TEST(CurlHttpClientTest, ValidHttps) { string content = CurlHttpClient().get("https://example.com").value(); EXPECT_THAT(content, MatchesRegex(".*Example Domain.*")); } test/cpp-utils/network/FakeHttpClientTest.cpp000066400000000000000000000026271300002025200216460ustar00rootroot00000000000000#include #include "cpp-utils/network/FakeHttpClient.h" #include "cpp-utils/pointer/unique_ref_boost_optional_gtest_workaround.h" using boost::none; using namespace cpputils; TEST(FakeHttpClientTest, Empty) { EXPECT_EQ(none, FakeHttpClient().get("http://example.com")); } TEST(FakeHttpClientTest, Nonexisting) { FakeHttpClient client; client.addWebsite("http://existing.com", "content"); EXPECT_EQ(none, client.get("http://notexisting.com")); } TEST(FakeHttpClientTest, Existing) { FakeHttpClient client; client.addWebsite("http://existing.com", "content"); EXPECT_EQ("content", client.get("http://existing.com").value()); } TEST(FakeHttpClientTest, TwoExisting) { FakeHttpClient client; client.addWebsite("http://firstexisting.com", "first_content"); client.addWebsite("http://secondexisting.com", "second_content"); EXPECT_EQ("first_content", client.get("http://firstexisting.com").value()); EXPECT_EQ("second_content", client.get("http://secondexisting.com").value()); EXPECT_EQ(none, client.get("http://notexisting.com")); } TEST(FakeHttpClientTest, Overwriting) { FakeHttpClient client; client.addWebsite("http://existing.com", "content"); client.addWebsite("http://existing.com", "new_content"); EXPECT_EQ("new_content", client.get("http://existing.com").value()); } test/cpp-utils/pointer/000077500000000000000000000000001300002025200154155ustar00rootroot00000000000000test/cpp-utils/pointer/cast_include_test.cpp000066400000000000000000000001601300002025200216120ustar00rootroot00000000000000#include "cpp-utils/pointer/cast.h" // Test the header can be included without needing additional dependencies test/cpp-utils/pointer/cast_test.cpp000066400000000000000000000144551300002025200201230ustar00rootroot00000000000000#include #include #include "cpp-utils/pointer/cast.h" #include "cpp-utils/pointer/unique_ref.h" #include "cpp-utils/pointer/unique_ref_boost_optional_gtest_workaround.h" //TODO There is a lot of duplication here, because each test case is there twice - once for unique_ptr, once for unique_ref. Remove redundancy by using generic test cases. //TODO Then also move the unique_ref related test cases there - cast_test.cpp should only contain the unique_ptr related ones. using namespace cpputils; using std::unique_ptr; using std::make_unique; using boost::optional; using boost::none; class DestructorCallback { public: MOCK_CONST_METHOD0(call, void()); }; class Parent { public: virtual ~Parent() { } }; class Child : public Parent { public: Child(const DestructorCallback *childDestructorCallback) : _destructorCallback(childDestructorCallback) { } Child(): Child(nullptr) {} ~Child() { if (_destructorCallback != nullptr) { _destructorCallback->call(); } } private: const DestructorCallback *_destructorCallback; DISALLOW_COPY_AND_ASSIGN(Child); }; class Child2 : public Parent {}; TEST(UniquePtr_DynamicPointerMoveTest, NullPtrParentToChildCast) { unique_ptr source(nullptr); unique_ptr casted = dynamic_pointer_move(source); EXPECT_EQ(nullptr, source.get()); EXPECT_EQ(nullptr, casted.get()); } TEST(UniquePtr_DynamicPointerMoveTest, NullPtrChildToParentCast) { unique_ptr source(nullptr); unique_ptr casted = dynamic_pointer_move(source); EXPECT_EQ(nullptr, source.get()); EXPECT_EQ(nullptr, casted.get()); } TEST(UniquePtr_DynamicPointerMoveTest, NullPtrSelfCast) { unique_ptr source(nullptr); unique_ptr casted = dynamic_pointer_move(source); EXPECT_EQ(nullptr, source.get()); EXPECT_EQ(nullptr, casted.get()); } TEST(UniqueRef_DynamicPointerMoveTest, ValidParentToChildCast) { Child *obj = new Child(); unique_ref source(nullcheck(unique_ptr(obj)).value()); unique_ref casted = dynamic_pointer_move(source).value(); EXPECT_EQ(nullptr, source.get()); // source lost ownership EXPECT_EQ(obj, casted.get()); } TEST(UniquePtr_DynamicPointerMoveTest, ValidParentToChildCast) { Child *obj = new Child(); unique_ptr source(obj); unique_ptr casted = dynamic_pointer_move(source); EXPECT_EQ(nullptr, source.get()); // source lost ownership EXPECT_EQ(obj, casted.get()); } TEST(UniqueRef_DynamicPointerMoveTest, InvalidParentToChildCast1) { Parent *obj = new Parent(); unique_ref source(nullcheck(unique_ptr(obj)).value()); optional> casted = dynamic_pointer_move(source); EXPECT_EQ(obj, source.get()); // source still has ownership EXPECT_EQ(none, casted); } TEST(UniquePtr_DynamicPointerMoveTest, InvalidParentToChildCast1) { Parent *obj = new Parent(); unique_ptr source(obj); unique_ptr casted = dynamic_pointer_move(source); EXPECT_EQ(obj, source.get()); // source still has ownership EXPECT_EQ(nullptr, casted.get()); } TEST(UniqueRef_DynamicPointerMoveTest, InvalidParentToChildCast2) { Child2 *obj = new Child2(); unique_ref source(nullcheck(unique_ptr(obj)).value()); optional> casted = dynamic_pointer_move(source); EXPECT_EQ(obj, source.get()); // source still has ownership EXPECT_EQ(none, casted); } TEST(UniquePtr_DynamicPointerMoveTest, InvalidParentToChildCast2) { Child2 *obj = new Child2(); unique_ptr source(obj); unique_ptr casted = dynamic_pointer_move(source); EXPECT_EQ(obj, source.get()); // source still has ownership EXPECT_EQ(nullptr, casted.get()); } TEST(UniqueRef_DynamicPointerMoveTest, ChildToParentCast) { Child *obj = new Child(); unique_ref source(nullcheck(unique_ptr(obj)).value()); unique_ref casted = dynamic_pointer_move(source).value(); EXPECT_EQ(nullptr, source.get()); // source lost ownership EXPECT_EQ(obj, casted.get()); } TEST(UniquePtr_DynamicPointerMoveTest, ChildToParentCast) { Child *obj = new Child(); unique_ptr source(obj); unique_ptr casted = dynamic_pointer_move(source); EXPECT_EQ(nullptr, source.get()); // source lost ownership EXPECT_EQ(obj, casted.get()); } class UniqueRef_DynamicPointerMoveDestructorTest: public ::testing::Test { public: UniqueRef_DynamicPointerMoveDestructorTest(): childDestructorCallback() {} DestructorCallback childDestructorCallback; unique_ref createChild() { return make_unique_ref(&childDestructorCallback); } void EXPECT_CHILD_DESTRUCTOR_CALLED() { EXPECT_CALL(childDestructorCallback, call()).Times(1); } }; class UniquePtr_DynamicPointerMoveDestructorTest: public ::testing::Test { public: UniquePtr_DynamicPointerMoveDestructorTest(): childDestructorCallback() {} DestructorCallback childDestructorCallback; unique_ptr createChild() { return make_unique(&childDestructorCallback); } void EXPECT_CHILD_DESTRUCTOR_CALLED() { EXPECT_CALL(childDestructorCallback, call()).Times(1); } }; TEST_F(UniqueRef_DynamicPointerMoveDestructorTest, ChildInParentPtr) { unique_ref parent = createChild(); EXPECT_CHILD_DESTRUCTOR_CALLED(); } TEST_F(UniquePtr_DynamicPointerMoveDestructorTest, ChildInParentPtr) { unique_ptr parent = createChild(); EXPECT_CHILD_DESTRUCTOR_CALLED(); } TEST_F(UniqueRef_DynamicPointerMoveDestructorTest, ChildToParentCast) { unique_ref child = createChild(); unique_ref parent = dynamic_pointer_move(child).value(); EXPECT_CHILD_DESTRUCTOR_CALLED(); } TEST_F(UniquePtr_DynamicPointerMoveDestructorTest, ChildToParentCast) { unique_ptr child = createChild(); unique_ptr parent = dynamic_pointer_move(child); EXPECT_CHILD_DESTRUCTOR_CALLED(); } TEST_F(UniqueRef_DynamicPointerMoveDestructorTest, ParentToChildCast) { unique_ref parent = createChild(); unique_ref child = dynamic_pointer_move(parent).value(); EXPECT_CHILD_DESTRUCTOR_CALLED(); } TEST_F(UniquePtr_DynamicPointerMoveDestructorTest, ParentToChildCast) { unique_ptr parent = createChild(); unique_ptr child = dynamic_pointer_move(parent); EXPECT_CHILD_DESTRUCTOR_CALLED(); } test/cpp-utils/pointer/optional_ownership_ptr_include_test.cpp000066400000000000000000000002021300002025200254650ustar00rootroot00000000000000#include "cpp-utils/pointer/optional_ownership_ptr.h" // Test the header can be included without needing additional dependencies test/cpp-utils/pointer/optional_ownership_ptr_test.cpp000066400000000000000000000064551300002025200240020ustar00rootroot00000000000000#include #include "cpp-utils/pointer/optional_ownership_ptr.h" #include "cpp-utils/macros.h" using std::unique_ptr; using std::function; using ::testing::Test; using namespace cpputils; class TestObject { public: TestObject(function destructorListener) : _destructorListener(destructorListener) {} virtual ~TestObject() { _destructorListener(); } private: function _destructorListener; }; class TestObjectHolder { public: TestObjectHolder() : _isDestructed(false), _testObject(new TestObject([this]() {_isDestructed = true;})) { } ~TestObjectHolder() { if (!_isDestructed) { delete _testObject; _isDestructed = true; } } TestObject *get() { return _testObject; } bool isDestructed() { return _isDestructed; } private: bool _isDestructed; TestObject *_testObject; DISALLOW_COPY_AND_ASSIGN(TestObjectHolder); }; class OptionalOwnershipPointerTest: public Test { public: OptionalOwnershipPointerTest(): obj(), obj2() {} TestObjectHolder obj; TestObjectHolder obj2; }; TEST_F(OptionalOwnershipPointerTest, TestIsInitializedCorrectly) { EXPECT_FALSE(obj.isDestructed()); } TEST_F(OptionalOwnershipPointerTest, DestructsWhenItHasOwnership_UniquePtr) { { optional_ownership_ptr ptr = WithOwnership(unique_ptr(obj.get())); EXPECT_FALSE(obj.isDestructed()); UNUSED(ptr); } EXPECT_TRUE(obj.isDestructed()); } TEST_F(OptionalOwnershipPointerTest, DestructsWhenItHasOwnership_UniqueRef) { { optional_ownership_ptr ptr = WithOwnership(cpputils::nullcheck(unique_ptr(obj.get())).value()); EXPECT_FALSE(obj.isDestructed()); UNUSED(ptr); } EXPECT_TRUE(obj.isDestructed()); } TEST_F(OptionalOwnershipPointerTest, DestructsWhenItHasOwnershipAfterAssignment) { { optional_ownership_ptr ptr = WithoutOwnership(obj.get()); ptr = WithOwnership(unique_ptr(obj2.get())); } EXPECT_FALSE(obj.isDestructed()); EXPECT_TRUE(obj2.isDestructed()); } TEST_F(OptionalOwnershipPointerTest, DoesntDestructWhenItDoesntHaveOwnership) { { optional_ownership_ptr ptr = WithoutOwnership(obj.get()); UNUSED(ptr); } EXPECT_FALSE(obj.isDestructed()); } TEST_F(OptionalOwnershipPointerTest, DoesntDestructWhenItDoesntHaveOwnershipAfterAssignment) { { optional_ownership_ptr ptr = WithOwnership(unique_ptr(obj.get())); ptr = WithoutOwnership(obj2.get()); EXPECT_TRUE(obj.isDestructed()); } EXPECT_FALSE(obj2.isDestructed()); } TEST_F(OptionalOwnershipPointerTest, DestructsOnReassignmentWithNull) { optional_ownership_ptr ptr = WithOwnership(unique_ptr(obj.get())); ptr = null(); EXPECT_TRUE(obj.isDestructed()); } TEST_F(OptionalOwnershipPointerTest, DoesntCrashWhenDestructingNullptr1) { optional_ownership_ptr ptr = null(); UNUSED(ptr); } TEST_F(OptionalOwnershipPointerTest, DoesntCrashWhenDestructingNullptrWithoutOwnership) { optional_ownership_ptr ptr = WithoutOwnership((TestObject*)nullptr); UNUSED(ptr); } TEST_F(OptionalOwnershipPointerTest, DoesntCrashWhenDestructingNullptrWithOwnership) { optional_ownership_ptr ptr = WithOwnership(unique_ptr(nullptr)); UNUSED(ptr); } test/cpp-utils/pointer/unique_ref_boost_optional_gtest_workaround_include_test.cpp000066400000000000000000000002261300002025200316210ustar00rootroot00000000000000#include "cpp-utils/pointer/unique_ref_boost_optional_gtest_workaround.h" // Test the header can be included without needing additional dependencies test/cpp-utils/pointer/unique_ref_include_test.cpp000066400000000000000000000001661300002025200230300ustar00rootroot00000000000000#include "cpp-utils/pointer/unique_ref.h" // Test the header can be included without needing additional dependencies test/cpp-utils/pointer/unique_ref_test.cpp000066400000000000000000000327421300002025200213320ustar00rootroot00000000000000#include #include "cpp-utils/pointer/unique_ref.h" #include #include #include #include #include using namespace cpputils; //TODO Test unique_ref destructor //TODO Test cpputils::destruct() class SomeClass0Parameters {}; class SomeClass1Parameter { public: SomeClass1Parameter(int param_): param(param_) {} int param; }; class SomeClass2Parameters { public: SomeClass2Parameters(int param1_, int param2_): param1(param1_), param2(param2_) {} int param1; int param2; }; using SomeClass = SomeClass0Parameters; TEST(MakeUniqueRefTest, Primitive) { unique_ref var = make_unique_ref(3); EXPECT_EQ(3, *var); } TEST(MakeUniqueRefTest, ClassWith0Parameters) { unique_ref var = make_unique_ref(); //Check that the type is correct EXPECT_EQ(var.get(), dynamic_cast(var.get())); } TEST(MakeUniqueRefTest, ClassWith1Parameter) { unique_ref var = make_unique_ref(5); EXPECT_EQ(5, var->param); } TEST(MakeUniqueRefTest, ClassWith2Parameters) { unique_ref var = make_unique_ref(7,2); EXPECT_EQ(7, var->param1); EXPECT_EQ(2, var->param2); } TEST(MakeUniqueRefTest, TypeIsAutoDeductible) { auto var1 = make_unique_ref(3); auto var2 = make_unique_ref(); auto var3 = make_unique_ref(2); auto var4 = make_unique_ref(2, 3); } TEST(NullcheckTest, PrimitiveNullptr) { boost::optional> var = nullcheck(std::unique_ptr(nullptr)); EXPECT_FALSE((bool)var); } TEST(NullcheckTest, ObjectNullptr) { boost::optional> var = nullcheck(std::unique_ptr(nullptr)); EXPECT_FALSE((bool)var); } TEST(NullcheckTest, Primitive) { boost::optional> var = nullcheck(std::make_unique(3)); EXPECT_TRUE((bool)var); EXPECT_EQ(3, **var); } TEST(NullcheckTest, ClassWith0Parameters) { boost::optional> var = nullcheck(std::make_unique()); EXPECT_TRUE((bool)var); //Check that the type is correct EXPECT_EQ(var->get(), dynamic_cast(var->get())); } TEST(NullcheckTest, ClassWith1Parameter) { boost::optional> var = nullcheck(std::make_unique(5)); EXPECT_TRUE((bool)var); EXPECT_EQ(5, (*var)->param); } TEST(NullcheckTest, ClassWith2Parameters) { boost::optional> var = nullcheck(std::make_unique(7,2)); EXPECT_TRUE((bool)var); EXPECT_EQ(7, (*var)->param1); EXPECT_EQ(2, (*var)->param2); } TEST(NullcheckTest, OptionIsResolvable_Primitive) { boost::optional> var = nullcheck(std::make_unique(3)); unique_ref resolved = std::move(var).value(); } TEST(NullcheckTest, OptionIsResolvable_Object) { boost::optional> var = nullcheck(std::make_unique()); unique_ref resolved = std::move(var).value(); } TEST(NullcheckTest, OptionIsAutoResolvable_Primitive) { auto var = nullcheck(std::make_unique(3)); auto resolved = std::move(var).value(); } TEST(NullcheckTest, OptionIsAutoResolvable_Object) { auto var = nullcheck(std::make_unique()); auto resolved = std::move(var).value(); } class UniqueRefTest: public ::testing::Test { public: template void makeInvalid(unique_ref ref) { UNUSED(ref); //ref is moved in here and then destructed } }; TEST_F(UniqueRefTest, Get_Primitive) { unique_ref obj = make_unique_ref(3); EXPECT_EQ(3, *obj.get()); } TEST_F(UniqueRefTest, Get_Object) { unique_ref obj = make_unique_ref(5); EXPECT_EQ(5, obj.get()->param); } TEST_F(UniqueRefTest, Deref_Primitive) { unique_ref obj = make_unique_ref(3); EXPECT_EQ(3, *obj); } TEST_F(UniqueRefTest, Deref_Object) { unique_ref obj = make_unique_ref(5); EXPECT_EQ(5, (*obj).param); } TEST_F(UniqueRefTest, DerefArrow) { unique_ref obj = make_unique_ref(3); EXPECT_EQ(3, obj->param); } TEST_F(UniqueRefTest, Assignment) { unique_ref obj1 = make_unique_ref(); unique_ref obj2 = make_unique_ref(); SomeClass *obj1ptr = obj1.get(); obj2 = std::move(obj1); EXPECT_EQ(obj1ptr, obj2.get()); EXPECT_EQ(nullptr, obj1.get()); } TEST_F(UniqueRefTest, MoveConstructor) { unique_ref obj1 = make_unique_ref(); SomeClass *obj1ptr = obj1.get(); unique_ref obj2 = std::move(obj1); EXPECT_EQ(obj1ptr, obj2.get()); EXPECT_EQ(nullptr, obj1.get()); } TEST_F(UniqueRefTest, Swap) { unique_ref obj1 = make_unique_ref(); unique_ref obj2 = make_unique_ref(); SomeClass *obj1ptr = obj1.get(); SomeClass *obj2ptr = obj2.get(); std::swap(obj1, obj2); EXPECT_EQ(obj2ptr, obj1.get()); EXPECT_EQ(obj1ptr, obj2.get()); } TEST_F(UniqueRefTest, SwapFromInvalid) { unique_ref obj1 = make_unique_ref(); makeInvalid(std::move(obj1)); unique_ref obj2 = make_unique_ref(); SomeClass *obj2ptr = obj2.get(); std::swap(obj1, obj2); EXPECT_EQ(obj2ptr, obj1.get()); EXPECT_EQ(nullptr, obj2.get()); } TEST_F(UniqueRefTest, SwapWithInvalid) { unique_ref obj1 = make_unique_ref(); unique_ref obj2 = make_unique_ref(); makeInvalid(std::move(obj2)); SomeClass *obj1ptr = obj1.get(); std::swap(obj1, obj2); EXPECT_EQ(nullptr, obj1.get()); EXPECT_EQ(obj1ptr, obj2.get()); } TEST_F(UniqueRefTest, SwapInvalidWithInvalid) { unique_ref obj1 = make_unique_ref(); unique_ref obj2 = make_unique_ref(); makeInvalid(std::move(obj1)); makeInvalid(std::move(obj2)); std::swap(obj1, obj2); EXPECT_EQ(nullptr, obj1.get()); EXPECT_EQ(nullptr, obj2.get()); } TEST_F(UniqueRefTest, SwapFromRValue) { unique_ref obj1 = make_unique_ref(); unique_ref obj2 = make_unique_ref(); SomeClass *obj1ptr = obj1.get(); SomeClass *obj2ptr = obj2.get(); std::swap(std::move(obj1), obj2); EXPECT_EQ(obj2ptr, obj1.get()); EXPECT_EQ(obj1ptr, obj2.get()); } TEST_F(UniqueRefTest, SwapWithRValue) { unique_ref obj1 = make_unique_ref(); unique_ref obj2 = make_unique_ref(); SomeClass *obj1ptr = obj1.get(); SomeClass *obj2ptr = obj2.get(); std::swap(obj1, std::move(obj2)); EXPECT_EQ(obj2ptr, obj1.get()); EXPECT_EQ(obj1ptr, obj2.get()); } TEST_F(UniqueRefTest, CanBePutInContainer_Primitive) { std::vector> vec; vec.push_back(make_unique_ref(3)); EXPECT_EQ(3, *vec[0]); } TEST_F(UniqueRefTest, CanBePutInContainer_Object) { std::vector> vec; vec.push_back(make_unique_ref(5)); EXPECT_EQ(5, vec[0]->param); } TEST_F(UniqueRefTest, CanBePutInContainer_Nullcheck) { std::vector> vec; vec.push_back(*nullcheck(std::make_unique(3))); EXPECT_EQ(3, *vec[0]); } TEST_F(UniqueRefTest, CanBePutInSet_Primitive) { std::set> set; set.insert(make_unique_ref(3)); EXPECT_EQ(3, **set.begin()); } TEST_F(UniqueRefTest, CanBePutInSet_Object) { std::set> set; set.insert(make_unique_ref(5)); EXPECT_EQ(5, (*set.begin())->param); } TEST_F(UniqueRefTest, CanBePutInSet_Nullcheck) { std::set> set; set.insert(*nullcheck(std::make_unique(3))); EXPECT_EQ(3, **set.begin()); } TEST_F(UniqueRefTest, CanBePutInUnorderedSet_Primitive) { std::unordered_set> set; set.insert(make_unique_ref(3)); EXPECT_EQ(3, **set.begin()); } TEST_F(UniqueRefTest, CanBePutInUnorderedSet_Object) { std::unordered_set> set; set.insert(make_unique_ref(5)); EXPECT_EQ(5, (*set.begin())->param); } TEST_F(UniqueRefTest, CanBePutInUnorderedSet_Nullcheck) { std::unordered_set> set; set.insert(*nullcheck(std::make_unique(3))); EXPECT_EQ(3, **set.begin()); } TEST_F(UniqueRefTest, CanBePutInMap_Primitive) { std::map, unique_ref> map; map.insert(std::make_pair(make_unique_ref(3), make_unique_ref(5))); EXPECT_EQ(3, *map.begin()->first); EXPECT_EQ(5, *map.begin()->second); } TEST_F(UniqueRefTest, CanBePutInMap_Object) { std::map, unique_ref> map; map.insert(std::make_pair(make_unique_ref(5), make_unique_ref(3))); EXPECT_EQ(5, map.begin()->first->param); EXPECT_EQ(3, map.begin()->second->param); } TEST_F(UniqueRefTest, CanBePutInMap_Nullcheck) { std::map, unique_ref> map; map.insert(std::make_pair(*nullcheck(std::make_unique(3)), *nullcheck(std::make_unique(5)))); EXPECT_EQ(3, *map.begin()->first); EXPECT_EQ(5, *map.begin()->second); } TEST_F(UniqueRefTest, CanBePutInUnorderedMap_Primitive) { std::unordered_map, unique_ref> map; map.insert(std::make_pair(make_unique_ref(3), make_unique_ref(5))); EXPECT_EQ(3, *map.begin()->first); EXPECT_EQ(5, *map.begin()->second); } TEST_F(UniqueRefTest, CanBePutInUnorderedMap_Object) { std::unordered_map, unique_ref> map; map.insert(std::make_pair(make_unique_ref(5), make_unique_ref(3))); EXPECT_EQ(5, map.begin()->first->param); EXPECT_EQ(3, map.begin()->second->param); } TEST_F(UniqueRefTest, CanBePutInUnorderedMap_Nullcheck) { std::unordered_map, unique_ref> map; map.insert(std::make_pair(*nullcheck(std::make_unique(3)), *nullcheck(std::make_unique(5)))); EXPECT_EQ(3, *map.begin()->first); EXPECT_EQ(5, *map.begin()->second); } TEST_F(UniqueRefTest, Equality_Nullptr) { unique_ref var1 = make_unique_ref(3); unique_ref var2 = make_unique_ref(4); makeInvalid(std::move(var1)); makeInvalid(std::move(var2)); EXPECT_TRUE(var1 == var2); EXPECT_FALSE(var1 != var2); } TEST_F(UniqueRefTest, Nonequality) { unique_ref var1 = make_unique_ref(3); unique_ref var2 = make_unique_ref(3); EXPECT_TRUE(var1 != var2); EXPECT_FALSE(var1 == var2); } TEST_F(UniqueRefTest, Nonequality_NullptrLeft) { unique_ref var1 = make_unique_ref(3); unique_ref var2 = make_unique_ref(3); makeInvalid(std::move(var1)); EXPECT_TRUE(var1 != var2); EXPECT_FALSE(var1 == var2); } TEST_F(UniqueRefTest, Nonequality_NullptrRight) { unique_ref var1 = make_unique_ref(3); unique_ref var2 = make_unique_ref(3); makeInvalid(std::move(var2)); EXPECT_TRUE(var1 != var2); EXPECT_FALSE(var1 == var2); } TEST_F(UniqueRefTest, HashIsDifferent) { unique_ref var1 = make_unique_ref(3); unique_ref var2 = make_unique_ref(3); EXPECT_NE(std::hash>()(var1), std::hash>()(var2)); } TEST_F(UniqueRefTest, HashIsDifferent_NullptrLeft) { unique_ref var1 = make_unique_ref(3); unique_ref var2 = make_unique_ref(3); makeInvalid(std::move(var1)); EXPECT_NE(std::hash>()(var1), std::hash>()(var2)); } TEST_F(UniqueRefTest, HashIsDifferent_NullptrRight) { unique_ref var1 = make_unique_ref(3); unique_ref var2 = make_unique_ref(3); makeInvalid(std::move(var2)); EXPECT_NE(std::hash>()(var1), std::hash>()(var2)); } TEST_F(UniqueRefTest, HashIsSame_BothNullptr) { unique_ref var1 = make_unique_ref(3); unique_ref var2 = make_unique_ref(3); makeInvalid(std::move(var1)); makeInvalid(std::move(var2)); EXPECT_EQ(std::hash>()(var1), std::hash>()(var2)); } TEST_F(UniqueRefTest, OneIsLess) { unique_ref var1 = make_unique_ref(3); unique_ref var2 = make_unique_ref(3); EXPECT_TRUE(std::less>()(var1, var2) != std::less>()(var2, var1)); } TEST_F(UniqueRefTest, NullptrIsLess1) { unique_ref var1 = make_unique_ref(3); unique_ref var2 = make_unique_ref(3); makeInvalid(std::move(var1)); EXPECT_TRUE(std::less>()(var1, var2)); } TEST_F(UniqueRefTest, NullptrIsLess2) { unique_ref var1 = make_unique_ref(3); unique_ref var2 = make_unique_ref(3); makeInvalid(std::move(var2)); EXPECT_TRUE(std::less>()(var2, var1)); } TEST_F(UniqueRefTest, NullptrIsNotLessThanNullptr) { unique_ref var1 = make_unique_ref(3); unique_ref var2 = make_unique_ref(3); makeInvalid(std::move(var1)); makeInvalid(std::move(var2)); EXPECT_FALSE(std::less>()(var1, var2)); } class OnlyMoveable { public: OnlyMoveable(int value_): value(value_) {} OnlyMoveable(OnlyMoveable &&source): value(source.value) {source.value = -1;} bool operator==(const OnlyMoveable &rhs) const { return value == rhs.value; } int value; private: DISALLOW_COPY_AND_ASSIGN(OnlyMoveable); }; TEST_F(UniqueRefTest, AllowsDerefOnRvalue) { OnlyMoveable val = *make_unique_ref(5); EXPECT_EQ(OnlyMoveable(5), val); }test/cpp-utils/process/000077500000000000000000000000001300002025200154135ustar00rootroot00000000000000test/cpp-utils/process/daemonize_include_test.cpp000066400000000000000000000001661300002025200226370ustar00rootroot00000000000000#include "cpp-utils/process/daemonize.h" // Test the header can be included without needing additional dependencies test/cpp-utils/process/subprocess_include_test.cpp000066400000000000000000000001671300002025200230550ustar00rootroot00000000000000#include "cpp-utils/process/subprocess.h" // Test the header can be included without needing additional dependencies test/cpp-utils/random/000077500000000000000000000000001300002025200152155ustar00rootroot00000000000000test/cpp-utils/random/RandomIncludeTest.cpp000066400000000000000000000001611300002025200213030ustar00rootroot00000000000000#include "cpp-utils/random/Random.h" // Test the header can be included without needing additional dependencies test/cpp-utils/tempfile/000077500000000000000000000000001300002025200155425ustar00rootroot00000000000000test/cpp-utils/tempfile/TempDirIncludeTest.cpp000066400000000000000000000001641300002025200217570ustar00rootroot00000000000000#include "cpp-utils/tempfile/TempDir.h" // Test the header can be included without needing additional dependencies test/cpp-utils/tempfile/TempDirTest.cpp000066400000000000000000000022211300002025200204470ustar00rootroot00000000000000#include #include "cpp-utils/tempfile/TempDir.h" #include using ::testing::Test; using std::ofstream; using namespace cpputils; namespace bf = boost::filesystem; class TempDirTest: public Test { public: void EXPECT_ENTRY_COUNT(int expected, const bf::path &path) { int actual = CountEntries(path); EXPECT_EQ(expected, actual); } int CountEntries(const bf::path &path) { int count = 0; for (bf::directory_iterator iter(path); iter != bf::directory_iterator(); ++iter) { ++count; } return count; } void CreateFile(const bf::path &path) { ofstream file(path.c_str()); } }; TEST_F(TempDirTest, DirIsCreated) { TempDir dir; EXPECT_TRUE(bf::exists(dir.path())); EXPECT_TRUE(bf::is_directory(dir.path())); } TEST_F(TempDirTest, DirIsCreatedEmpty) { TempDir dir; EXPECT_ENTRY_COUNT(0, dir.path()); } TEST_F(TempDirTest, DirIsWriteable) { TempDir dir; CreateFile(dir.path() / "myfile"); EXPECT_ENTRY_COUNT(1, dir.path()); } TEST_F(TempDirTest, DirIsDeletedAfterUse) { bf::path dirpath; { TempDir dir; dirpath = dir.path(); } EXPECT_FALSE(bf::exists(dirpath)); } test/cpp-utils/tempfile/TempFileIncludeTest.cpp000066400000000000000000000001651300002025200221210ustar00rootroot00000000000000#include "cpp-utils/tempfile/TempFile.h" // Test the header can be included without needing additional dependencies test/cpp-utils/tempfile/TempFileTest.cpp000066400000000000000000000052551300002025200206220ustar00rootroot00000000000000#include #include "cpp-utils/tempfile/TempFile.h" #include "cpp-utils/tempfile/TempDir.h" #include using ::testing::Test; using std::ifstream; using std::ofstream; using namespace cpputils; namespace bf = boost::filesystem; class TempFileTest: public Test { public: TempFileTest(): tempdir(), filepath_sample(tempdir.path() / "myfile") {} TempDir tempdir; bf::path filepath_sample; void CreateFile(const bf::path &path) { ofstream file(path.c_str()); } }; TEST_F(TempFileTest, FileIsCreated) { TempFile file; EXPECT_TRUE(bf::exists(file.path())); EXPECT_TRUE(bf::is_regular_file(file.path())); } TEST_F(TempFileTest, FileIsReadable) { TempFile file; ifstream opened(file.path().c_str()); EXPECT_TRUE(opened.good()); } TEST_F(TempFileTest, FileIsCreatedEmpty) { TempFile file; ifstream opened(file.path().c_str()); opened.get(); EXPECT_TRUE(opened.eof()); } TEST_F(TempFileTest, FileIsWriteable) { TempFile file; ofstream opened(file.path().c_str()); EXPECT_TRUE(opened.good()); } TEST_F(TempFileTest, FileIsDeletedAfterUse) { bf::path filepath; { TempFile file; filepath = file.path(); } EXPECT_FALSE(bf::exists(filepath)); } TEST_F(TempFileTest, DontCreateFileSpecified_FileIsNotCreated) { TempFile file(false); EXPECT_FALSE(bf::exists(file.path())); } TEST_F(TempFileTest, DontCreateFileSpecified_FileIsCreatable) { TempFile file(false); CreateFile(file.path()); EXPECT_TRUE(bf::exists(file.path())); } TEST_F(TempFileTest, DontCreateFileSpecified_FileIsDeletedAfterUse) { bf::path filepath; { TempFile file(false); CreateFile(file.path()); filepath = file.path(); } EXPECT_FALSE(bf::exists(filepath)); } TEST_F(TempFileTest, PathGiven_FileIsCreatedAtGivenPath) { TempFile file(filepath_sample); EXPECT_EQ(filepath_sample, file.path()); } TEST_F(TempFileTest, PathGiven_FileIsCreatedAndAccessible) { TempFile file(filepath_sample); EXPECT_TRUE(bf::exists(filepath_sample)); } TEST_F(TempFileTest, PathGiven_FileIsDeletedAfterUse) { { TempFile file(filepath_sample); } EXPECT_FALSE(bf::exists(filepath_sample)); } TEST_F(TempFileTest, PathGiven_DontCreateFileSpecified_FileIsNotCreated) { TempFile file(filepath_sample, false); EXPECT_FALSE(bf::exists(filepath_sample)); } TEST_F(TempFileTest, PathGiven_DontCreateFileSpecified_FileIsCreatable) { TempFile file(filepath_sample, false); CreateFile(filepath_sample); EXPECT_TRUE(bf::exists(filepath_sample)); } TEST_F(TempFileTest, PathGiven_DontCreateFileSpecified_FileIsDeletedAfterUse) { { TempFile file(filepath_sample, false); CreateFile(filepath_sample); } EXPECT_FALSE(bf::exists(filepath_sample)); } test/cryfs-cli/000077500000000000000000000000001300002025200137105ustar00rootroot00000000000000test/cryfs-cli/CMakeLists.txt000066400000000000000000000010761300002025200164540ustar00rootroot00000000000000project (cryfs-cli-test) set(SOURCES CallAfterTimeoutTest.cpp testutils/CliTest.cpp CliTest_Setup.cpp CliTest_WrongEnvironment.cpp program_options/UtilsTest.cpp program_options/ProgramOptionsTest.cpp program_options/ParserTest.cpp CliTest_ShowingHelp.cpp EnvironmentTest.cpp VersionCheckerTest.cpp ) add_executable(${PROJECT_NAME} ${SOURCES}) target_link_libraries(${PROJECT_NAME} googletest cryfs-cli) add_test(${PROJECT_NAME} ${PROJECT_NAME}) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) test/cryfs-cli/CallAfterTimeoutTest.cpp000066400000000000000000000036451300002025200204700ustar00rootroot00000000000000#include #include #include using cpputils::unique_ref; using cpputils::make_unique_ref; using boost::chrono::milliseconds; using boost::chrono::minutes; using boost::chrono::duration_cast; using boost::this_thread::sleep_for; using namespace cryfs; class CallAfterTimeoutTest : public ::testing::Test { public: unique_ref callAfterTimeout(milliseconds timeout) { return make_unique_ref(timeout, [this] {called = true;}); } bool called = false; }; TEST_F(CallAfterTimeoutTest, NoReset_1) { auto obj = callAfterTimeout(milliseconds(100)); sleep_for(milliseconds(50)); EXPECT_FALSE(called); sleep_for(milliseconds(100)); EXPECT_TRUE(called); } TEST_F(CallAfterTimeoutTest, NoReset_2) { auto obj = callAfterTimeout(milliseconds(200)); sleep_for(milliseconds(150)); EXPECT_FALSE(called); sleep_for(milliseconds(100)); EXPECT_TRUE(called); } TEST_F(CallAfterTimeoutTest, DoesntCallTwice) { auto obj = callAfterTimeout(milliseconds(50)); // Wait until it was called while(!called) { sleep_for(milliseconds(10)); } EXPECT_TRUE(called); // Test that it isn't called again called = false; sleep_for(milliseconds(150)); EXPECT_FALSE(called); } TEST_F(CallAfterTimeoutTest, OneReset) { auto obj = callAfterTimeout(milliseconds(200)); sleep_for(milliseconds(125)); obj->resetTimer(); sleep_for(milliseconds(125)); EXPECT_FALSE(called); sleep_for(milliseconds(125)); EXPECT_TRUE(called); } TEST_F(CallAfterTimeoutTest, TwoResets) { auto obj = callAfterTimeout(milliseconds(100)); sleep_for(milliseconds(50)); obj->resetTimer(); sleep_for(milliseconds(75)); obj->resetTimer(); sleep_for(milliseconds(75)); EXPECT_FALSE(called); sleep_for(milliseconds(75)); EXPECT_TRUE(called); } test/cryfs-cli/CliTest_Setup.cpp000066400000000000000000000035371300002025200171530ustar00rootroot00000000000000#include "testutils/CliTest.h" using cpputils::TempFile; //Tests that cryfs is correctly setup according to the CLI parameters specified using CliTest_Setup = CliTest; TEST_F(CliTest_Setup, NoSpecialOptions) { //Specify --cipher parameter to make it non-interactive //TODO Remove "-f" parameter, once EXPECT_RUN_SUCCESS can handle that EXPECT_RUN_SUCCESS({basedir.c_str(), mountdir.c_str(), "--cipher", "aes-256-gcm", "-f"}, mountdir); } TEST_F(CliTest_Setup, NotexistingLogfileGiven) { TempFile notexisting_logfile(false); //Specify --cipher parameter to make it non-interactive //TODO Remove "-f" parameter, once EXPECT_RUN_SUCCESS can handle that EXPECT_RUN_SUCCESS({basedir.c_str(), mountdir.c_str(), "-f", "--cipher", "aes-256-gcm", "--logfile", notexisting_logfile.path().c_str()}, mountdir); //TODO Expect logfile is used (check logfile content) } TEST_F(CliTest_Setup, ExistingLogfileGiven) { //Specify --cipher parameter to make it non-interactive //TODO Remove "-f" parameter, once EXPECT_RUN_SUCCESS can handle that EXPECT_RUN_SUCCESS({basedir.c_str(), mountdir.c_str(), "-f", "--cipher", "aes-256-gcm", "--logfile", logfile.path().c_str()}, mountdir); //TODO Expect logfile is used (check logfile content) } TEST_F(CliTest_Setup, ConfigfileGiven) { //Specify --cipher parameter to make it non-interactive //TODO Remove "-f" parameter, once EXPECT_RUN_SUCCESS can handle that EXPECT_RUN_SUCCESS({basedir.c_str(), mountdir.c_str(), "-f", "--cipher", "aes-256-gcm", "--config", configfile.path().c_str()}, mountdir); } TEST_F(CliTest_Setup, FuseOptionGiven) { //Specify --cipher parameter to make it non-interactive //TODO Remove "-f" parameter, once EXPECT_RUN_SUCCESS can handle that EXPECT_RUN_SUCCESS({basedir.c_str(), mountdir.c_str(), "-f", "--cipher", "aes-256-gcm", "--", "-f"}, mountdir); }test/cryfs-cli/CliTest_ShowingHelp.cpp000066400000000000000000000014721300002025200202760ustar00rootroot00000000000000#include "testutils/CliTest.h" using CliTest_ShowingHelp = CliTest; TEST_F(CliTest_ShowingHelp, HelpLongOption) { EXPECT_EXIT_WITH_HELP_MESSAGE({"--help"}); } TEST_F(CliTest_ShowingHelp, HelpLongOptionTogetherWithOtherOptions) { EXPECT_EXIT_WITH_HELP_MESSAGE({basedir.c_str(), mountdir.c_str(), "--help"}); } TEST_F(CliTest_ShowingHelp, HelpShortOption) { EXPECT_EXIT_WITH_HELP_MESSAGE({"-h"}); } TEST_F(CliTest_ShowingHelp, HelpShortOptionTogetherWithOtherOptions) { EXPECT_EXIT_WITH_HELP_MESSAGE({basedir.c_str(), mountdir.c_str(), "-h"}); } TEST_F(CliTest_ShowingHelp, MissingAllOptions) { EXPECT_EXIT_WITH_HELP_MESSAGE({}, "Please specify a base directory"); } TEST_F(CliTest_ShowingHelp, MissingDir) { EXPECT_EXIT_WITH_HELP_MESSAGE({basedir.c_str()}, "Please specify a mount directory"); } test/cryfs-cli/CliTest_WrongEnvironment.cpp000066400000000000000000000227041300002025200213710ustar00rootroot00000000000000#include "testutils/CliTest.h" namespace bf = boost::filesystem; using ::testing::Values; using ::testing::WithParamInterface; using ::testing::Return; using ::testing::_; using std::vector; using cpputils::TempFile; struct TestConfig { bool externalConfigfile; bool logIsNotStderr; bool runningInForeground; }; //Tests what happens if cryfs is run in the wrong environment, i.e. with a base directory that doesn't exist or similar class CliTest_WrongEnvironment: public CliTest, public WithParamInterface { public: void SetAllPermissions(const bf::path &dir) { bf::permissions(dir, bf::owner_write|bf::owner_read|bf::owner_exe); } void SetNoReadPermission(const bf::path &dir) { bf::permissions(dir, bf::owner_write|bf::owner_exe); } void SetNoWritePermission(const bf::path &dir) { bf::permissions(dir, bf::owner_read|bf::owner_exe); } void SetNoExePermission(const bf::path &dir) { bf::permissions(dir, bf::owner_read|bf::owner_write); } void SetNoPermission(const bf::path &dir) { bf::permissions(dir, bf::no_perms); } void Test_Run_Success() { EXPECT_RUN_SUCCESS(args(), mountdir); } void Test_Run_Error(const char *expectedError) { EXPECT_RUN_ERROR( args(), expectedError ); } vector args() { vector result = {basedir.c_str(), mountdir.c_str()}; if (GetParam().externalConfigfile) { result.push_back("--config"); result.push_back(configfile.path().c_str()); } if (GetParam().logIsNotStderr) { result.push_back("--logfile"); result.push_back(logfile.path().c_str()); } if (GetParam().runningInForeground) { result.push_back("-f"); } // Test case should be non-interactive, so don't ask for cipher. result.push_back("--cipher"); result.push_back("aes-256-gcm"); return result; } }; INSTANTIATE_TEST_CASE_P(DefaultParams, CliTest_WrongEnvironment, Values(TestConfig({false, false, false}))); INSTANTIATE_TEST_CASE_P(ExternalConfigfile, CliTest_WrongEnvironment, Values(TestConfig({true, false, false}))); INSTANTIATE_TEST_CASE_P(LogIsNotStderr, CliTest_WrongEnvironment, Values(TestConfig({false, true, false}))); INSTANTIATE_TEST_CASE_P(ExternalConfigfile_LogIsNotStderr, CliTest_WrongEnvironment, Values(TestConfig({true, true, false}))); INSTANTIATE_TEST_CASE_P(RunningInForeground, CliTest_WrongEnvironment, Values(TestConfig({false, false, true}))); INSTANTIATE_TEST_CASE_P(RunningInForeground_ExternalConfigfile, CliTest_WrongEnvironment, Values(TestConfig({true, false, true}))); INSTANTIATE_TEST_CASE_P(RunningInForeground_LogIsNotStderr, CliTest_WrongEnvironment, Values(TestConfig({false, true, true}))); INSTANTIATE_TEST_CASE_P(RunningInForeground_ExternalConfigfile_LogIsNotStderr, CliTest_WrongEnvironment, Values(TestConfig({true, true, true}))); //Counter-Test. Test that it doesn't fail if we call it without an error condition. TEST_P(CliTest_WrongEnvironment, NoErrorCondition) { if (!GetParam().runningInForeground) {return;} // TODO Make this work also if run in background (see CliTest::EXPECT_RUN_SUCCESS) Test_Run_Success(); } TEST_P(CliTest_WrongEnvironment, MountDirIsBaseDir) { mountdir = basedir; Test_Run_Error("Error: base directory can't be inside the mount directory"); } bf::path make_relative(const bf::path &path) { bf::path result; bf::path cwd = bf::current_path(); for(auto iter = ++cwd.begin(); iter!=cwd.end(); ++iter) { result /= ".."; } result /= path; return result; } TEST_P(CliTest_WrongEnvironment, MountDirIsBaseDir_MountDirRelative) { mountdir = make_relative(basedir); Test_Run_Error("Error: base directory can't be inside the mount directory"); } TEST_P(CliTest_WrongEnvironment, MountDirIsBaseDir_BaseDirRelative) { mountdir = basedir; basedir = make_relative(basedir); Test_Run_Error("Error: base directory can't be inside the mount directory"); } TEST_P(CliTest_WrongEnvironment, MountDirIsBaseDir_BothRelative) { basedir = make_relative(basedir); mountdir = basedir; Test_Run_Error("Error: base directory can't be inside the mount directory"); } TEST_P(CliTest_WrongEnvironment, BaseDir_DoesntExist) { _basedir.remove(); // ON_CALL and not EXPECT_CALL, because this is a death test (i.e. it is forked) and gmock EXPECT_CALL in fork children don't report to parents. ON_CALL(*console, askYesNo("Could not find base directory. Do you want to create it?", _)).WillByDefault(Return(false)); Test_Run_Error("Error: base directory not found"); } TEST_P(CliTest_WrongEnvironment, BaseDir_DoesntExist_Noninteractive) { _basedir.remove(); // We can't set an EXPECT_CALL().Times(0), because this is a death test (i.e. it is forked) and gmock EXPECT_CALL in fork children don't report to parents. // So we set a default answer that shouldn't crash and check it's not called by checking that it crashes. ON_CALL(*console, askYesNo("Could not find base directory. Do you want to create it?", _)).WillByDefault(Return(true)); ::setenv("CRYFS_FRONTEND", "noninteractive", 1); Test_Run_Error("Error: base directory not found"); ::unsetenv("CRYFS_FRONTEND"); } TEST_P(CliTest_WrongEnvironment, BaseDir_DoesntExist_Create) { if (!GetParam().runningInForeground) {return;} // TODO Make this work also if run in background (see CliTest::EXPECT_RUN_SUCCESS) _basedir.remove(); ON_CALL(*console, askYesNo("Could not find base directory. Do you want to create it?", _)).WillByDefault(Return(true)); Test_Run_Success(); EXPECT_TRUE(bf::exists(_basedir.path()) && bf::is_directory(_basedir.path())); } TEST_P(CliTest_WrongEnvironment, BaseDir_IsNotDirectory) { TempFile basedirfile; basedir = basedirfile.path(); Test_Run_Error("Error: base directory is not a directory"); } TEST_P(CliTest_WrongEnvironment, BaseDir_AllPermissions) { if (!GetParam().runningInForeground) {return;} // TODO Make this work also if run in background (see CliTest::EXPECT_RUN_SUCCESS) //Counter-Test. Test it doesn't fail if permissions are there. SetAllPermissions(basedir); Test_Run_Success(); } TEST_P(CliTest_WrongEnvironment, BaseDir_NoReadPermission) { SetNoReadPermission(basedir); Test_Run_Error("Error: Could not read from base directory"); } TEST_P(CliTest_WrongEnvironment, BaseDir_NoWritePermission) { SetNoWritePermission(basedir); Test_Run_Error("Error: Could not write to base directory"); } TEST_P(CliTest_WrongEnvironment, BaseDir_NoExePermission) { SetNoExePermission(basedir); Test_Run_Error("Error: Could not write to base directory"); } TEST_P(CliTest_WrongEnvironment, BaseDir_NoPermission) { SetNoPermission(basedir); Test_Run_Error("Error: Could not write to base directory"); } TEST_P(CliTest_WrongEnvironment, MountDir_DoesntExist) { _mountdir.remove(); // ON_CALL and not EXPECT_CALL, because this is a death test (i.e. it is forked) and gmock EXPECT_CALL in fork children don't report to parents. ON_CALL(*console, askYesNo("Could not find mount directory. Do you want to create it?", _)).WillByDefault(Return(false)); Test_Run_Error("Error: mount directory not found"); } TEST_P(CliTest_WrongEnvironment, MountDir_DoesntExist_Noninteractive) { _mountdir.remove(); // We can't set an EXPECT_CALL().Times(0), because this is a death test (i.e. it is forked) and gmock EXPECT_CALL in fork children don't report to parents. // So we set a default answer that shouldn't crash and check it's not called by checking that it crashes. ON_CALL(*console, askYesNo("Could not find base directory. Do you want to create it?", _)).WillByDefault(Return(true)); ::setenv("CRYFS_FRONTEND", "noninteractive", 1); Test_Run_Error("Error: mount directory not found"); ::unsetenv("CRYFS_FRONTEND"); } TEST_P(CliTest_WrongEnvironment, MountDir_DoesntExist_Create) { if (!GetParam().runningInForeground) {return;} // TODO Make this work also if run in background (see CliTest::EXPECT_RUN_SUCCESS) _mountdir.remove(); ON_CALL(*console, askYesNo("Could not find mount directory. Do you want to create it?", _)).WillByDefault(Return(true)); Test_Run_Success(); EXPECT_TRUE(bf::exists(_mountdir.path()) && bf::is_directory(_mountdir.path())); } TEST_P(CliTest_WrongEnvironment, MountDir_IsNotDirectory) { TempFile mountdirfile; mountdir = mountdirfile.path(); Test_Run_Error("Error: mount directory is not a directory"); } TEST_P(CliTest_WrongEnvironment, MountDir_AllPermissions) { if (!GetParam().runningInForeground) {return;} // TODO Make this work also if run in background (see CliTest::EXPECT_RUN_SUCCESS) //Counter-Test. Test it doesn't fail if permissions are there. SetAllPermissions(mountdir); Test_Run_Success(); } TEST_P(CliTest_WrongEnvironment, MountDir_NoReadPermission) { SetNoReadPermission(mountdir); Test_Run_Error("Error: Could not read from mount directory"); } TEST_P(CliTest_WrongEnvironment, MountDir_NoWritePermission) { SetNoWritePermission(mountdir); Test_Run_Error("Error: Could not write to mount directory"); } TEST_P(CliTest_WrongEnvironment, MountDir_NoExePermission) { SetNoExePermission(mountdir); Test_Run_Error("Error: Could not write to mount directory"); } TEST_P(CliTest_WrongEnvironment, MountDir_NoPermission) { SetNoPermission(mountdir); Test_Run_Error("Error: Could not write to mount directory"); } test/cryfs-cli/EnvironmentTest.cpp000066400000000000000000000035701300002025200175650ustar00rootroot00000000000000#include #include #include using namespace cryfs; using std::string; using boost::optional; using boost::none; class EnvironmentTest : public ::testing::Test { public: // WithEnv sets an environment variable while it is in scope. // Once it leaves scope, the environment is reset. class WithEnv { public: WithEnv(const string &key, const string &value): _key(key) , _oldValue(none) { char *oldValue = std::getenv(key.c_str()); if (nullptr != oldValue) { _oldValue = string(oldValue); } ::setenv(key.c_str(), value.c_str(), 1); } ~WithEnv() { if (none == _oldValue) { ::unsetenv(_key.c_str()); } else { ::setenv(_key.c_str(), _oldValue->c_str(), 1); } } private: string _key; optional _oldValue; }; }; TEST_F(EnvironmentTest, Noninteractive_Unset) { EXPECT_FALSE(Environment::isNoninteractive()); } TEST_F(EnvironmentTest, Noninteractive_Set) { WithEnv env("CRYFS_FRONTEND", "noninteractive"); EXPECT_TRUE(Environment::isNoninteractive()); } TEST_F(EnvironmentTest, Noninteractive_SetToOtherValue) { WithEnv env("CRYFS_FRONTEND", "someotherfrontend"); EXPECT_FALSE(Environment::isNoninteractive()); } TEST_F(EnvironmentTest, NoUpdateCheck_Unset) { EXPECT_FALSE(Environment::noUpdateCheck()); } TEST_F(EnvironmentTest, NoUpdateCheck_Set) { WithEnv env("CRYFS_NO_UPDATE_CHECK", "true"); EXPECT_TRUE(Environment::noUpdateCheck()); } TEST_F(EnvironmentTest, NoUpdateCheck_SetToOtherValue) { WithEnv env("CRYFS_NO_UPDATE_CHECK", "someothervalue"); // No matter what the value is, setting the environment variable says we don't do update checks. EXPECT_TRUE(Environment::noUpdateCheck()); } test/cryfs-cli/VersionCheckerTest.cpp000066400000000000000000000111251300002025200201660ustar00rootroot00000000000000#include #include #include #include using std::shared_ptr; using std::make_shared; using std::string; using cpputils::FakeHttpClient; using cpputils::unique_ref; using cpputils::make_unique_ref; using boost::none; using namespace cryfs; class VersionCheckerTest: public ::testing::Test { public: unique_ref versionChecker() { return make_unique_ref(http); } void setVersionInfo(const string &versionInfo) { http->addWebsite("https://www.cryfs.org/version_info.json", versionInfo); } private: shared_ptr http = make_shared(); }; TEST_F(VersionCheckerTest, NewestVersion_NoInternet) { EXPECT_EQ(none, versionChecker()->newestVersion()); } TEST_F(VersionCheckerTest, SecurityWarningFor_NoInternet) { EXPECT_EQ(none, versionChecker()->securityWarningFor("0.8")); } TEST_F(VersionCheckerTest, NewestVersion_NoWarnings_1) { setVersionInfo("{\"version_info\":{\"current\":\"0.8.2\"}}"); EXPECT_EQ("0.8.2", versionChecker()->newestVersion().value()); } TEST_F(VersionCheckerTest, NewestVersion_NoWarnings_2) { setVersionInfo("{\"version_info\":{\"current\":\"0.8.3\"}}"); EXPECT_EQ("0.8.3", versionChecker()->newestVersion().value()); } TEST_F(VersionCheckerTest, NewestVersion_EmptyWarnings) { setVersionInfo("{\"version_info\":{\"current\":\"0.8.2\"},\"warnings\":{}}"); EXPECT_EQ("0.8.2", versionChecker()->newestVersion().value()); } TEST_F(VersionCheckerTest, NewestVersion_WarningsOtherVersion) { setVersionInfo("{\"version_info\":{\"current\":\"0.8.2\"},\"warnings\":{\"0.8.1\": \"warning\"}}"); EXPECT_EQ("0.8.2", versionChecker()->newestVersion().value()); } TEST_F(VersionCheckerTest, NewestVersion_WarningsSameVersion) { setVersionInfo("{\"version_info\":{\"current\":\"0.8.2\"},\"warnings\":{\"0.8.2\": \"warning\"}}"); EXPECT_EQ("0.8.2", versionChecker()->newestVersion().value()); } TEST_F(VersionCheckerTest, NewestVersion_WarningsSameAndOtherVersion) { setVersionInfo("{\"version_info\":{\"current\":\"0.8.2\"},\"warnings\":{\"0.8.1\": \"warning1\", \"0.8.2\": \"warning2\", \"0.8.3\": \"warning3\"}}"); EXPECT_EQ("0.8.2", versionChecker()->newestVersion().value()); } TEST_F(VersionCheckerTest, NewestVersion_BlankVersionInfo) { setVersionInfo(""); EXPECT_EQ(none, versionChecker()->newestVersion()); } TEST_F(VersionCheckerTest, NewestVersion_EmptyVersionInfo) { setVersionInfo("{}"); EXPECT_EQ(none, versionChecker()->newestVersion()); } TEST_F(VersionCheckerTest, NewestVersion_InvalidVersionInfo) { setVersionInfo("invalid-json"); EXPECT_EQ(none, versionChecker()->newestVersion()); } TEST_F(VersionCheckerTest, NewestVersion_MissingKey) { setVersionInfo("{\"warnings\":{}"); EXPECT_EQ(none, versionChecker()->newestVersion()); } TEST_F(VersionCheckerTest, SecurityWarningFor_NoWarnings) { setVersionInfo("{\"version_info\":{\"current\":\"0.8.2\"}}"); EXPECT_EQ(none, versionChecker()->securityWarningFor("0.8.2")); } TEST_F(VersionCheckerTest, SecurityWarningFor_EmptyWarnings) { setVersionInfo("{\"version_info\":{\"current\":\"0.8.2\"},\"warnings\":{}}"); EXPECT_EQ(none, versionChecker()->securityWarningFor("0.8.2")); } TEST_F(VersionCheckerTest, SecurityWarningFor_WarningsOtherVersion) { setVersionInfo("{\"version_info\":{\"current\":\"0.8.2\"},\"warnings\":{\"0.8.1\": \"warning\"}}"); EXPECT_EQ(none, versionChecker()->securityWarningFor("0.8.2")); } TEST_F(VersionCheckerTest, SecurityWarningFor_WarningsSameVersion) { setVersionInfo("{\"version_info\":{\"current\":\"0.8.2\"},\"warnings\":{\"0.8.2\": \"warning\"}}"); EXPECT_EQ("warning", versionChecker()->securityWarningFor("0.8.2").value()); } TEST_F(VersionCheckerTest, SecurityWarningFor_WarningsSameAndOtherVersion) { setVersionInfo("{\"version_info\":{\"current\":\"0.8.2\"},\"warnings\":{\"0.8.1\": \"warning1\", \"0.8.2\": \"warning2\", \"0.8.3\": \"warning3\"}}"); EXPECT_EQ("warning2", versionChecker()->securityWarningFor("0.8.2").value()); } TEST_F(VersionCheckerTest, SecurityWarningFor_BlankVersionInfo) { setVersionInfo(""); EXPECT_EQ(none, versionChecker()->securityWarningFor("0.8.2")); } TEST_F(VersionCheckerTest, SecurityWarningFor_EmptyVersionInfo) { setVersionInfo("{}"); EXPECT_EQ(none, versionChecker()->securityWarningFor("0.8.2")); } TEST_F(VersionCheckerTest, SecurityWarningFor_InvalidVersionInfo) { setVersionInfo("invalid-json"); EXPECT_EQ(none, versionChecker()->securityWarningFor("0.8.2")); } test/cryfs-cli/program_options/000077500000000000000000000000001300002025200171325ustar00rootroot00000000000000test/cryfs-cli/program_options/ParserTest.cpp000066400000000000000000000146541300002025200217440ustar00rootroot00000000000000#include "testutils/ProgramOptionsTestBase.h" #include #include #include using namespace cryfs; using namespace cryfs::program_options; using std::vector; using std::string; using boost::none; namespace bf = boost::filesystem; class ProgramOptionsParserTest: public ProgramOptionsTestBase { public: ProgramOptions parse(std::initializer_list options) { vector _options = options; return Parser(_options.size(), _options.data()).parse(CryCiphers::supportedCipherNames()); } }; TEST_F(ProgramOptionsParserTest, MissingAllOptions) { EXPECT_DEATH( parse({"./myExecutable"}), "Usage:" ); } TEST_F(ProgramOptionsParserTest, MissingDir) { EXPECT_DEATH( parse({"./myExecutable", "/home/user/baseDir"}), "Usage:" ); } TEST_F(ProgramOptionsParserTest, HelpLongOption) { EXPECT_DEATH( parse({"./myExecutable", "--help"}), "Usage:" ); } TEST_F(ProgramOptionsParserTest, HelpShortOption) { EXPECT_DEATH( parse({"./myExecutable", "-h"}), "Usage:" ); } TEST_F(ProgramOptionsParserTest, ShowCiphers) { EXPECT_EXIT( parse({"./myExecutable", "--show-ciphers"}), ::testing::ExitedWithCode(0), "aes-256-gcm" ); } TEST_F(ProgramOptionsParserTest, BaseDir_Absolute) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "/home/user/mountDir"}); EXPECT_EQ("/home/user/baseDir", options.baseDir()); } TEST_F(ProgramOptionsParserTest, Basedir_Relative) { ProgramOptions options = parse({"./myExecutable", "baseDir", "/home/user/mountDir"}); EXPECT_EQ(bf::current_path() / "baseDir", options.baseDir()); } TEST_F(ProgramOptionsParserTest, MountDir_Absolute) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "/home/user/mountDir"}); EXPECT_EQ("/home/user/mountDir", options.mountDir()); } TEST_F(ProgramOptionsParserTest, MountDir_Relative) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "mountDir"}); EXPECT_EQ(bf::current_path() / "mountDir", options.mountDir()); } TEST_F(ProgramOptionsParserTest, LogfileGiven) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "--logfile", "/home/user/mylogfile", "/home/user/mountDir"}); EXPECT_EQ("/home/user/mylogfile", options.logFile().value()); } TEST_F(ProgramOptionsParserTest, LogfileGiven_RelativePath) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "--logfile", "mylogfile", "/home/user/mountDir"}); EXPECT_EQ(bf::current_path() / "mylogfile", options.logFile().value()); } TEST_F(ProgramOptionsParserTest, LogfileNotGiven) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "/home/user/mountDir"}); EXPECT_EQ(none, options.logFile()); } TEST_F(ProgramOptionsParserTest, ConfigfileGiven) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "--config", "/home/user/myconfigfile", "/home/user/mountDir"}); EXPECT_EQ("/home/user/myconfigfile", options.configFile().value()); } TEST_F(ProgramOptionsParserTest, ConfigfileGiven_RelativePath) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "--config", "myconfigfile", "/home/user/mountDir"}); EXPECT_EQ(bf::current_path() / "myconfigfile", options.configFile().value()); } TEST_F(ProgramOptionsParserTest, ConfigfileNotGiven) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "/home/user/mountDir"}); EXPECT_EQ(none, options.configFile()); } TEST_F(ProgramOptionsParserTest, CipherGiven) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "--cipher", "aes-256-gcm", "/home/user/mountDir"}); EXPECT_EQ("aes-256-gcm", options.cipher().value()); } TEST_F(ProgramOptionsParserTest, CipherNotGiven) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "/home/user/mountDir"}); EXPECT_EQ(none, options.cipher()); } TEST_F(ProgramOptionsParserTest, InvalidCipher) { EXPECT_DEATH( parse({"./myExecutable", "/home/user/baseDir", "--cipher", "invalid-cipher", "/home/user/mountDir"}), "Invalid cipher: invalid-cipher" ); } TEST_F(ProgramOptionsParserTest, UnmountAfterIdleMinutesGiven) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "--unmount-idle", "10", "/home/user/mountDir"}); EXPECT_EQ(10, options.unmountAfterIdleMinutes().value()); } TEST_F(ProgramOptionsParserTest, UnmountAfterIdleMinutesGiven_Float) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "--unmount-idle", "0.5", "/home/user/mountDir"}); EXPECT_EQ(0.5, options.unmountAfterIdleMinutes().value()); } TEST_F(ProgramOptionsParserTest, UnmountAfterIdleMinutesNotGiven) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "/home/user/mountDir"}); EXPECT_EQ(none, options.unmountAfterIdleMinutes()); } TEST_F(ProgramOptionsParserTest, BlocksizeGiven) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "--blocksize", "10240", "/home/user/mountDir"}); EXPECT_EQ(10240u, options.blocksizeBytes().value()); } TEST_F(ProgramOptionsParserTest, BlocksizeNotGiven) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "/home/user/mountDir"}); EXPECT_EQ(none, options.blocksizeBytes()); } TEST_F(ProgramOptionsParserTest, FuseOptionGiven) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "/home/user/mountDir", "--", "-f"}); EXPECT_EQ("/home/user/baseDir", options.baseDir()); EXPECT_EQ("/home/user/mountDir", options.mountDir()); EXPECT_VECTOR_EQ({"-f"}, options.fuseOptions()); } TEST_F(ProgramOptionsParserTest, FuseOptionGiven_Empty) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "/home/user/mountDir", "--"}); EXPECT_EQ("/home/user/baseDir", options.baseDir()); EXPECT_EQ("/home/user/mountDir", options.mountDir()); EXPECT_VECTOR_EQ({}, options.fuseOptions()); } TEST_F(ProgramOptionsParserTest, FuseOptionNotGiven) { ProgramOptions options = parse({"./myExecutable", "/home/user/baseDir", "/home/user/mountDir"}); EXPECT_EQ("/home/user/baseDir", options.baseDir()); EXPECT_EQ("/home/user/mountDir", options.mountDir()); EXPECT_VECTOR_EQ({}, options.fuseOptions()); } test/cryfs-cli/program_options/ProgramOptionsTest.cpp000066400000000000000000000077411300002025200234720ustar00rootroot00000000000000#include "testutils/ProgramOptionsTestBase.h" #include #include using namespace cryfs::program_options; using std::vector; using boost::none; using boost::optional; using std::ostream; using std::string; namespace bf = boost::filesystem; // This is needed for google test to work with boost::optional namespace boost { template<> ostream& operator<< , bf::path>(ostream &stream, const optional &path) { if (path == none) { return stream << "none"; } return stream << *path; } } class ProgramOptionsTest: public ProgramOptionsTestBase {}; TEST_F(ProgramOptionsTest, BaseDir) { ProgramOptions testobj("/home/user/mydir", "", none, false, none, none, none, none, {"./myExecutable"}); EXPECT_EQ("/home/user/mydir", testobj.baseDir()); } TEST_F(ProgramOptionsTest, MountDir) { ProgramOptions testobj("", "/home/user/mydir", none, false, none, none, none, none, {"./myExecutable"}); EXPECT_EQ("/home/user/mydir", testobj.mountDir()); } TEST_F(ProgramOptionsTest, ConfigfileNone) { ProgramOptions testobj("", "", none, true, none, none, none, none, {"./myExecutable"}); EXPECT_EQ(none, testobj.configFile()); } TEST_F(ProgramOptionsTest, ConfigfileSome) { ProgramOptions testobj("", "", bf::path("/home/user/configfile"), true, none, none, none, none, {"./myExecutable"}); EXPECT_EQ("/home/user/configfile", testobj.configFile().get()); } TEST_F(ProgramOptionsTest, ForegroundFalse) { ProgramOptions testobj("", "", none, false, none, none, none, none, {"./myExecutable"}); EXPECT_FALSE(testobj.foreground()); } TEST_F(ProgramOptionsTest, ForegroundTrue) { ProgramOptions testobj("", "", none, true, none, none, none, none, {"./myExecutable"}); EXPECT_TRUE(testobj.foreground()); } TEST_F(ProgramOptionsTest, LogfileNone) { ProgramOptions testobj("", "", none, true, none, none, none, none, {"./myExecutable"}); EXPECT_EQ(none, testobj.logFile()); } TEST_F(ProgramOptionsTest, LogfileSome) { ProgramOptions testobj("", "", none, true, none, bf::path("logfile"), none, none, {"./myExecutable"}); EXPECT_EQ("logfile", testobj.logFile().get()); } TEST_F(ProgramOptionsTest, UnmountAfterIdleMinutesNone) { ProgramOptions testobj("", "", none, true, none, none, none, none, {"./myExecutable"}); EXPECT_EQ(none, testobj.unmountAfterIdleMinutes()); } TEST_F(ProgramOptionsTest, UnmountAfterIdleMinutesSome) { ProgramOptions testobj("", "", none, true, 10, none, none, none, {"./myExecutable"}); EXPECT_EQ(10, testobj.unmountAfterIdleMinutes().get()); } TEST_F(ProgramOptionsTest, CipherNone) { ProgramOptions testobj("", "", none, true, none, none, none, none, {"./myExecutable"}); EXPECT_EQ(none, testobj.cipher()); } TEST_F(ProgramOptionsTest, CipherSome) { ProgramOptions testobj("", "", none, true, none, none, string("aes-256-gcm"), none, {"./myExecutable"}); EXPECT_EQ("aes-256-gcm", testobj.cipher().get()); } TEST_F(ProgramOptionsTest, BlocksizeBytesNone) { ProgramOptions testobj("", "", none, true, none, none, none, none, {"./myExecutable"}); EXPECT_EQ(none, testobj.blocksizeBytes()); } TEST_F(ProgramOptionsTest, BlocksizeSome) { ProgramOptions testobj("", "", none, true, none, none, none, 10*1024, {"./myExecutable"}); EXPECT_EQ(10*1024u, testobj.blocksizeBytes().get()); } TEST_F(ProgramOptionsTest, EmptyFuseOptions) { ProgramOptions testobj("/rootDir", "/home/user/mydir", none, false, none, none, none, none, {}); //Fuse should have the mount dir as first parameter EXPECT_VECTOR_EQ({}, testobj.fuseOptions()); } TEST_F(ProgramOptionsTest, SomeFuseOptions) { ProgramOptions testobj("/rootDir", "/home/user/mydir", none, false, none, none, none, none, {"-f", "--longoption"}); //Fuse should have the mount dir as first parameter EXPECT_VECTOR_EQ({"-f", "--longoption"}, testobj.fuseOptions()); } test/cryfs-cli/program_options/UtilsTest.cpp000066400000000000000000000126721300002025200216060ustar00rootroot00000000000000#include "testutils/ProgramOptionsTestBase.h" #include using namespace cryfs::program_options; using std::pair; using std::vector; using std::string; class ProgramOptionsUtilsTest: public ProgramOptionsTestBase {}; TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_ZeroOptions) { vector input = {"./executableName"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName"}, result.first); EXPECT_VECTOR_EQ({}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_OneShortOption) { vector input = {"./executableName", "-j"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName", "-j"}, result.first); EXPECT_VECTOR_EQ({}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_OneLongOption) { vector input = {"./executableName", "--myoption"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName", "--myoption"}, result.first); EXPECT_VECTOR_EQ({}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_OnePositionalOption) { vector input = {"./executableName", "mypositionaloption"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName", "mypositionaloption"}, result.first); EXPECT_VECTOR_EQ({}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_OneShortOption_DoubleDash) { vector input = {"./executableName", "-j", "--"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName", "-j"}, result.first); EXPECT_VECTOR_EQ({}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_OneLongOption_DoubleDash) { vector input = {"./executableName", "--myoption", "--"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName", "--myoption"}, result.first); EXPECT_VECTOR_EQ({}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_OnePositionalOption_DoubleDash) { vector input = {"./executableName", "mypositionaloption", "--"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName", "mypositionaloption"}, result.first); EXPECT_VECTOR_EQ({}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_DoubleDash_OneShortOption) { vector input = {"./executableName", "--", "-a"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName"}, result.first); EXPECT_VECTOR_EQ({"-a"}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_DoubleDash_OneLongOption) { vector input = {"./executableName", "--", "--myoption"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName"}, result.first); EXPECT_VECTOR_EQ({"--myoption"}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_DoubleDash_OnePositionalOption) { vector input = {"./executableName", "--", "mypositionaloption"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName"}, result.first); EXPECT_VECTOR_EQ({"mypositionaloption"}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_OneShortOption_DoubleDash_OneShortOption) { vector input = {"./executableName", "-j", "--", "-a"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName", "-j"}, result.first); EXPECT_VECTOR_EQ({"-a"}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_OneLongOption_DoubleDash_OneLongOption) { vector input = {"./executableName", "--myoption", "--", "--myotheroption"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName", "--myoption"}, result.first); EXPECT_VECTOR_EQ({"--myotheroption"}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_OnePositionalOption_DoubleDash_OnePositionalOption) { vector input = {"./executableName", "mypositionaloption", "--", "otherpositionaloption"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName", "mypositionaloption"}, result.first); EXPECT_VECTOR_EQ({"otherpositionaloption"}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_MoreOptions) { vector input = {"./executableName", "mypositionaloption", "myotherpositionaloption", "-j", "--alpha", "--", "filename", "--beta", "-j3"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName", "mypositionaloption", "myotherpositionaloption", "-j", "--alpha"}, result.first); EXPECT_VECTOR_EQ({"filename", "--beta", "-j3"}, result.second); } TEST_F(ProgramOptionsUtilsTest, SplitAtDoubleDash_RealisticCryfsOptions) { vector input = {"./executableName", "rootDir", "mountDir", "--", "-f"}; pair,vector> result = splitAtDoubleDash(input); EXPECT_VECTOR_EQ({"./executableName", "rootDir", "mountDir"}, result.first); EXPECT_VECTOR_EQ({"-f"}, result.second); } test/cryfs-cli/program_options/testutils/000077500000000000000000000000001300002025200211725ustar00rootroot00000000000000test/cryfs-cli/program_options/testutils/ProgramOptionsTestBase.h000066400000000000000000000011211300002025200257540ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_TEST_PROGRAMOPTIONS_PROGRAMOPTIONSTEST_H #define MESSMER_CRYFS_TEST_PROGRAMOPTIONS_PROGRAMOPTIONSTEST_H #include class ProgramOptionsTestBase: public ::testing::Test { public: void EXPECT_VECTOR_EQ(std::initializer_list expected, const std::vector &actual) { std::vector expectedVec(expected); ASSERT_EQ(expectedVec.size(), actual.size()); for(unsigned int i = 0; i < expectedVec.size(); ++i) { EXPECT_EQ(expectedVec[i], actual[i]); } } }; #endif test/cryfs-cli/testutils/000077500000000000000000000000001300002025200157505ustar00rootroot00000000000000test/cryfs-cli/testutils/CliTest.cpp000066400000000000000000000000251300002025200200200ustar00rootroot00000000000000#include "CliTest.h" test/cryfs-cli/testutils/CliTest.h000066400000000000000000000065271300002025200175020ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_TEST_CLI_TESTUTILS_CLITEST_H #define MESSMER_CRYFS_TEST_CLI_TESTUTILS_CLITEST_H #include #include #include #include #include #include #include #include #include #include "../../cryfs/testutils/MockConsole.h" class CliTest : public ::testing::Test { public: CliTest(): _basedir(), _mountdir(), basedir(_basedir.path()), mountdir(_mountdir.path()), logfile(), configfile(false), console(std::make_shared()) {} cpputils::TempDir _basedir; cpputils::TempDir _mountdir; boost::filesystem::path basedir; boost::filesystem::path mountdir; cpputils::TempFile logfile; cpputils::TempFile configfile; std::shared_ptr console; std::shared_ptr _httpClient() { std::shared_ptr httpClient = std::make_shared(); httpClient->addWebsite("https://www.cryfs.org/version_info.json", "{\"version_info\":{\"current\":\"0.8.5\"}}"); return httpClient; } void run(std::vector args) { std::vector _args; _args.reserve(args.size()+1); _args.push_back("cryfs"); for (const char *arg : args) { _args.push_back(arg); } auto &keyGenerator = cpputils::Random::PseudoRandom(); // Write 2x 'pass\n' to stdin so Cryfs can read it as password (+ password confirmation prompt) std::cin.putback('\n'); std::cin.putback('s'); std::cin.putback('s'); std::cin.putback('a'); std::cin.putback('p'); std::cin.putback('\n'); std::cin.putback('s'); std::cin.putback('s'); std::cin.putback('a'); std::cin.putback('p'); // Run Cryfs cryfs::Cli(keyGenerator, cpputils::SCrypt::TestSettings, console, _httpClient()).main(_args.size(), _args.data()); } void EXPECT_EXIT_WITH_HELP_MESSAGE(std::vector args, const std::string &message = "") { EXPECT_RUN_ERROR(args, (message+".*Usage").c_str()); } void EXPECT_RUN_ERROR(std::vector args, const char *message) { EXPECT_EXIT( run(args), ::testing::ExitedWithCode(1), message ); } void EXPECT_RUN_SUCCESS(std::vector args, const boost::filesystem::path &mountDir) { //TODO Make this work when run in background ASSERT(std::find(args.begin(), args.end(), string("-f")) != args.end(), "Currently only works if run in foreground"); std::thread unmountThread([&mountDir] { int returncode = -1; while (returncode != 0) { returncode = cpputils::Subprocess::callAndGetReturnCode(std::string("fusermount -u ") + mountDir.c_str() + " 2>/dev/null"); std::this_thread::sleep_for(std::chrono::milliseconds(50)); // TODO Is this the test case duration? Does a shorter interval make the test case faster? } }); testing::internal::CaptureStdout(); run(args); unmountThread.join(); EXPECT_THAT(testing::internal::GetCapturedStdout(), testing::MatchesRegex(".*Mounting filesystem.*")); } }; #endif test/cryfs/000077500000000000000000000000001300002025200131435ustar00rootroot00000000000000test/cryfs/CMakeLists.txt000066400000000000000000000015541300002025200157100ustar00rootroot00000000000000project (cryfs-test) set(SOURCES config/crypto/CryConfigEncryptorFactoryTest.cpp config/crypto/outer/OuterConfigTest.cpp config/crypto/outer/OuterEncryptorTest.cpp config/crypto/inner/ConcreteInnerEncryptorTest.cpp config/crypto/inner/InnerConfigTest.cpp config/crypto/CryConfigEncryptorTest.cpp config/CompatibilityTest.cpp config/CryConfigCreatorTest.cpp config/CryConfigFileTest.cpp config/CryConfigTest.cpp config/CryCipherTest.cpp config/CryConfigLoaderTest.cpp config/CryConfigConsoleTest.cpp filesystem/CryFsTest.cpp filesystem/CryNodeTest.cpp filesystem/FileSystemTest.cpp ) add_executable(${PROJECT_NAME} ${SOURCES}) target_link_libraries(${PROJECT_NAME} googletest cryfs) add_test(${PROJECT_NAME} ${PROJECT_NAME}) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) test/cryfs/config/000077500000000000000000000000001300002025200144105ustar00rootroot00000000000000test/cryfs/config/CompatibilityTest.cpp000066400000000000000000000146101300002025200205670ustar00rootroot00000000000000#include #include #include #include #include #include #include #include using std::vector; using cpputils::Data; using cpputils::AES256_GCM; using cpputils::Serpent128_CFB; using cpputils::TempFile; namespace bf = boost::filesystem; using namespace cryfs; // Test that config files created with (old) versions of cryfs are still loadable. // The config files created with these cryfs versions are included in the test cases in hex code. // To make tests run fast, the config files should be created using SCrypt::TestSettings. class CryConfigCompatibilityTest: public ::testing::Test { public: TempFile file; CryConfigFile loadConfigFromHex(const string &configFileContentHex) { storeHexToFile(configFileContentHex); return CryConfigFile::load(file.path(), "mypassword").value(); } private: void storeHexToFile(const string &hex) { hexToBinary(hex).StoreToFile(file.path()); } Data hexToBinary(const string &hex) { ASSERT(hex.size()%2 == 0, "Hex codes need to have two characters per byte"); Data result(hex.size()/2); CryptoPP::StringSource(hex, true, new CryptoPP::HexDecoder( new CryptoPP::ArraySink((byte*)result.data(), result.size()) ) ); return result; } }; TEST_F(CryConfigCompatibilityTest, v0_8_1_with_aes_256_gcm) { auto config = loadConfigFromHex("63727966732e636f6e6669673b303b736372797074000004000000000000010000000100000020000000000000000af023e55f804ad303c1dbdf6a2b2bed8cc1ab3d0b2f3312c073628dc041e6f3b92f54fad63a1d4e0ad47a33e65e08080dd4e5bdec0a95fe777705ad68e88eabcb4b91d4f25c32e3e44d6e893421c9efa6d4b2c56d66d0546a410de489b04160b276184ebe7dd77840ce6e414f829bb4399451e055d3406261b4faf5fb52f27e21823f8073df255f96b37edf2c2e58ecee21ae82e3883341024aff326cc4c0929f0ed90473511cbe801d1e34899b3cdb9556477be0127c35375967bf7c8392ad4d30d81479c7923900f532b195b71cff868fa1643d1f9e0a0d7996260691d7b5b8ef3c319c2f2303f822eac389e1d6822e7ee57df60c922fa10fbc7e5970e723df2fdb2a6529c94ea1d2507f55cb9bc3fecab77bf3102e96c6675a618b54bb18e632dd99d3d47fa9e24392535abc8c76f891df76c2193233d6c93851966f69def3f53108be83b30980c98e377186da71297a1b61df76e9f138a3998577a0c486452f1b6a2d89b1e62d78695ac6a062d5a4cf5972de7bc2775fd27d25337f0666250f19d6fe50fe762371befa26de6a9299d7df362780f59ccc475e28c71cc5af9e817e4e2160005393ec7fb385d467e0915e7169934ea986141101c9e6b9c62b8819c51a4422e7fe58e24c3293c3f12173a4c480334cb67c9313df667c65802fb778e20f5a4d6cfd07fffb35c2ae8fdf235882bf0e6371125509872e73bd1bc3faca72948db76d8179e08bf3391bafdede591d5623240ba072ada17c2444116bf8c08ee32367eb86eda02ecfecc625b4bc974428b8f5024df430c352b9849f48774bac1455e7364f7660abc039d2a1134cde596a1e7c3a1a8d68591e8640a2d308e2ea5f03874ba1fa8e9ffec2d1bc1541d124adcd3e9f4ed23343e2148629317e6304c63c2a5ceeeb572246393c8e50196728e0b604aa9e2d49e65680cc53ee343645412239f82500ef3d70a6b6e3335ef8cbcfe4fd46b84f634f6fe96cd1b79207a2120ac2bad668bcdbc377b98448c9afbbda9fe8164dbb48aaa68b0aaa90e52bc419ea2ea1f5e12bb649831af12f1ef14765f312640e22c5508531bd46e3ab3a7f922a91fb83332104609e385d61d3778bc5acb03bee522ea5b791d27026fd589ec2b32f04caaf2ef2effbd50e12430ef42631fdabd061966fde1489b9a1eff3fe40b295d75e36af19ae0e69559b9c81b3bc47b35fef5c7038b83db6729aac522efee897a44895804ffbeb11317a78586f8a3511905514eee86d7cf0a395f5f0af521c72542e544ff359a69150a5e64f00b020d48c20d5716331c3b0ac314eeceaadf8b73516b4273b48046b5c3a3980bade0cc25baf54afb27755d155d4b94fa556deb30d58b1d920cbe01b13479135ff84d6a9345a0d418075ecc66bd10d8d2a07963450256897018f54b2a88fffe9383913565823dbfb71568f5d9af93e542937ecde25c2d4407ad964ece5c09a1f81a57c18a8bb2aa8d9d062415903c98752d70ad7175d0d30b391da77459e9a68a69825b3bb4061bc2504789fc395"); EXPECT_EQ(AES256_GCM::NAME, config.config()->Cipher()); EXPECT_EQ("4A70AD8AC565A5123586D0928B496465", config.config()->RootBlob()); } TEST_F(CryConfigCompatibilityTest, v0_8_1_with_serpent_128_cfb) { auto config = loadConfigFromHex("63727966732e636f6e6669673b303b736372797074000004000000000000010000000100000020000000000000006496611b94011d03433181e83e80c19888a5607392c2117cd377251978fbbf8d46716bd90dbae3c1728b40e7dc086ee97b8a641f1ea6cc31ccda9a1e4a7a1bf4b6ca3d1d0075acba94017c034e87dfad048c9448df24ea7b89b14d60c9f9e0162cfeb420a85759aaa011232cff99e81b25c456cb13690d5cc735e61ef9b01800961a90488073c5320c14a562f0eccd32383d144476d72d9c61733fb3561f5187c2d6069ce7ff4c43df4fc3f7c1d63df239d05a2b377f70816fb31f7a65d8fa667cd14b62a67e2d67adbf841860af2abed9d4c839c510c7fac7cd58210238830a4926917d663500dd3dc2395845297b3726c00228cb08a2bde648d2e9bc2a3e8655f86bc2f5c2b327e71c75b92894dd43b56dfefeeea598fbae9782dca64cc9676df3a954a9ecedbe3f8fe16e790aeec2ac2336984c8fcce74bfebf310d6fdcc0882ee7f2bdd32928aa53b09084e8035ec235ebe971a0b141e5fcab6ce2207f0f399e683ff4994ed638194cc7d3891019a2a674d14180114494e21270e4234a51e28661d4ac908d4f2b2d7c94ffcb74df8c9f08fb68d9a7167a05fae370e041689cce5fb13fdf3ff14863f6c882e6d302eafe5348362c026853a3717756cefb4657a721efab95f6d949b508a98de86885fe37b2f16f1792411ff47c1074e2c2d301e6401f251854b28c329040c8e55184402648bc79710536390b0f99acd2400734a81e8bd573d9a96971a5ef195d85babbe1092e271a69a146d2d4114b855c89b710908d4a584e598b6dd186709d956fbd8b13b2ba3e9115c7d75416b7ac0e6d9dde83d367af00fa8dae54f03079cdf5fa1bac35ff3fbf6440f4fa41d06278fd8a6c3edc80d4ceee900975db2a345d8eda0ce0260d389a8336134a20945c1dde16e475ae537a4407da7f389dce79b439d0d81fa915a7dc4cb018e0d1bd806101ff53970731876850255dd5b7d78bf817112bc74ebae39ecae0aa1555e2a9e61660f4ba373086492e0561efb3bfa98399f899d6909415f19963cef3dc6d154056403ed1f475cbc78981cc949c23686bd71b420ed7ce654578d322f1eeec7413c77c017479f2e19b0c5ebb25ad76e1af8ec3a6b6ba3e092af8ddd624dfd1fccb4a61cc77f5c001fafdd7d2cc6c7b418c6dac97e840bc027ef9d4b237eebc2d1255bc0f796c3de78e31a9ae346734801e0f51dc47f8279164ab35bad3b06a5f74356deec0296c350aae4da560b8d77782195621dca054703433037f28cac2603cdefe52903f25013ad4cf4f29e0e413f89f950d26b4ef129aabf78abf9acae252bc60db373cfe3963fc87e9532056f2f2a7f9f1ddd1a3cf9d0078a5c9cccdcc60714de967556032283075424446ccda9f62a5e31f2b5efbc2256c742e4a300d5bc797e90b3a65fdffe3c5f22f5a885903331dbbb031e51411facb4e80e1728c5b14c9fce196d7d5f1dfeca2fe9b877f45fc1f1c8ec09dd5335eb89accf38fe0e6dbbe77a59c96a49830ce5279f17f4897c64e2aeaec127d8d06adcefa7ac800c1e8"); EXPECT_EQ(Serpent128_CFB::NAME, config.config()->Cipher()); EXPECT_EQ("5821ED3B0739C7EDB6A09590232EA75B", config.config()->RootBlob()); } test/cryfs/config/CryCipherTest.cpp000066400000000000000000000151561300002025200176540ustar00rootroot00000000000000#include #include #include #include #include #include #include #include #include using namespace cryfs; using namespace blockstore::encrypted; using namespace blockstore::testfake; using namespace blockstore; using std::initializer_list; using std::string; using std::vector; using std::find; using boost::none; using testing::MatchesRegex; using namespace cpputils; class CryCipherTest : public ::testing::Test { public: void EXPECT_FINDS_CORRECT_CIPHERS(initializer_list ciphers) { for (const string & cipher : ciphers) { EXPECT_FINDS_CORRECT_CIPHER(cipher); } } void EXPECT_FINDS_CORRECT_CIPHER(const string &cipherName) { EXPECT_EQ(cipherName, CryCiphers::find(cipherName).cipherName()); } template void EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE(const string &cipherName) { const auto &actualCipher = CryCiphers::find(cipherName); Data dataFixture = DataFixture::generate(1024); string encKey = ExpectedCipher::CreateKey(Random::PseudoRandom()).ToString(); _EXPECT_ENCRYPTS_WITH_ACTUAL_BLOCKSTORE_DECRYPTS_CORRECTLY_WITH_EXPECTED_BLOCKSTORE(actualCipher, encKey, std::move(dataFixture)); } template void _EXPECT_ENCRYPTS_WITH_ACTUAL_BLOCKSTORE_DECRYPTS_CORRECTLY_WITH_EXPECTED_BLOCKSTORE(const CryCipher &actualCipher, const std::string &encKey, Data dataFixture) { blockstore::Key key = cpputils::Random::PseudoRandom().getFixedSize(); Data encrypted = _encryptUsingEncryptedBlockStoreWithCipher(actualCipher, encKey, key, dataFixture.copy()); Data decrypted = _decryptUsingEncryptedBlockStoreWithCipher(encKey, key, std::move(encrypted)); EXPECT_EQ(dataFixture, decrypted); } Data _encryptUsingEncryptedBlockStoreWithCipher(const CryCipher &cipher, const std::string &encKey, const blockstore::Key &key, Data data) { unique_ref _baseStore = make_unique_ref(); FakeBlockStore *baseStore = _baseStore.get(); unique_ref encryptedStore = cipher.createEncryptedBlockstore(std::move(_baseStore), encKey); auto created = encryptedStore->tryCreate(key, std::move(data)); EXPECT_NE(none, created); return _loadBlock(baseStore, key); } template Data _decryptUsingEncryptedBlockStoreWithCipher(const std::string &encKey, const blockstore::Key &key, Data data) { unique_ref baseStore = make_unique_ref(); auto created = baseStore->tryCreate(key, std::move(data)); EXPECT_NE(none, created); EncryptedBlockStore encryptedStore(std::move(baseStore), Cipher::EncryptionKey::FromString(encKey)); return _loadBlock(&encryptedStore, key); } Data _loadBlock(BlockStore *store, const blockstore::Key &key) { auto block = store->load(key).value(); Data data(block->size()); std::memcpy(data.data(), block->data(), block->size()); return data; } }; TEST_F(CryCipherTest, FindsCorrectCipher) { EXPECT_FINDS_CORRECT_CIPHERS({ "aes-256-gcm", "aes-256-cfb", "aes-256-gcm", "aes-256-cfb", "twofish-256-gcm", "twofish-256-cfb", "twofish-256-gcm", "twofish-256-cfb", "serpent-256-gcm", "serpent-256-cfb", "serpent-256-gcm", "serpent-256-cfb", "cast-256-gcm", "cast-256-cfb", "mars-448-gcm", "mars-448-cfb", "mars-256-gcm", "mars-256-cfb", "mars-256-gcm", "mars-256-cfb" }); } TEST_F(CryCipherTest, CreatesCorrectEncryptedBlockStore) { EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("aes-256-gcm"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("aes-256-cfb"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("aes-128-gcm"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("aes-128-cfb"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("twofish-256-gcm"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("twofish-256-cfb"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("twofish-128-gcm"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("twofish-128-cfb"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("serpent-256-gcm"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("serpent-256-cfb"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("serpent-128-gcm"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("serpent-128-cfb"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("cast-256-gcm"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("cast-256-cfb"); #if CRYPTOPP_VERSION != 564 EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("mars-448-gcm"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("mars-448-cfb"); #endif EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("mars-256-gcm"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("mars-256-cfb"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("mars-128-gcm"); EXPECT_CREATES_CORRECT_ENCRYPTED_BLOCKSTORE("mars-128-cfb"); } TEST_F(CryCipherTest, SupportedCipherNamesContainsACipher) { vector supportedCipherNames = CryCiphers::supportedCipherNames(); EXPECT_NE(supportedCipherNames.end(), find(supportedCipherNames.begin(), supportedCipherNames.end(), "aes-256-gcm")); } TEST_F(CryCipherTest, ThereIsACipherWithoutWarning) { EXPECT_EQ(none, CryCiphers::find("aes-256-gcm").warning()); } TEST_F(CryCipherTest, ThereIsACipherWithIntegrityWarning) { EXPECT_THAT(CryCiphers::find("aes-256-cfb").warning().get(), MatchesRegex(".*integrity.*")); } #if CRYPTOPP_VERSION != 564 TEST_F(CryCipherTest, EncryptionKeyHasCorrectSize_448) { EXPECT_EQ(Mars448_GCM::EncryptionKey::STRING_LENGTH, CryCiphers::find("mars-448-gcm").createKey(Random::PseudoRandom()).size()); } #endif TEST_F(CryCipherTest, EncryptionKeyHasCorrectSize_256) { EXPECT_EQ(AES256_GCM::EncryptionKey::STRING_LENGTH, CryCiphers::find("aes-256-gcm").createKey(Random::PseudoRandom()).size()); } TEST_F(CryCipherTest, EncryptionKeyHasCorrectSize_128) { EXPECT_EQ(AES128_GCM::EncryptionKey::STRING_LENGTH, CryCiphers::find("aes-128-gcm").createKey(Random::PseudoRandom()).size()); } test/cryfs/config/CryConfigConsoleTest.cpp000066400000000000000000000102031300002025200211560ustar00rootroot00000000000000#include #include #include #include #include #include #include "../testutils/MockConsole.h" using namespace cryfs; using boost::optional; using boost::none; using cpputils::Console; using cpputils::NoninteractiveConsole; using cpputils::unique_ref; using cpputils::make_unique_ref; using std::string; using std::vector; using std::shared_ptr; using std::make_shared; using ::testing::_; using ::testing::Return; using ::testing::Invoke; using ::testing::ValuesIn; using ::testing::HasSubstr; using ::testing::UnorderedElementsAreArray; using ::testing::WithParamInterface; class CryConfigConsoleTest: public ::testing::Test { public: CryConfigConsoleTest() : console(make_shared()), cryconsole(console), noninteractiveCryconsole(make_shared(console)) { } shared_ptr console; CryConfigConsole cryconsole; CryConfigConsole noninteractiveCryconsole; }; class CryConfigConsoleTest_Cipher: public CryConfigConsoleTest {}; #define EXPECT_ASK_FOR_CIPHER() \ EXPECT_CALL(*console, askYesNo("Use default settings?", _)).Times(1).WillOnce(Return(false)); \ EXPECT_CALL(*console, ask(HasSubstr("block cipher"), UnorderedElementsAreArray(CryCiphers::supportedCipherNames()))).Times(1) #define EXPECT_ASK_FOR_BLOCKSIZE() \ EXPECT_CALL(*console, askYesNo("Use default settings?", _)).Times(1).WillOnce(Return(false)); \ EXPECT_CALL(*console, ask(HasSubstr("block size"), _)).Times(1) TEST_F(CryConfigConsoleTest_Cipher, AsksForCipher) { EXPECT_ASK_FOR_CIPHER().WillOnce(ChooseAnyCipher()); cryconsole.askCipher(); } TEST_F(CryConfigConsoleTest_Cipher, ChooseDefaultCipher) { EXPECT_CALL(*console, askYesNo("Use default settings?", _)).Times(1).WillOnce(Return(true)); EXPECT_CALL(*console, ask(HasSubstr("block cipher"), _)).Times(0); string cipher = cryconsole.askCipher(); EXPECT_EQ(CryConfigConsole::DEFAULT_CIPHER, cipher); } TEST_F(CryConfigConsoleTest_Cipher, ChooseDefaultCipherWhenNoninteractiveEnvironment) { EXPECT_CALL(*console, askYesNo(HasSubstr("default"), _)).Times(0); EXPECT_CALL(*console, ask(HasSubstr("block cipher"), _)).Times(0); string cipher = noninteractiveCryconsole.askCipher(); EXPECT_EQ(CryConfigConsole::DEFAULT_CIPHER, cipher); } TEST_F(CryConfigConsoleTest_Cipher, AsksForBlocksize) { EXPECT_ASK_FOR_BLOCKSIZE().WillOnce(Return(0)); cryconsole.askBlocksizeBytes(); } TEST_F(CryConfigConsoleTest_Cipher, ChooseDefaultBlocksizeWhenNoninteractiveEnvironment) { EXPECT_CALL(*console, askYesNo(HasSubstr("default"), _)).Times(0); EXPECT_CALL(*console, ask(HasSubstr("block size"), _)).Times(0); uint32_t blocksize = noninteractiveCryconsole.askBlocksizeBytes(); EXPECT_EQ(CryConfigConsole::DEFAULT_BLOCKSIZE_BYTES, blocksize); } class CryConfigConsoleTest_Cipher_Choose: public CryConfigConsoleTest_Cipher, public ::testing::WithParamInterface { public: string cipherName = GetParam(); optional cipherWarning = CryCiphers::find(cipherName).warning(); void EXPECT_DONT_SHOW_WARNING() { EXPECT_CALL(*console, askYesNo(_, _)).Times(0); } void EXPECT_SHOW_WARNING(const string &warning) { EXPECT_CALL(*console, askYesNo(HasSubstr(warning), _)).WillOnce(Return(true)); } }; TEST_P(CryConfigConsoleTest_Cipher_Choose, ChoosesCipherCorrectly) { if (cipherWarning == none) { EXPECT_DONT_SHOW_WARNING(); } else { EXPECT_SHOW_WARNING(*cipherWarning); } EXPECT_ASK_FOR_CIPHER().WillOnce(ChooseCipher(cipherName)); string chosenCipher = cryconsole.askCipher(); EXPECT_EQ(cipherName, chosenCipher); } INSTANTIATE_TEST_CASE_P(CryConfigConsoleTest_Cipher_Choose, CryConfigConsoleTest_Cipher_Choose, ValuesIn(CryCiphers::supportedCipherNames())); test/cryfs/config/CryConfigCreatorTest.cpp000066400000000000000000000145001300002025200211570ustar00rootroot00000000000000#include #include #include #include #include #include "../testutils/MockConsole.h" #include #include using namespace cryfs; using boost::optional; using boost::none; using cpputils::Console; using cpputils::NoninteractiveConsole; using cpputils::unique_ref; using cpputils::make_unique_ref; using std::string; using std::vector; using std::shared_ptr; using std::make_shared; using ::testing::_; using ::testing::Return; using ::testing::Invoke; using ::testing::ValuesIn; using ::testing::HasSubstr; using ::testing::UnorderedElementsAreArray; using ::testing::WithParamInterface; #define EXPECT_ASK_TO_USE_DEFAULT_SETTINGS() \ EXPECT_CALL(*console, askYesNo("Use default settings?", true)).Times(1) #define EXPECT_DOES_NOT_ASK_TO_USE_DEFAULT_SETTINGS() \ EXPECT_CALL(*console, askYesNo("Use default settings?", true)).Times(0) #define EXPECT_ASK_FOR_CIPHER() \ EXPECT_CALL(*console, ask(HasSubstr("block cipher"), UnorderedElementsAreArray(CryCiphers::supportedCipherNames()))).Times(1) #define EXPECT_DOES_NOT_ASK_FOR_CIPHER() \ EXPECT_CALL(*console, ask(HasSubstr("block cipher"), _)).Times(0) #define EXPECT_ASK_FOR_BLOCKSIZE() \ EXPECT_CALL(*console, ask(HasSubstr("block size"), _)).Times(1) #define EXPECT_DOES_NOT_ASK_FOR_BLOCKSIZE() \ EXPECT_CALL(*console, ask(HasSubstr("block size"), _)).Times(0) class CryConfigCreatorTest: public ::testing::Test { public: CryConfigCreatorTest() : console(make_shared()), creator(console, cpputils::Random::PseudoRandom()), noninteractiveCreator(make_shared(console), cpputils::Random::PseudoRandom()) { EXPECT_CALL(*console, ask(HasSubstr("block cipher"), _)).WillRepeatedly(ChooseAnyCipher()); EXPECT_CALL(*console, ask(HasSubstr("block size"), _)).WillRepeatedly(Return(0)); } shared_ptr console; CryConfigCreator creator; CryConfigCreator noninteractiveCreator; void AnswerNoToDefaultSettings() { EXPECT_ASK_TO_USE_DEFAULT_SETTINGS().WillOnce(Return(false)); } void AnswerYesToDefaultSettings() { EXPECT_ASK_TO_USE_DEFAULT_SETTINGS().WillOnce(Return(true)); } }; TEST_F(CryConfigCreatorTest, DoesAskForCipherIfNotSpecified) { AnswerNoToDefaultSettings(); EXPECT_ASK_FOR_CIPHER().WillOnce(ChooseAnyCipher()); CryConfig config = creator.create(none, none); } TEST_F(CryConfigCreatorTest, DoesNotAskForCipherIfSpecified) { AnswerNoToDefaultSettings(); EXPECT_DOES_NOT_ASK_FOR_CIPHER(); CryConfig config = creator.create(string("aes-256-gcm"), none); } TEST_F(CryConfigCreatorTest, DoesNotAskForCipherIfUsingDefaultSettings) { AnswerYesToDefaultSettings(); EXPECT_DOES_NOT_ASK_FOR_CIPHER(); CryConfig config = creator.create(none, none); } TEST_F(CryConfigCreatorTest, DoesNotAskForCipherIfNoninteractive) { EXPECT_DOES_NOT_ASK_TO_USE_DEFAULT_SETTINGS(); EXPECT_DOES_NOT_ASK_FOR_CIPHER(); CryConfig config = noninteractiveCreator.create(none, none); } TEST_F(CryConfigCreatorTest, DoesAskForBlocksizeIfNotSpecified) { AnswerNoToDefaultSettings(); EXPECT_ASK_FOR_BLOCKSIZE().WillOnce(Return(1)); CryConfig config = creator.create(none, none); } TEST_F(CryConfigCreatorTest, DoesNotAskForBlocksizeIfSpecified) { AnswerNoToDefaultSettings(); EXPECT_DOES_NOT_ASK_FOR_BLOCKSIZE(); CryConfig config = creator.create(none, 10*1024u); } TEST_F(CryConfigCreatorTest, DoesNotAskForBlocksizeIfNoninteractive) { EXPECT_DOES_NOT_ASK_TO_USE_DEFAULT_SETTINGS(); EXPECT_DOES_NOT_ASK_FOR_BLOCKSIZE(); CryConfig config = noninteractiveCreator.create(none, none); } TEST_F(CryConfigCreatorTest, DoesNotAskForBlocksizeIfUsingDefaultSettings) { AnswerYesToDefaultSettings(); EXPECT_DOES_NOT_ASK_FOR_BLOCKSIZE(); CryConfig config = creator.create(none, none); } TEST_F(CryConfigCreatorTest, ChoosesEmptyRootBlobId) { AnswerNoToDefaultSettings(); CryConfig config = creator.create(none, none); EXPECT_EQ("", config.RootBlob()); // This tells CryFS to create a new root blob } #if CRYPTOPP_VERSION != 564 TEST_F(CryConfigCreatorTest, ChoosesValidEncryptionKey_448) { AnswerNoToDefaultSettings(); EXPECT_ASK_FOR_CIPHER().WillOnce(ChooseCipher("mars-448-gcm")); CryConfig config = creator.create(none, none); cpputils::Mars448_GCM::EncryptionKey::FromString(config.EncryptionKey()); // This crashes if invalid } #endif TEST_F(CryConfigCreatorTest, ChoosesValidEncryptionKey_256) { AnswerNoToDefaultSettings(); EXPECT_ASK_FOR_CIPHER().WillOnce(ChooseCipher("aes-256-gcm")); CryConfig config = creator.create(none, none); cpputils::AES256_GCM::EncryptionKey::FromString(config.EncryptionKey()); // This crashes if invalid } TEST_F(CryConfigCreatorTest, ChoosesValidEncryptionKey_128) { AnswerNoToDefaultSettings(); EXPECT_ASK_FOR_CIPHER().WillOnce(ChooseCipher("aes-128-gcm")); CryConfig config = creator.create(none, none); cpputils::AES128_GCM::EncryptionKey::FromString(config.EncryptionKey()); // This crashes if invalid } TEST_F(CryConfigCreatorTest, DoesNotAskForAnythingIfEverythingIsSpecified) { EXPECT_DOES_NOT_ASK_TO_USE_DEFAULT_SETTINGS(); EXPECT_DOES_NOT_ASK_FOR_CIPHER(); CryConfig config = noninteractiveCreator.create(string("aes-256-gcm"), 10*1024u); } TEST_F(CryConfigCreatorTest, SetsCorrectCreatedWithVersion) { CryConfig config = noninteractiveCreator.create(none, none); EXPECT_EQ(gitversion::VersionString(), config.CreatedWithVersion()); } TEST_F(CryConfigCreatorTest, SetsCorrectVersion) { CryConfig config = noninteractiveCreator.create(none, none); EXPECT_EQ(gitversion::VersionString(), config.Version()); } //TODO Add test cases ensuring that the values entered are correctly taken test/cryfs/config/CryConfigFileTest.cpp000066400000000000000000000150571300002025200204470ustar00rootroot00000000000000#include #include #include using namespace cryfs; using cpputils::TempFile; using std::string; using boost::optional; using boost::none; using cpputils::SCrypt; using cpputils::Data; namespace bf = boost::filesystem; //gtest/boost::optional workaround for working with optional namespace boost { inline std::ostream &operator<<(std::ostream &out, const CryConfigFile &file) { UNUSED(file); out << "ConfigFile()"; return out; } } #include class CryConfigFileTest: public ::testing::Test { public: CryConfigFileTest(): file(false) {} TempFile file; CryConfig Config() { CryConfig result; result.SetCipher("aes-256-gcm"); return result; } CryConfigFile CreateAndLoadEmpty(const string &password = "mypassword") { Create(Config(), password); return Load().value(); } void Create(CryConfig cfg, const string &password = "mypassword") { CryConfigFile::create(file.path(), std::move(cfg), password, SCrypt::TestSettings); } optional Load(const string &password = "mypassword") { return CryConfigFile::load(file.path(), password); } void CreateWithCipher(const string &cipher) { return CreateWithCipher(cipher, file); } void CreateWithCipher(const string &cipher, const TempFile &tempFile) { CryConfig cfg; cfg.SetCipher(cipher); CryConfigFile::create(tempFile.path(), std::move(cfg), "mypassword", SCrypt::TestSettings); } }; TEST_F(CryConfigFileTest, DoesntLoadIfWrongPassword) { Create(Config(), "mypassword"); auto loaded = Load("mypassword2"); EXPECT_EQ(none, loaded); } TEST_F(CryConfigFileTest, RootBlob_Init) { CryConfigFile created = CreateAndLoadEmpty(); EXPECT_EQ("", created.config()->RootBlob()); } TEST_F(CryConfigFileTest, RootBlob_CreateAndLoad) { CryConfig cfg = Config(); cfg.SetRootBlob("rootblobid"); Create(std::move(cfg)); CryConfigFile loaded = Load().value(); EXPECT_EQ("rootblobid", loaded.config()->RootBlob()); } TEST_F(CryConfigFileTest, RootBlob_SaveAndLoad) { CryConfigFile created = CreateAndLoadEmpty(); created.config()->SetRootBlob("rootblobid"); created.save(); CryConfigFile loaded = Load().value(); EXPECT_EQ("rootblobid", loaded.config()->RootBlob()); } TEST_F(CryConfigFileTest, EncryptionKey_Init) { CryConfigFile created = CreateAndLoadEmpty(); EXPECT_EQ("", created.config()->EncryptionKey()); } TEST_F(CryConfigFileTest, EncryptionKey_CreateAndLoad) { CryConfig cfg = Config(); cfg.SetEncryptionKey("encryptionkey"); Create(std::move(cfg)); CryConfigFile loaded = Load().value(); EXPECT_EQ("encryptionkey", loaded.config()->EncryptionKey()); } TEST_F(CryConfigFileTest, EncryptionKey_SaveAndLoad) { CryConfigFile created = CreateAndLoadEmpty(); created.config()->SetEncryptionKey("encryptionkey"); created.save(); CryConfigFile loaded = Load().value(); EXPECT_EQ("encryptionkey", loaded.config()->EncryptionKey()); } TEST_F(CryConfigFileTest, Cipher_Init) { CryConfigFile created = CreateAndLoadEmpty(); EXPECT_EQ("aes-256-gcm", created.config()->Cipher()); } TEST_F(CryConfigFileTest, Cipher_CreateAndLoad) { CryConfig cfg = Config(); cfg.SetCipher("twofish-128-cfb"); Create(std::move(cfg)); CryConfigFile loaded = Load().value(); EXPECT_EQ("twofish-128-cfb", loaded.config()->Cipher()); } TEST_F(CryConfigFileTest, Cipher_SaveAndLoad) { CryConfigFile created = CreateAndLoadEmpty(); created.config()->SetCipher("twofish-128-cfb"); created.save(); CryConfigFile loaded = Load().value(); EXPECT_EQ("twofish-128-cfb", loaded.config()->Cipher()); } TEST_F(CryConfigFileTest, Version_Init) { CryConfigFile created = CreateAndLoadEmpty(); EXPECT_EQ("", created.config()->Version()); } TEST_F(CryConfigFileTest, Version_CreateAndLoad) { CryConfig cfg = Config(); cfg.SetVersion("0.9.2"); Create(std::move(cfg)); CryConfigFile loaded = Load().value(); EXPECT_EQ("0.9.2", loaded.config()->Version()); } TEST_F(CryConfigFileTest, Version_SaveAndLoad) { CryConfigFile created = CreateAndLoadEmpty(); created.config()->SetVersion("0.9.2"); created.save(); CryConfigFile loaded = Load().value(); EXPECT_EQ("0.9.2", loaded.config()->Version()); } TEST_F(CryConfigFileTest, CreatedWithVersion_Init) { CryConfigFile created = CreateAndLoadEmpty(); EXPECT_EQ("", created.config()->Version()); } TEST_F(CryConfigFileTest, CreatedWithVersion_CreateAndLoad) { CryConfig cfg = Config(); cfg.SetCreatedWithVersion("0.9.2"); Create(std::move(cfg)); CryConfigFile loaded = Load().value(); EXPECT_EQ("0.9.2", loaded.config()->CreatedWithVersion()); } TEST_F(CryConfigFileTest, CreatedWithVersion_SaveAndLoad) { CryConfigFile created = CreateAndLoadEmpty(); created.config()->SetCreatedWithVersion("0.9.2"); created.save(); CryConfigFile loaded = Load().value(); EXPECT_EQ("0.9.2", loaded.config()->CreatedWithVersion()); } //Test that the encrypted config file has the same size, no matter how big the plaintext config data. TEST_F(CryConfigFileTest, ConfigFileHasFixedSize) { TempFile file1(false); TempFile file2(false); //It is important to have different cipher name lengths here, because they're on the outer encryption level. //So this ensures that there also is a padding happening on the outer encryption level. CreateWithCipher("aes-128-gcm", file1); // Short cipher name and short key CreateWithCipher("twofish-256-cfb", file2); // Long cipher name and long key EXPECT_EQ(bf::file_size(file1.path()), bf::file_size(file2.path())); } TEST_F(CryConfigFileTest, CanSaveAndLoadModififedCipher) { CreateWithCipher("aes-256-gcm"); CryConfigFile created = Load().value(); EXPECT_EQ("aes-256-gcm", created.config()->Cipher()); created.config()->SetCipher("twofish-128-cfb"); created.save(); CryConfigFile loaded = Load().value(); EXPECT_EQ("twofish-128-cfb", loaded.config()->Cipher()); } TEST_F(CryConfigFileTest, FailsIfConfigFileIsEncryptedWithACipherDifferentToTheOneSpecifiedByTheUser) { auto encryptor = CryConfigEncryptorFactory::deriveKey("mypassword", SCrypt::TestSettings); auto config = Config(); config.SetCipher("aes-256-gcm"); Data encrypted = encryptor->encrypt(config.save(), "aes-256-cfb"); encrypted.StoreToFile(file.path()); auto loaded = Load("mypassword"); EXPECT_EQ(none, loaded); } test/cryfs/config/CryConfigLoaderTest.cpp000066400000000000000000000237611300002025200207770ustar00rootroot00000000000000#include #include #include "../testutils/MockConsole.h" #include #include #include #include #include #include #include using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::TempFile; using cpputils::SCrypt; using cpputils::DataFixture; using cpputils::NoninteractiveConsole; using boost::optional; using boost::none; using std::string; using std::ostream; using std::make_shared; using ::testing::Return; using ::testing::_; using ::testing::HasSubstr; using namespace cryfs; // This is needed for google test namespace boost { inline ostream &operator<<(ostream &stream, const CryConfigFile &) { return stream << "CryConfigFile()"; } } #include class CryConfigLoaderTest: public ::testing::Test, public TestWithMockConsole { public: CryConfigLoaderTest(): file(false) { console = mockConsole(); } CryConfigLoader loader(const string &password, bool noninteractive, const optional &cipher = none) { auto askPassword = [password] { return password;}; if(noninteractive) { return CryConfigLoader(make_shared(console), cpputils::Random::PseudoRandom(), SCrypt::TestSettings, askPassword, askPassword, cipher, none); } else { return CryConfigLoader(console, cpputils::Random::PseudoRandom(), SCrypt::TestSettings, askPassword, askPassword, cipher, none); } } CryConfigFile Create(const string &password = "mypassword", const optional &cipher = none, bool noninteractive = false) { EXPECT_FALSE(file.exists()); return loader(password, noninteractive, cipher).loadOrCreate(file.path()).value(); } optional Load(const string &password = "mypassword", const optional &cipher = none, bool noninteractive = false) { EXPECT_TRUE(file.exists()); return loader(password, noninteractive, cipher).loadOrCreate(file.path()); } void CreateWithRootBlob(const string &rootBlob, const string &password = "mypassword") { auto cfg = loader(password, false).loadOrCreate(file.path()).value(); cfg.config()->SetRootBlob(rootBlob); cfg.save(); } void CreateWithCipher(const string &cipher, const string &password = "mypassword") { auto cfg = loader(password, false).loadOrCreate(file.path()).value(); cfg.config()->SetCipher(cipher); cfg.save(); } void CreateWithEncryptionKey(const string &encKey, const string &password = "mypassword") { auto cfg = loader(password, false).loadOrCreate(file.path()).value(); cfg.config()->SetEncryptionKey(encKey); cfg.save(); } void CreateWithVersion(const string &version, const string &password = "mypassword") { auto cfg = loader(password, false).loadOrCreate(file.path()).value(); cfg.config()->SetVersion(version); cfg.config()->SetCreatedWithVersion(version); cfg.save(); } void CreateWithFilesystemID(const CryConfig::FilesystemID &filesystemId, const string &password = "mypassword") { auto cfg = loader(password, false).loadOrCreate(file.path()).value(); cfg.config()->SetFilesystemId(filesystemId); cfg.save(); } string olderVersion() { string olderVersion; if (std::stol(gitversion::MinorVersion()) > 0) { olderVersion = gitversion::MajorVersion() + "." + std::to_string(std::stol(gitversion::MinorVersion()) - 1); } else { olderVersion = std::to_string(std::stol(gitversion::MajorVersion()) - 1) + "." + gitversion::MinorVersion(); } assert(gitversion::VersionCompare::isOlderThan(olderVersion, gitversion::VersionString())); return olderVersion; } string newerVersion() { string newerVersion = gitversion::MajorVersion()+"."+std::to_string(std::stol(gitversion::MinorVersion())+1); assert(gitversion::VersionCompare::isOlderThan(gitversion::VersionString(), newerVersion)); return newerVersion; } std::shared_ptr console; TempFile file; }; TEST_F(CryConfigLoaderTest, CreatesNewIfNotExisting) { EXPECT_FALSE(file.exists()); Create(); EXPECT_TRUE(file.exists()); } TEST_F(CryConfigLoaderTest, DoesntCrashIfExisting) { Create(); Load(); } TEST_F(CryConfigLoaderTest, DoesntLoadIfWrongPassword) { Create("mypassword"); auto loaded = Load("mypassword2"); EXPECT_EQ(none, loaded); } TEST_F(CryConfigLoaderTest, DoesntLoadIfDifferentCipher) { Create("mypassword", string("aes-256-gcm"), false); try { Load("mypassword", string("aes-256-cfb"), false); EXPECT_TRUE(false); // Should throw exception } catch (const std::runtime_error &e) { EXPECT_EQ(string("Filesystem uses aes-256-gcm cipher and not aes-256-cfb as specified."), e.what()); } } TEST_F(CryConfigLoaderTest, DoesntLoadIfDifferentCipher_Noninteractive) { Create("mypassword", string("aes-256-gcm"), true); try { Load("mypassword", string("aes-256-cfb"), true); EXPECT_TRUE(false); // Should throw exception } catch (const std::runtime_error &e) { EXPECT_EQ(string("Filesystem uses aes-256-gcm cipher and not aes-256-cfb as specified."), e.what()); } } TEST_F(CryConfigLoaderTest, DoesLoadIfSameCipher) { Create("mypassword", string("aes-256-gcm")); Load("mypassword", string("aes-256-gcm")); } TEST_F(CryConfigLoaderTest, DoesLoadIfSameCipher_Noninteractive) { Create("mypassword", string("aes-128-gcm"), true); Load("mypassword", string("aes-128-gcm"), true); } TEST_F(CryConfigLoaderTest, RootBlob_Load) { CreateWithRootBlob("rootblobid"); auto loaded = Load().value(); EXPECT_EQ("rootblobid", loaded.config()->RootBlob()); } TEST_F(CryConfigLoaderTest, RootBlob_Create) { auto created = Create(); EXPECT_EQ("", created.config()->RootBlob()); } TEST_F(CryConfigLoaderTest, EncryptionKey_Load) { CreateWithEncryptionKey("encryptionkey"); auto loaded = Load().value(); EXPECT_EQ("encryptionkey", loaded.config()->EncryptionKey()); } TEST_F(CryConfigLoaderTest, EncryptionKey_Create) { auto created = Create(); //aes-256-gcm is the default cipher chosen by mockConsole() cpputils::AES256_GCM::EncryptionKey::FromString(created.config()->EncryptionKey()); // This crashes if key is invalid } TEST_F(CryConfigLoaderTest, Cipher_Load) { CreateWithCipher("twofish-128-cfb"); auto loaded = Load().value(); EXPECT_EQ("twofish-128-cfb", loaded.config()->Cipher()); } TEST_F(CryConfigLoaderTest, Cipher_Create) { auto created = Create(); //aes-256-gcm is the default cipher chosen by mockConsole() EXPECT_EQ("aes-256-gcm", created.config()->Cipher()); } TEST_F(CryConfigLoaderTest, Version_Load) { CreateWithVersion("0.9.2"); auto loaded = Load().value(); EXPECT_EQ(gitversion::VersionString(), loaded.config()->Version()); EXPECT_EQ("0.9.2", loaded.config()->CreatedWithVersion()); } TEST_F(CryConfigLoaderTest, Version_Load_IsStoredAndNotOnlyOverwrittenInMemoryOnLoad) { CreateWithVersion("0.9.2", "mypassword"); Load().value(); auto configFile = CryConfigFile::load(file.path(), "mypassword").value(); EXPECT_EQ(gitversion::VersionString(), configFile.config()->Version()); EXPECT_EQ("0.9.2", configFile.config()->CreatedWithVersion()); } TEST_F(CryConfigLoaderTest, Version_Create) { auto created = Create(); EXPECT_EQ(gitversion::VersionString(), created.config()->Version()); EXPECT_EQ(gitversion::VersionString(), created.config()->CreatedWithVersion()); } TEST_F(CryConfigLoaderTest, FilesystemID_Load) { auto fixture = DataFixture::generateFixedSize(); CreateWithFilesystemID(fixture); auto loaded = Load().value(); EXPECT_EQ(fixture, loaded.config()->FilesystemId()); } TEST_F(CryConfigLoaderTest, FilesystemID_Create) { auto created = Create(); EXPECT_NE(CryConfig::FilesystemID::Null(), created.config()->FilesystemId()); } TEST_F(CryConfigLoaderTest, AsksWhenLoadingNewerFilesystem_AnswerYes) { EXPECT_CALL(*console, askYesNo(HasSubstr("should not be opened with older versions"), false)).Times(1).WillOnce(Return(true)); string version = newerVersion(); CreateWithVersion(version); EXPECT_NE(boost::none, Load()); } TEST_F(CryConfigLoaderTest, AsksWhenLoadingNewerFilesystem_AnswerNo) { EXPECT_CALL(*console, askYesNo(HasSubstr("should not be opened with older versions"), false)).Times(1).WillOnce(Return(false)); string version = newerVersion(); CreateWithVersion(version); try { Load(); EXPECT_TRUE(false); // expect throw } catch (const std::runtime_error &e) { EXPECT_THAT(e.what(), HasSubstr("Please update your CryFS version.")); } } TEST_F(CryConfigLoaderTest, AsksWhenMigratingOlderFilesystem) { EXPECT_CALL(*console, askYesNo(HasSubstr("Do you want to migrate it?"), false)).Times(1).WillOnce(Return(true)); string version = olderVersion(); CreateWithVersion(version); EXPECT_NE(boost::none, Load()); } TEST_F(CryConfigLoaderTest, DoesNotAskForMigrationWhenCorrectVersion) { EXPECT_CALL(*console, askYesNo(HasSubstr("Do you want to migrate it?"), false)).Times(0); CreateWithVersion(gitversion::VersionString()); EXPECT_NE(boost::none, Load()); } TEST_F(CryConfigLoaderTest, DontMigrateWhenAnsweredNo) { EXPECT_CALL(*console, askYesNo(HasSubstr("Do you want to migrate it?"), false)).Times(1).WillOnce(Return(false)); string version = olderVersion(); CreateWithVersion(version); try { Load(); EXPECT_TRUE(false); // expect throw } catch (const std::runtime_error &e) { EXPECT_THAT(e.what(), HasSubstr("It has to be migrated.")); } } test/cryfs/config/CryConfigTest.cpp000066400000000000000000000110401300002025200176330ustar00rootroot00000000000000#include #include #include using namespace cryfs; using cpputils::Data; using cpputils::DataFixture; class CryConfigTest: public ::testing::Test { public: CryConfig cfg; CryConfig SaveAndLoad(CryConfig cfg) { Data configData = cfg.save(); return CryConfig::load(configData); } }; TEST_F(CryConfigTest, RootBlob_Init) { EXPECT_EQ("", cfg.RootBlob()); } TEST_F(CryConfigTest, RootBlob) { cfg.SetRootBlob("rootblobid"); EXPECT_EQ("rootblobid", cfg.RootBlob()); } TEST_F(CryConfigTest, RootBlob_AfterMove) { cfg.SetRootBlob("rootblobid"); CryConfig moved = std::move(cfg); EXPECT_EQ("rootblobid", moved.RootBlob()); } TEST_F(CryConfigTest, RootBlob_AfterSaveAndLoad) { cfg.SetRootBlob("rootblobid"); CryConfig loaded = SaveAndLoad(std::move(cfg)); EXPECT_EQ("rootblobid", loaded.RootBlob()); } TEST_F(CryConfigTest, EncryptionKey_Init) { EXPECT_EQ("", cfg.EncryptionKey()); } TEST_F(CryConfigTest, EncryptionKey) { cfg.SetEncryptionKey("enckey"); EXPECT_EQ("enckey", cfg.EncryptionKey()); } TEST_F(CryConfigTest, EncryptionKey_AfterMove) { cfg.SetEncryptionKey("enckey"); CryConfig moved = std::move(cfg); EXPECT_EQ("enckey", moved.EncryptionKey()); } TEST_F(CryConfigTest, EncryptionKey_AfterSaveAndLoad) { cfg.SetEncryptionKey("enckey"); CryConfig loaded = SaveAndLoad(std::move(cfg)); EXPECT_EQ("enckey", loaded.EncryptionKey()); } TEST_F(CryConfigTest, Cipher_Init) { EXPECT_EQ("", cfg.Cipher()); } TEST_F(CryConfigTest, Cipher) { cfg.SetCipher("mycipher"); EXPECT_EQ("mycipher", cfg.Cipher()); } TEST_F(CryConfigTest, Cipher_AfterMove) { cfg.SetCipher("mycipher"); CryConfig moved = std::move(cfg); EXPECT_EQ("mycipher", moved.Cipher()); } TEST_F(CryConfigTest, Cipher_AfterSaveAndLoad) { cfg.SetCipher("mycipher"); CryConfig loaded = SaveAndLoad(std::move(cfg)); EXPECT_EQ("mycipher", loaded.Cipher()); } TEST_F(CryConfigTest, Version_Init) { EXPECT_EQ("", cfg.Version()); } TEST_F(CryConfigTest, Version) { cfg.SetVersion("0.9.1"); EXPECT_EQ("0.9.1", cfg.Version()); } TEST_F(CryConfigTest, Version_AfterMove) { cfg.SetVersion("0.9.1"); CryConfig moved = std::move(cfg); EXPECT_EQ("0.9.1", moved.Version()); } TEST_F(CryConfigTest, Version_AfterSaveAndLoad) { cfg.SetVersion("0.9.2"); CryConfig loaded = SaveAndLoad(std::move(cfg)); EXPECT_EQ("0.9.2", loaded.Version()); } TEST_F(CryConfigTest, CreatedWithVersion_Init) { EXPECT_EQ("", cfg.CreatedWithVersion()); } TEST_F(CryConfigTest, CreatedWithVersion) { cfg.SetCreatedWithVersion("0.9.3"); EXPECT_EQ("0.9.3", cfg.CreatedWithVersion()); } TEST_F(CryConfigTest, CreatedWithVersion_AfterMove) { cfg.SetCreatedWithVersion("0.9.3"); CryConfig moved = std::move(cfg); EXPECT_EQ("0.9.3", moved.CreatedWithVersion()); } TEST_F(CryConfigTest, CreatedWithVersion_AfterSaveAndLoad) { cfg.SetCreatedWithVersion("0.9.3"); CryConfig loaded = SaveAndLoad(std::move(cfg)); EXPECT_EQ("0.9.3", loaded.CreatedWithVersion()); } TEST_F(CryConfigTest, BlocksizeBytes_Init) { EXPECT_EQ(0u, cfg.BlocksizeBytes()); } TEST_F(CryConfigTest, BlocksizeBytes) { cfg.SetBlocksizeBytes(4*1024*1024); EXPECT_EQ(4*1024*1024u, cfg.BlocksizeBytes()); } TEST_F(CryConfigTest, BlocksizeBytes_AfterMove) { cfg.SetBlocksizeBytes(32*1024); CryConfig moved = std::move(cfg); EXPECT_EQ(32*1024u, moved.BlocksizeBytes()); } TEST_F(CryConfigTest, BlocksizeBytes_AfterSaveAndLoad) { cfg.SetBlocksizeBytes(10*1024); CryConfig loaded = SaveAndLoad(std::move(cfg)); EXPECT_EQ(10*1024u, loaded.BlocksizeBytes()); } TEST_F(CryConfigTest, FilesystemID_Init) { EXPECT_EQ(CryConfig::FilesystemID::Null(), cfg.FilesystemId()); } TEST_F(CryConfigTest, FilesystemID) { auto fixture = DataFixture::generateFixedSize(); cfg.SetFilesystemId(fixture); EXPECT_EQ(fixture, cfg.FilesystemId()); } TEST_F(CryConfigTest, FilesystemID_AfterMove) { auto fixture = DataFixture::generateFixedSize(); cfg.SetFilesystemId(fixture); CryConfig moved = std::move(cfg); EXPECT_EQ(fixture, moved.FilesystemId()); } TEST_F(CryConfigTest, FilesystemID_AfterSaveAndLoad) { auto fixture = DataFixture::generateFixedSize(); cfg.SetFilesystemId(fixture); CryConfig loaded = SaveAndLoad(std::move(cfg)); EXPECT_EQ(fixture, loaded.FilesystemId()); } test/cryfs/config/crypto/000077500000000000000000000000001300002025200157305ustar00rootroot00000000000000test/cryfs/config/crypto/CryConfigEncryptorFactoryTest.cpp000066400000000000000000000051051300002025200244160ustar00rootroot00000000000000#include #include #include #include using cpputils::SCrypt; using cpputils::AES256_GCM; using cpputils::Data; using cpputils::DataFixture; using boost::none; using std::ostream; using namespace cryfs; // This is needed for google test namespace boost { inline ostream &operator<<(ostream &stream, const CryConfigEncryptor::Decrypted &) { return stream << "CryConfigEncryptor::Decrypted()"; } } #include class CryConfigEncryptorFactoryTest: public ::testing::Test { public: }; TEST_F(CryConfigEncryptorFactoryTest, EncryptAndDecrypt_SameEncryptor) { auto encryptor = CryConfigEncryptorFactory::deriveKey("mypassword", SCrypt::TestSettings); Data encrypted = encryptor->encrypt(DataFixture::generate(400), AES256_GCM::NAME); auto decrypted = encryptor->decrypt(encrypted).value(); EXPECT_EQ(DataFixture::generate(400), decrypted.data); } TEST_F(CryConfigEncryptorFactoryTest, EncryptAndDecrypt_NewEncryptor) { auto encryptor = CryConfigEncryptorFactory::deriveKey("mypassword", SCrypt::TestSettings); Data encrypted = encryptor->encrypt(DataFixture::generate(400), AES256_GCM::NAME); auto loadedEncryptor = CryConfigEncryptorFactory::loadKey(encrypted, "mypassword").value(); auto decrypted = loadedEncryptor->decrypt(encrypted).value(); EXPECT_EQ(DataFixture::generate(400), decrypted.data); } TEST_F(CryConfigEncryptorFactoryTest, DoesntDecryptWithWrongPassword) { auto encryptor = CryConfigEncryptorFactory::deriveKey("mypassword", SCrypt::TestSettings); Data encrypted = encryptor->encrypt(DataFixture::generate(400), AES256_GCM::NAME); auto loadedEncryptor = CryConfigEncryptorFactory::loadKey(encrypted, "wrongpassword").value(); auto decrypted = loadedEncryptor->decrypt(encrypted); EXPECT_EQ(none, decrypted); } TEST_F(CryConfigEncryptorFactoryTest, DoesntDecryptWithWrongPassword_EmptyData) { auto encryptor = CryConfigEncryptorFactory::deriveKey("mypassword", SCrypt::TestSettings); Data encrypted = encryptor->encrypt(Data(0), AES256_GCM::NAME); auto loadedEncryptor = CryConfigEncryptorFactory::loadKey(encrypted, "wrongpassword").value(); auto decrypted = loadedEncryptor->decrypt(encrypted); EXPECT_EQ(none, decrypted); } TEST_F(CryConfigEncryptorFactoryTest, DoesntDecryptInvalidData) { auto loadedEncryptor = CryConfigEncryptorFactory::loadKey(Data(0), "mypassword"); EXPECT_EQ(none, loadedEncryptor); }test/cryfs/config/crypto/CryConfigEncryptorTest.cpp000066400000000000000000000121401300002025200230630ustar00rootroot00000000000000#include #include #include #include using std::ostream; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::DataFixture; using cpputils::Data; using cpputils::FixedSizeData; using cpputils::AES128_CFB; using cpputils::AES256_GCM; using cpputils::Twofish256_GCM; using cpputils::Twofish128_CFB; using boost::none; using namespace cryfs; // This is needed for google test namespace boost { inline ostream &operator<<(ostream &stream, const CryConfigEncryptor::Decrypted &) { return stream << "CryConfigEncryptor::Decrypted()"; } } #include class CryConfigEncryptorTest: public ::testing::Test { public: unique_ref makeEncryptor() { return make_unique_ref(_derivedKey(), _kdfParameters()); } Data changeInnerCipherFieldTo(Data data, const string &newCipherName) { InnerConfig innerConfig = _decryptInnerConfig(data); innerConfig.cipherName = newCipherName; return _encryptInnerConfig(innerConfig); } private: FixedSizeData _derivedKey() { return DataFixture::generateFixedSize(3); } Data _kdfParameters() { return DataFixture::generate(128, 2); } unique_ref _outerEncryptor() { auto outerKey = _derivedKey().take(); return make_unique_ref(outerKey, _kdfParameters()); } InnerConfig _decryptInnerConfig(const Data &data) { OuterConfig outerConfig = OuterConfig::deserialize(data).value(); Data serializedInnerConfig = _outerEncryptor()->decrypt(outerConfig).value(); return InnerConfig::deserialize(serializedInnerConfig).value(); } Data _encryptInnerConfig(const InnerConfig &innerConfig) { Data serializedInnerConfig = innerConfig.serialize(); OuterConfig outerConfig = _outerEncryptor()->encrypt(serializedInnerConfig); return outerConfig.serialize(); } }; TEST_F(CryConfigEncryptorTest, EncryptAndDecrypt_Data_AES) { auto encryptor = makeEncryptor(); Data encrypted = encryptor->encrypt(DataFixture::generate(400), AES256_GCM::NAME); auto decrypted = encryptor->decrypt(encrypted).value(); EXPECT_EQ(DataFixture::generate(400), decrypted.data); } TEST_F(CryConfigEncryptorTest, EncryptAndDecrypt_Data_Twofish) { auto encryptor = makeEncryptor(); Data encrypted = encryptor->encrypt(DataFixture::generate(400), Twofish128_CFB::NAME); auto decrypted = encryptor->decrypt(encrypted).value(); EXPECT_EQ(DataFixture::generate(400), decrypted.data); } TEST_F(CryConfigEncryptorTest, EncryptAndDecrypt_Cipher_AES) { auto encryptor = makeEncryptor(); Data encrypted = encryptor->encrypt(DataFixture::generate(400), AES256_GCM::NAME); auto decrypted = encryptor->decrypt(encrypted).value(); EXPECT_EQ(AES256_GCM::NAME, decrypted.cipherName); } TEST_F(CryConfigEncryptorTest, EncryptAndDecrypt_Cipher_Twofish) { auto encryptor = makeEncryptor(); Data encrypted = encryptor->encrypt(DataFixture::generate(400), Twofish128_CFB::NAME); auto decrypted = encryptor->decrypt(encrypted).value(); EXPECT_EQ(Twofish128_CFB::NAME, decrypted.cipherName); } TEST_F(CryConfigEncryptorTest, EncryptAndDecrypt_EmptyData) { auto encryptor = makeEncryptor(); Data encrypted = encryptor->encrypt(Data(0), AES256_GCM::NAME); auto decrypted = encryptor->decrypt(encrypted).value(); EXPECT_EQ(Data(0), decrypted.data); } TEST_F(CryConfigEncryptorTest, InvalidCiphertext) { auto encryptor = makeEncryptor(); Data encrypted = encryptor->encrypt(DataFixture::generate(400), AES256_GCM::NAME); *(char*)encrypted.data() = *(char*)encrypted.data()+1; //Modify ciphertext auto decrypted = encryptor->decrypt(encrypted); EXPECT_EQ(none, decrypted); } TEST_F(CryConfigEncryptorTest, DoesntEncryptWhenTooLarge) { auto encryptor = makeEncryptor(); EXPECT_THROW( encryptor->encrypt(DataFixture::generate(2000), AES256_GCM::NAME), std::runtime_error ); } TEST_F(CryConfigEncryptorTest, EncryptionIsFixedSize) { auto encryptor = makeEncryptor(); Data encrypted1 = encryptor->encrypt(DataFixture::generate(100), AES128_CFB::NAME); Data encrypted2 = encryptor->encrypt(DataFixture::generate(200), Twofish256_GCM::NAME); Data encrypted3 = encryptor->encrypt(Data(0), AES256_GCM::NAME); EXPECT_EQ(encrypted1.size(), encrypted2.size()); EXPECT_EQ(encrypted1.size(), encrypted3.size()); } TEST_F(CryConfigEncryptorTest, SpecifiedInnerCipherIsUsed) { //Tests that it can't be decrypted if the inner cipher field stores the wrong cipher auto encryptor = makeEncryptor(); Data encrypted = encryptor->encrypt(DataFixture::generate(400), AES256_GCM::NAME); encrypted = changeInnerCipherFieldTo(std::move(encrypted), Twofish256_GCM::NAME); auto decrypted = encryptor->decrypt(encrypted); EXPECT_EQ(none, decrypted); } test/cryfs/config/crypto/inner/000077500000000000000000000000001300002025200170435ustar00rootroot00000000000000test/cryfs/config/crypto/inner/ConcreteInnerEncryptorTest.cpp000066400000000000000000000063511300002025200250600ustar00rootroot00000000000000#include #include #include #include using std::ostream; using boost::none; using cpputils::Data; using cpputils::DataFixture; using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::AES256_GCM; using cpputils::AES256_CFB; using cpputils::Twofish128_CFB; using namespace cryfs; // This is needed for google test namespace boost { inline ostream &operator<<(ostream &stream, const Data &) { return stream << "cpputils::Data()"; } } #include class ConcreteInnerEncryptorTest : public ::testing::Test { public: template unique_ref makeInnerEncryptor() { auto key = DataFixture::generateFixedSize(); return make_unique_ref>(key); } }; TEST_F(ConcreteInnerEncryptorTest, EncryptAndDecrypt_AES) { auto encryptor = makeInnerEncryptor(); InnerConfig encrypted = encryptor->encrypt(DataFixture::generate(200)); Data decrypted = encryptor->decrypt(encrypted).value(); EXPECT_EQ(DataFixture::generate(200), decrypted); } TEST_F(ConcreteInnerEncryptorTest, EncryptAndDecrypt_Twofish) { auto encryptor = makeInnerEncryptor(); InnerConfig encrypted = encryptor->encrypt(DataFixture::generate(200)); Data decrypted = encryptor->decrypt(encrypted).value(); EXPECT_EQ(DataFixture::generate(200), decrypted); } TEST_F(ConcreteInnerEncryptorTest, EncryptAndDecrypt_EmptyData) { auto encryptor = makeInnerEncryptor(); InnerConfig encrypted = encryptor->encrypt(Data(0)); Data decrypted = encryptor->decrypt(encrypted).value(); EXPECT_EQ(Data(0), decrypted); } TEST_F(ConcreteInnerEncryptorTest, DoesntDecryptWithWrongCipherName) { auto encryptor = makeInnerEncryptor(); InnerConfig encrypted = encryptor->encrypt(Data(0)); encrypted.cipherName = AES256_CFB::NAME; auto decrypted = encryptor->decrypt(encrypted); EXPECT_EQ(none, decrypted); } TEST_F(ConcreteInnerEncryptorTest, InvalidCiphertext) { auto encryptor = makeInnerEncryptor(); InnerConfig encrypted = encryptor->encrypt(DataFixture::generate(200)); *(char*)encrypted.encryptedConfig.data() = *(char*)encrypted.encryptedConfig.data()+1; //Modify ciphertext auto decrypted = encryptor->decrypt(encrypted); EXPECT_EQ(none, decrypted); } TEST_F(ConcreteInnerEncryptorTest, DoesntEncryptWhenTooLarge) { auto encryptor = makeInnerEncryptor(); EXPECT_THROW( encryptor->encrypt(DataFixture::generate(2000)), std::runtime_error ); } TEST_F(ConcreteInnerEncryptorTest, EncryptionIsFixedSize) { auto encryptor = makeInnerEncryptor(); InnerConfig encrypted1 = encryptor->encrypt(DataFixture::generate(100)); InnerConfig encrypted2 = encryptor->encrypt(DataFixture::generate(200)); InnerConfig encrypted3 = encryptor->encrypt(Data(0)); EXPECT_EQ(encrypted1.encryptedConfig.size(), encrypted2.encryptedConfig.size()); EXPECT_EQ(encrypted1.encryptedConfig.size(), encrypted3.encryptedConfig.size()); } test/cryfs/config/crypto/inner/InnerConfigTest.cpp000066400000000000000000000035331300002025200226140ustar00rootroot00000000000000#include #include #include using cpputils::Data; using cpputils::DataFixture; using boost::none; using std::ostream; using namespace cryfs; // This is needed for google test namespace boost { ostream &operator<<(ostream &stream, const InnerConfig &config) { return stream << "InnerConfig(" << config.cipherName << ", [data])"; } } #include TEST(InnerConfigTest, SomeValues) { Data serialized = InnerConfig{"myciphername", DataFixture::generate(1024)}.serialize(); InnerConfig deserialized = InnerConfig::deserialize(serialized).value(); EXPECT_EQ("myciphername", deserialized.cipherName); EXPECT_EQ(DataFixture::generate(1024), deserialized.encryptedConfig); } TEST(InnerConfigTest, DataEmpty) { Data serialized = InnerConfig{"myciphername", Data(0)}.serialize(); InnerConfig deserialized = InnerConfig::deserialize(serialized).value(); EXPECT_EQ("myciphername", deserialized.cipherName); EXPECT_EQ(Data(0), deserialized.encryptedConfig); } TEST(InnerConfigTest, CipherNameEmpty) { Data serialized = InnerConfig{"", DataFixture::generate(1024)}.serialize(); InnerConfig deserialized = InnerConfig::deserialize(serialized).value(); EXPECT_EQ("", deserialized.cipherName); EXPECT_EQ(DataFixture::generate(1024), deserialized.encryptedConfig); } TEST(InnerConfigTest, DataAndCipherNameEmpty) { Data serialized = InnerConfig{"", Data(0)}.serialize(); InnerConfig deserialized = InnerConfig::deserialize(serialized).value(); EXPECT_EQ("", deserialized.cipherName); EXPECT_EQ(Data(0), deserialized.encryptedConfig); } TEST(InnerConfigTest, InvalidSerialization) { auto deserialized = InnerConfig::deserialize(DataFixture::generate(1024)); EXPECT_EQ(none, deserialized); } test/cryfs/config/crypto/outer/000077500000000000000000000000001300002025200170665ustar00rootroot00000000000000test/cryfs/config/crypto/outer/OuterConfigTest.cpp000066400000000000000000000041231300002025200226560ustar00rootroot00000000000000#include #include #include using cpputils::Data; using cpputils::DataFixture; using cpputils::Deserializer; using cpputils::Serializer; using boost::none; using std::ostream; using namespace cryfs; // This is needed for google test namespace boost { ostream &operator<<(ostream &stream, const OuterConfig &) { return stream << "OuterConfig()"; } } #include class OuterConfigTest: public ::testing::Test { public: Data kdfParameters() { return DataFixture::generate(128, 2); } }; TEST_F(OuterConfigTest, SomeValues) { Data serialized = OuterConfig{kdfParameters(), DataFixture::generate(1024), false}.serialize(); OuterConfig deserialized = OuterConfig::deserialize(serialized).value(); EXPECT_EQ(kdfParameters(), deserialized.kdfParameters); EXPECT_EQ(DataFixture::generate(1024), deserialized.encryptedInnerConfig); } TEST_F(OuterConfigTest, DataEmpty) { Data serialized = OuterConfig{kdfParameters(), Data(0), false}.serialize(); OuterConfig deserialized = OuterConfig::deserialize(serialized).value(); EXPECT_EQ(kdfParameters(), deserialized.kdfParameters); EXPECT_EQ(Data(0), deserialized.encryptedInnerConfig); } TEST_F(OuterConfigTest, KeyConfigEmpty) { Data serialized = OuterConfig{Data(0), DataFixture::generate(1024), false}.serialize(); OuterConfig deserialized = OuterConfig::deserialize(serialized).value(); EXPECT_EQ(Data(0), deserialized.kdfParameters); EXPECT_EQ(DataFixture::generate(1024), deserialized.encryptedInnerConfig); } TEST_F(OuterConfigTest, DataAndKeyConfigEmpty) { Data serialized = OuterConfig{Data(0), Data(0), false}.serialize(); OuterConfig deserialized = OuterConfig::deserialize(serialized).value(); EXPECT_EQ(Data(0), deserialized.kdfParameters); EXPECT_EQ(Data(0), deserialized.encryptedInnerConfig); } TEST_F(OuterConfigTest, InvalidSerialization) { auto deserialized = OuterConfig::deserialize(DataFixture::generate(1024)); EXPECT_EQ(none, deserialized); } test/cryfs/config/crypto/outer/OuterEncryptorTest.cpp000066400000000000000000000047771300002025200234550ustar00rootroot00000000000000#include #include #include #include using std::ostream; using boost::none; using cpputils::Data; using cpputils::DataFixture; using cpputils::unique_ref; using cpputils::make_unique_ref; using namespace cryfs; // This is needed for google test namespace boost { inline ostream &operator<<(ostream &stream, const Data &) { return stream << "cpputils::Data()"; } } #include class OuterEncryptorTest : public ::testing::Test { public: Data kdfParameters() { return DataFixture::generate(128); } unique_ref makeOuterEncryptor() { auto key = DataFixture::generateFixedSize(); return make_unique_ref(key, kdfParameters()); } }; TEST_F(OuterEncryptorTest, EncryptAndDecrypt) { auto encryptor = makeOuterEncryptor(); OuterConfig encrypted = encryptor->encrypt(DataFixture::generate(200)); Data decrypted = encryptor->decrypt(encrypted).value(); EXPECT_EQ(DataFixture::generate(200), decrypted); } TEST_F(OuterEncryptorTest, EncryptAndDecrypt_EmptyData) { auto encryptor = makeOuterEncryptor(); OuterConfig encrypted = encryptor->encrypt(Data(0)); Data decrypted = encryptor->decrypt(encrypted).value(); EXPECT_EQ(Data(0), decrypted); } TEST_F(OuterEncryptorTest, InvalidCiphertext) { auto encryptor = makeOuterEncryptor(); OuterConfig encrypted = encryptor->encrypt(DataFixture::generate(200)); *(char*)encrypted.encryptedInnerConfig.data() = *(char*)encrypted.encryptedInnerConfig.data()+1; //Modify ciphertext auto decrypted = encryptor->decrypt(encrypted); EXPECT_EQ(none, decrypted); } TEST_F(OuterEncryptorTest, DoesntEncryptWhenTooLarge) { auto encryptor = makeOuterEncryptor(); EXPECT_THROW( encryptor->encrypt(DataFixture::generate(2000)), std::runtime_error ); } TEST_F(OuterEncryptorTest, EncryptionIsFixedSize) { auto encryptor = makeOuterEncryptor(); OuterConfig encrypted1 = encryptor->encrypt(DataFixture::generate(200)); OuterConfig encrypted2 = encryptor->encrypt(DataFixture::generate(700)); OuterConfig encrypted3 = encryptor->encrypt(Data(0)); EXPECT_EQ(encrypted1.encryptedInnerConfig.size(), encrypted2.encryptedInnerConfig.size()); EXPECT_EQ(encrypted1.encryptedInnerConfig.size(), encrypted3.encryptedInnerConfig.size()); } test/cryfs/filesystem/000077500000000000000000000000001300002025200153275ustar00rootroot00000000000000test/cryfs/filesystem/CryFsTest.cpp000066400000000000000000000044011300002025200177200ustar00rootroot00000000000000#include #include #include #include #include #include #include #include #include #include "../testutils/MockConsole.h" #include #include //TODO (whole project) Make constructors explicit when implicit construction not needed using ::testing::Test; using ::testing::Return; using ::testing::_; using std::make_shared; using cpputils::TempDir; using cpputils::TempFile; using cpputils::dynamic_pointer_move; using cpputils::make_unique_ref; using cpputils::unique_ref; using cpputils::Console; using cpputils::Random; using cpputils::SCrypt; using cpputils::Data; using cpputils::NoninteractiveConsole; using blockstore::ondisk::OnDiskBlockStore; using boost::none; namespace bf = boost::filesystem; using namespace cryfs; class CryFsTest: public Test, public TestWithMockConsole { public: CryFsTest(): rootdir(), config(false) { } CryConfigFile loadOrCreateConfig() { auto askPassword = [] {return "mypassword";}; return CryConfigLoader(make_shared(mockConsole()), Random::PseudoRandom(), SCrypt::TestSettings, askPassword, askPassword, none, none).loadOrCreate(config.path()).value(); } unique_ref blockStore() { return make_unique_ref(rootdir.path()); } TempDir rootdir; TempFile config; }; TEST_F(CryFsTest, CreatedRootdirIsLoadableAfterClosing) { { CryDevice dev(loadOrCreateConfig(), blockStore()); } CryDevice dev(loadOrCreateConfig(), blockStore()); auto root = dev.Load(bf::path("/")); dynamic_pointer_move(root.get()).get()->children(); } TEST_F(CryFsTest, LoadingFilesystemDoesntModifyConfigFile) { { CryDevice dev(loadOrCreateConfig(), blockStore()); } Data configAfterCreating = Data::LoadFromFile(config.path()).value(); { CryDevice dev(loadOrCreateConfig(), blockStore()); } Data configAfterLoading = Data::LoadFromFile(config.path()).value(); EXPECT_EQ(configAfterCreating, configAfterLoading); } test/cryfs/filesystem/CryNodeTest.cpp000066400000000000000000000040141300002025200202350ustar00rootroot00000000000000#include #include "testutils/CryTestBase.h" #include #include #include using cpputils::unique_ref; using cpputils::dynamic_pointer_move; using namespace cryfs; namespace bf = boost::filesystem; // Many generic (black box) test cases for FsppNode are covered in Fspp fstest. // This class adds some tests that need insight into how CryFS works. class CryNodeTest : public ::testing::Test, public CryTestBase { public: static constexpr mode_t MODE_PUBLIC = S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH | S_IWOTH | S_IXOTH; unique_ref CreateFile(const bf::path &path) { auto _parentDir = device().Load(path.parent_path()).value(); auto parentDir = dynamic_pointer_move(_parentDir).value(); parentDir->createAndOpenFile(path.filename().native(), MODE_PUBLIC, 0, 0); auto createdFile = device().Load(path).value(); return dynamic_pointer_move(createdFile).value(); } }; TEST_F(CryNodeTest, Rename_DoesntLeaveBlocksOver) { auto node = CreateFile("/oldname"); EXPECT_EQ(2u, device().numBlocks()); // In the beginning, there is two blocks (the root block and the created file). If that is not true anymore, we'll have to adapt the test case. node->rename("/newname"); EXPECT_EQ(2u, device().numBlocks()); // Still same number of blocks } // TODO Add similar test cases (i.e. checking number of blocks) for other situations in rename, and also for other operations (e.g. deleting files). TEST_F(CryNodeTest, Rename_Overwrite_DoesntLeaveBlocksOver) { auto node = CreateFile("/oldname"); CreateFile("/newexistingname"); EXPECT_EQ(3u, device().numBlocks()); // In the beginning, there is three blocks (the root block and the two created files). If that is not true anymore, we'll have to adapt the test case. node->rename("/newexistingname"); EXPECT_EQ(2u, device().numBlocks()); // Only the blocks of one file are left } test/cryfs/filesystem/FileSystemTest.cpp000066400000000000000000000025301300002025200207570ustar00rootroot00000000000000#include #include #include #include #include #include #include "../testutils/MockConsole.h" using cpputils::unique_ref; using cpputils::make_unique_ref; using cpputils::Random; using cpputils::SCrypt; using cpputils::NoninteractiveConsole; using fspp::Device; using ::testing::Return; using ::testing::_; using boost::none; using std::make_shared; using blockstore::testfake::FakeBlockStore; using namespace cryfs; class CryFsTestFixture: public FileSystemTestFixture, public TestWithMockConsole { public: CryFsTestFixture() // Don't create config tempfile yet : configFile(false) {} unique_ref createDevice() override { auto blockStore = cpputils::make_unique_ref(); auto askPassword = [] {return "mypassword";}; auto config = CryConfigLoader(make_shared(mockConsole()), Random::PseudoRandom(), SCrypt::TestSettings, askPassword, askPassword, none, none) .loadOrCreate(configFile.path()).value(); return make_unique_ref(std::move(config), std::move(blockStore)); } cpputils::TempFile configFile; }; FSPP_ADD_FILESYTEM_TESTS(CryFS, CryFsTestFixture); test/cryfs/filesystem/testutils/000077500000000000000000000000001300002025200173675ustar00rootroot00000000000000test/cryfs/filesystem/testutils/CryTestBase.h000066400000000000000000000022101300002025200217230ustar00rootroot00000000000000#ifndef MESSMER_CRYFS_TEST_CRYFS_FILESYSTEM_CRYTESTBASE_H #define MESSMER_CRYFS_TEST_CRYFS_FILESYSTEM_CRYTESTBASE_H #include #include #include #include class CryTestBase { public: CryTestBase(): _configFile(false), _device(nullptr) { auto fakeBlockStore = cpputils::make_unique_ref(); _device = std::make_unique(configFile(), std::move(fakeBlockStore)); } cryfs::CryConfigFile configFile() { cryfs::CryConfig config; config.SetCipher("aes-256-gcm"); config.SetEncryptionKey(cpputils::AES256_GCM::CreateKey(cpputils::Random::PseudoRandom()).ToString()); config.SetBlocksizeBytes(10240); return cryfs::CryConfigFile::create(_configFile.path(), std::move(config), "mypassword", cpputils::SCrypt::TestSettings); } cryfs::CryDevice &device() { return *_device; } private: cpputils::TempFile _configFile; std::unique_ptr _device; }; #endif test/cryfs/testutils/000077500000000000000000000000001300002025200152035ustar00rootroot00000000000000test/cryfs/testutils/MockConsole.h000066400000000000000000000020561300002025200175730ustar00rootroot00000000000000#pragma once #ifndef MESSMER_CRYFS_TEST_TESTUTILS_MOCKCONSOLE_H #define MESSMER_CRYFS_TEST_TESTUTILS_MOCKCONSOLE_H #include #include class MockConsole: public cpputils::Console { public: MOCK_METHOD1(print, void(const std::string&)); MOCK_METHOD2(ask, unsigned int(const std::string&, const std::vector&)); MOCK_METHOD2(askYesNo, bool(const std::string&, bool)); }; ACTION_P(ChooseCipher, cipherName) { return std::find(arg1.begin(), arg1.end(), cipherName) - arg1.begin(); } #define ChooseAnyCipher() ChooseCipher("aes-256-gcm") class TestWithMockConsole { public: // Return a console that chooses a valid cryfs setting static std::shared_ptr mockConsole() { auto console = std::make_shared(); EXPECT_CALL(*console, ask(::testing::_, ::testing::_)).WillRepeatedly(ChooseCipher("aes-256-gcm")); EXPECT_CALL(*console, askYesNo(::testing::_, ::testing::_)).WillRepeatedly(::testing::Return(true)); return console; } }; #endif test/fspp/000077500000000000000000000000001300002025200127655ustar00rootroot00000000000000test/fspp/CMakeLists.txt000066400000000000000000000106151300002025200155300ustar00rootroot00000000000000project (fspp-test) set(SOURCES testutils/FuseTest.cpp testutils/FuseThread.cpp testutils/InMemoryFile.cpp impl/FuseOpenFileListTest.cpp impl/IdListTest.cpp fuse/lstat/FuseLstatReturnUidTest.cpp fuse/lstat/testutils/FuseLstatTest.cpp fuse/lstat/FuseLstatReturnCtimeTest.cpp fuse/lstat/FuseLstatReturnGidTest.cpp fuse/lstat/FuseLstatPathParameterTest.cpp fuse/lstat/FuseLstatReturnNlinkTest.cpp fuse/lstat/FuseLstatReturnModeTest.cpp fuse/lstat/FuseLstatReturnAtimeTest.cpp fuse/lstat/FuseLstatErrorTest.cpp fuse/lstat/FuseLstatReturnMtimeTest.cpp fuse/lstat/FuseLstatReturnSizeTest.cpp fuse/read/FuseReadFileDescriptorTest.cpp fuse/read/testutils/FuseReadTest.cpp fuse/read/FuseReadOverflowTest.cpp fuse/read/FuseReadErrorTest.cpp fuse/read/FuseReadReturnedDataTest.cpp fuse/flush/testutils/FuseFlushTest.cpp fuse/flush/FuseFlushErrorTest.cpp fuse/flush/FuseFlushFileDescriptorTest.cpp fuse/rename/testutils/FuseRenameTest.cpp fuse/rename/FuseRenameErrorTest.cpp fuse/rename/FuseRenameFilenameTest.cpp fuse/utimens/testutils/FuseUtimensTest.cpp fuse/utimens/FuseUtimensErrorTest.cpp fuse/utimens/FuseUtimensFilenameTest.cpp fuse/utimens/FuseUtimensTimeParameterTest.cpp fuse/unlink/testutils/FuseUnlinkTest.cpp fuse/unlink/FuseUnlinkErrorTest.cpp fuse/unlink/FuseUnlinkFilenameTest.cpp fuse/ftruncate/testutils/FuseFTruncateTest.cpp fuse/ftruncate/FuseFTruncateFileDescriptorTest.cpp fuse/ftruncate/FuseFTruncateSizeTest.cpp fuse/ftruncate/FuseFTruncateErrorTest.cpp fuse/fstat/testutils/FuseFstatTest.cpp fuse/fstat/FuseFstatParameterTest.cpp fuse/fstat/FuseFstatErrorTest.cpp fuse/truncate/FuseTruncateSizeTest.cpp fuse/truncate/testutils/FuseTruncateTest.cpp fuse/truncate/FuseTruncateErrorTest.cpp fuse/truncate/FuseTruncateFilenameTest.cpp fuse/statfs/FuseStatfsReturnFilesTest.cpp fuse/statfs/FuseStatfsReturnFfreeTest.cpp fuse/statfs/FuseStatfsReturnNamemaxTest.cpp fuse/statfs/testutils/FuseStatfsTest.cpp fuse/statfs/FuseStatfsReturnBsizeTest.cpp fuse/statfs/FuseStatfsErrorTest.cpp fuse/statfs/FuseStatfsReturnBfreeTest.cpp fuse/statfs/FuseStatfsPathParameterTest.cpp fuse/statfs/FuseStatfsReturnBlocksTest.cpp fuse/statfs/FuseStatfsReturnBavailTest.cpp fuse/closeFile/FuseCloseTest.cpp fuse/fsync/testutils/FuseFsyncTest.cpp fuse/fsync/FuseFsyncFileDescriptorTest.cpp fuse/fsync/FuseFsyncErrorTest.cpp fuse/openFile/testutils/FuseOpenTest.cpp fuse/openFile/FuseOpenFilenameTest.cpp fuse/openFile/FuseOpenFlagsTest.cpp fuse/openFile/FuseOpenFileDescriptorTest.cpp fuse/openFile/FuseOpenErrorTest.cpp fuse/access/FuseAccessFilenameTest.cpp fuse/access/testutils/FuseAccessTest.cpp fuse/access/FuseAccessModeTest.cpp fuse/access/FuseAccessErrorTest.cpp fuse/BasicFuseTest.cpp fuse/rmdir/testutils/FuseRmdirTest.cpp fuse/rmdir/FuseRmdirErrorTest.cpp fuse/rmdir/FuseRmdirDirnameTest.cpp fuse/fdatasync/testutils/FuseFdatasyncTest.cpp fuse/fdatasync/FuseFdatasyncErrorTest.cpp fuse/fdatasync/FuseFdatasyncFileDescriptorTest.cpp fuse/mkdir/testutils/FuseMkdirTest.cpp fuse/mkdir/FuseMkdirErrorTest.cpp fuse/mkdir/FuseMkdirModeTest.cpp fuse/mkdir/FuseMkdirDirnameTest.cpp fuse/write/FuseWriteErrorTest.cpp fuse/write/testutils/FuseWriteTest.cpp fuse/write/FuseWriteOverflowTest.cpp fuse/write/FuseWriteFileDescriptorTest.cpp fuse/write/FuseWriteDataTest.cpp fuse/readDir/testutils/FuseReadDirTest.cpp fuse/readDir/FuseReadDirDirnameTest.cpp fuse/readDir/FuseReadDirErrorTest.cpp fuse/readDir/FuseReadDirReturnTest.cpp fuse/createAndOpenFile/FuseCreateAndOpenFilenameTest.cpp fuse/createAndOpenFile/testutils/FuseCreateAndOpenTest.cpp fuse/createAndOpenFile/FuseCreateAndOpenFlagsTest.cpp fuse/createAndOpenFile/FuseCreateAndOpenFileDescriptorTest.cpp fuse/createAndOpenFile/FuseCreateAndOpenErrorTest.cpp fuse/FilesystemTest.cpp fs_interface/NodeTest.cpp fs_interface/FileTest.cpp fs_interface/DirTest.cpp fs_interface/DeviceTest.cpp fs_interface/OpenFileTest.cpp ) add_executable(${PROJECT_NAME} ${SOURCES}) target_link_libraries(${PROJECT_NAME} googletest fspp) add_test(${PROJECT_NAME} ${PROJECT_NAME}) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) test/fspp/fs_interface/000077500000000000000000000000001300002025200154155ustar00rootroot00000000000000test/fspp/fs_interface/DeviceTest.cpp000066400000000000000000000002221300002025200201540ustar00rootroot00000000000000/* * Tests that the header can be included without needing additional header includes as dependencies. */ #include "fspp/fs_interface/Device.h" test/fspp/fs_interface/DirTest.cpp000066400000000000000000000002171300002025200174770ustar00rootroot00000000000000/* * Tests that the header can be included without needing additional header includes as dependencies. */ #include "fspp/fs_interface/Dir.h" test/fspp/fs_interface/FileTest.cpp000066400000000000000000000002201300002025200176320ustar00rootroot00000000000000/* * Tests that the header can be included without needing additional header includes as dependencies. */ #include "fspp/fs_interface/File.h" test/fspp/fs_interface/NodeTest.cpp000066400000000000000000000002201300002025200176400ustar00rootroot00000000000000/* * Tests that the header can be included without needing additional header includes as dependencies. */ #include "fspp/fs_interface/Node.h" test/fspp/fs_interface/OpenFileTest.cpp000066400000000000000000000002241300002025200204600ustar00rootroot00000000000000/* * Tests that the header can be included without needing additional header includes as dependencies. */ #include "fspp/fs_interface/OpenFile.h" test/fspp/fuse/000077500000000000000000000000001300002025200137275ustar00rootroot00000000000000test/fspp/fuse/BasicFuseTest.cpp000066400000000000000000000005151300002025200171400ustar00rootroot00000000000000#include "../testutils/FuseTest.h" using namespace fspp::fuse; using namespace fspp::fuse; using ::testing::_; using ::testing::StrEq; typedef FuseTest BasicFuseTest; //This test case simply checks whether a filesystem can be setup and teardown without crashing. TEST_F(BasicFuseTest, setupAndTearDown) { auto fs = TestFS(); } test/fspp/fuse/FilesystemTest.cpp000066400000000000000000000002161300002025200174160ustar00rootroot00000000000000/* * Tests that the header can be included without needing additional header includes as dependencies. */ #include "fspp/fuse/Filesystem.h" test/fspp/fuse/access/000077500000000000000000000000001300002025200151705ustar00rootroot00000000000000test/fspp/fuse/access/FuseAccessErrorTest.cpp000066400000000000000000000014651300002025200216000ustar00rootroot00000000000000#include "testutils/FuseAccessTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::AtLeast; using namespace fspp::fuse; class FuseAccessErrorTest: public FuseAccessTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseAccessErrorTest, FuseAccessErrorTest, Values(EACCES, ELOOP, ENAMETOOLONG, ENOENT, ENOTDIR, EROFS, EFAULT, EINVAL, EIO, ENOMEM, ETXTBSY)); TEST_P(FuseAccessErrorTest, ReturnedErrorIsCorrect) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, access(StrEq(FILENAME), _)) .Times(AtLeast(1)).WillRepeatedly(Throw(FuseErrnoException(GetParam()))); int error = AccessFileReturnError(FILENAME, 0); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/access/FuseAccessFilenameTest.cpp000066400000000000000000000016371300002025200222300ustar00rootroot00000000000000#include "testutils/FuseAccessTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; class FuseAccessFilenameTest: public FuseAccessTest { }; TEST_F(FuseAccessFilenameTest, AccessFile) { ReturnIsFileOnLstat("/myfile"); EXPECT_CALL(fsimpl, access(StrEq("/myfile"), _)) .Times(1).WillOnce(Return()); AccessFile("/myfile", 0); } TEST_F(FuseAccessFilenameTest, AccessFileNested) { ReturnIsDirOnLstat("/mydir"); ReturnIsFileOnLstat("/mydir/myfile"); EXPECT_CALL(fsimpl, access(StrEq("/mydir/myfile"), _)) .Times(1).WillOnce(Return()); AccessFile("/mydir/myfile", 0); } TEST_F(FuseAccessFilenameTest, AccessFileNested2) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnIsFileOnLstat("/mydir/mydir2/myfile"); EXPECT_CALL(fsimpl, access(StrEq("/mydir/mydir2/myfile"), _)) .Times(1).WillOnce(Return()); AccessFile("/mydir/mydir2/myfile", 0); } test/fspp/fuse/access/FuseAccessModeTest.cpp000066400000000000000000000011451300002025200213660ustar00rootroot00000000000000#include "testutils/FuseAccessTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; using ::testing::WithParamInterface; using ::testing::Values; class FuseAccessModeTest: public FuseAccessTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseAccessModeTest, FuseAccessModeTest, Values(0, F_OK, R_OK, W_OK, X_OK, R_OK|W_OK, W_OK|X_OK, R_OK|X_OK, R_OK|W_OK|X_OK)); TEST_P(FuseAccessModeTest, AccessFile) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, access(StrEq(FILENAME), GetParam())) .Times(1).WillOnce(Return()); AccessFile(FILENAME, GetParam()); } test/fspp/fuse/access/testutils/000077500000000000000000000000001300002025200172305ustar00rootroot00000000000000test/fspp/fuse/access/testutils/FuseAccessTest.cpp000066400000000000000000000006651300002025200226270ustar00rootroot00000000000000#include "FuseAccessTest.h" void FuseAccessTest::AccessFile(const char *filename, int mode) { int error = AccessFileReturnError(filename, mode); EXPECT_EQ(0, error); } int FuseAccessTest::AccessFileReturnError(const char *filename, int mode) { auto fs = TestFS(); auto realpath = fs->mountDir() / filename; int retval = ::access(realpath.c_str(), mode); if (retval == 0) { return 0; } else { return errno; } } test/fspp/fuse/access/testutils/FuseAccessTest.h000066400000000000000000000006141300002025200222660ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_ACCESS_TESTUTILS_FUSEACCESSTEST_H_ #define MESSMER_FSPP_TEST_FUSE_ACCESS_TESTUTILS_FUSEACCESSTEST_H_ #include "../../../testutils/FuseTest.h" class FuseAccessTest: public FuseTest { public: const char *FILENAME = "/myfile"; void AccessFile(const char *filename, int mode); int AccessFileReturnError(const char *filename, int mode); }; #endif test/fspp/fuse/closeFile/000077500000000000000000000000001300002025200156345ustar00rootroot00000000000000test/fspp/fuse/closeFile/FuseCloseTest.cpp000066400000000000000000000060511300002025200210720ustar00rootroot00000000000000#include "../../testutils/FuseTest.h" #include using ::testing::_; using ::testing::StrEq; using ::testing::Eq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Return; using ::testing::Invoke; using ::testing::InSequence; using ::testing::AtLeast; using std::string; using std::mutex; using std::unique_lock; using std::condition_variable; using std::chrono::duration; using std::chrono::seconds; // The fuse behaviour is: For each open(), there will be exactly one call to release(). // Directly before this call to release(), flush() will be called. After flush() returns, // the ::close() syscall (in the process using the filesystem) returns. So the fuse release() call is // called asynchronously afterwards. Errors have to be returned in the implementation of flush(). // Citing FUSE spec: // 1) Flush is called on each close() of a file descriptor. // 2) Filesystems shouldn't assume that flush will always be called after some writes, or that if will be called at all. // I can't get these sentences together. For the test cases here, I go with the first one and assume that // flush() will ALWAYS be called on a file close. class Barrier { public: Barrier(): m(), cv(), finished(false) {} template void WaitAtMost(const duration &atMost) { unique_lock lock(m); if (!finished) { cv.wait_for(lock, atMost, [this] () {return finished;}); } } void Release() { unique_lock lock(m); finished = true; cv.notify_all(); } private: mutex m; condition_variable cv; bool finished; }; class FuseCloseTest: public FuseTest, public WithParamInterface { public: const string FILENAME = "/myfile"; void OpenAndCloseFile(const string &filename) { auto fs = TestFS(); int fd = OpenFile(fs.get(), filename); CloseFile(fd); } int OpenFile(const TempTestFS *fs, const string &filename) { auto real_path = fs->mountDir() / filename; int fd = ::open(real_path.c_str(), O_RDONLY); EXPECT_GE(fd, 0) << "Opening file failed"; return fd; } void CloseFile(int fd) { int retval = ::close(fd); EXPECT_EQ(0, retval); } }; INSTANTIATE_TEST_CASE_P(FuseCloseTest, FuseCloseTest, Values(0, 1, 2, 100, 1024*1024*1024)); //TODO Figure out what's wrong and enable this test //Disabled, because it is flaky. libfuse seems to not send the release() event sometimes. /*TEST_P(FuseCloseTest, CloseFile) { Barrier barrier; ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, openFile(StrEq(FILENAME), _)).WillOnce(Return(GetParam())); { //InSequence fileCloseSequence; EXPECT_CALL(fsimpl, flush(Eq(GetParam()))).Times(1); EXPECT_CALL(fsimpl, closeFile(Eq(GetParam()))).Times(1).WillOnce(Invoke([&barrier] (int) { // Release the waiting lock at the end of this test case, because the fuse release() came in now. barrier.Release(); })); } OpenAndCloseFile(FILENAME); // Wait, until fuse release() was called, so we can check for the function call expectation. barrier.WaitAtMost(seconds(10)); }*/ test/fspp/fuse/createAndOpenFile/000077500000000000000000000000001300002025200172375ustar00rootroot00000000000000test/fspp/fuse/createAndOpenFile/FuseCreateAndOpenErrorTest.cpp000066400000000000000000000025441300002025200251150ustar00rootroot00000000000000#include "testutils/FuseCreateAndOpenTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Return; using ::testing::Throw; using ::testing::StrEq; using ::testing::_; using namespace fspp::fuse; class FuseCreateAndOpenErrorTest: public FuseCreateAndOpenTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseCreateAndOpenErrorTest, FuseCreateAndOpenErrorTest, Values(EACCES, EDQUOT, EEXIST, EFAULT, EFBIG, EINTR, EOVERFLOW, EINVAL, EISDIR, ELOOP, EMFILE, ENAMETOOLONG, ENFILE, ENODEV, ENOENT, ENOMEM, ENOSPC, ENOTDIR, ENXIO, EOPNOTSUPP, EPERM, EROFS, ETXTBSY, EWOULDBLOCK, EBADF, ENOTDIR)); TEST_F(FuseCreateAndOpenErrorTest, ReturnNoError) { ReturnDoesntExistOnLstat(FILENAME); EXPECT_CALL(fsimpl, createAndOpenFile(StrEq(FILENAME), _, _, _)).Times(1).WillOnce(Return(1)); //For the syscall to succeed, we also need to give an fstat implementation. ReturnIsFileOnFstat(1); int error = CreateAndOpenFileReturnError(FILENAME, O_RDONLY); EXPECT_EQ(0, error); } TEST_P(FuseCreateAndOpenErrorTest, ReturnError) { ReturnDoesntExistOnLstat(FILENAME); EXPECT_CALL(fsimpl, createAndOpenFile(StrEq(FILENAME), _, _, _)).Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); int error = CreateAndOpenFileReturnError(FILENAME, O_RDONLY); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/createAndOpenFile/FuseCreateAndOpenFileDescriptorTest.cpp000066400000000000000000000027021300002025200267360ustar00rootroot00000000000000#include "testutils/FuseCreateAndOpenTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Return; class FuseCreateAndOpenFileDescriptorTest: public FuseCreateAndOpenTest, public WithParamInterface { public: void CreateAndOpenAndReadFile(const char *filename) { auto fs = TestFS(); int fd = CreateAndOpenFile(fs.get(), filename); ReadFile(fd); } private: int CreateAndOpenFile(const TempTestFS *fs, const char *filename) { auto realpath = fs->mountDir() / filename; int fd = ::open(realpath.c_str(), O_RDONLY | O_CREAT, S_IRUSR | S_IRGRP | S_IROTH); EXPECT_GE(fd, 0) << "Creating file failed"; return fd; } void ReadFile(int fd) { uint8_t buf; int retval = ::read(fd, &buf, 1); EXPECT_EQ(1, retval) << "Reading file failed"; } }; INSTANTIATE_TEST_CASE_P(FuseCreateAndOpenFileDescriptorTest, FuseCreateAndOpenFileDescriptorTest, Values(0, 2, 5, 1000, 1024*1024*1024)); TEST_P(FuseCreateAndOpenFileDescriptorTest, TestReturnedFileDescriptor) { ReturnDoesntExistOnLstat(FILENAME); EXPECT_CALL(fsimpl, createAndOpenFile(StrEq(FILENAME), _, _, _)) .Times(1).WillOnce(Return(GetParam())); EXPECT_CALL(fsimpl, read(GetParam(), _, _, _)).Times(1).WillOnce(Return(1)); //For the syscall to succeed, we also need to give an fstat implementation. ReturnIsFileOnFstatWithSize(GetParam(), 1); CreateAndOpenAndReadFile(FILENAME); } test/fspp/fuse/createAndOpenFile/FuseCreateAndOpenFilenameTest.cpp000066400000000000000000000026151300002025200255430ustar00rootroot00000000000000#include "testutils/FuseCreateAndOpenTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; class FuseCreateAndOpenFilenameTest: public FuseCreateAndOpenTest { public: }; TEST_F(FuseCreateAndOpenFilenameTest, CreateAndOpenFile) { ReturnDoesntExistOnLstat("/myfile"); EXPECT_CALL(fsimpl, createAndOpenFile(StrEq("/myfile"), _, _, _)) .Times(1).WillOnce(Return(0)); //For the syscall to succeed, we also need to give an fstat implementation. ReturnIsFileOnFstat(0); CreateAndOpenFile("/myfile", O_RDONLY); } TEST_F(FuseCreateAndOpenFilenameTest, CreateAndOpenFileNested) { ReturnIsDirOnLstat("/mydir"); ReturnDoesntExistOnLstat("/mydir/myfile"); EXPECT_CALL(fsimpl, createAndOpenFile(StrEq("/mydir/myfile"), _, _, _)) .Times(1).WillOnce(Return(0)); //For the syscall to succeed, we also need to give an fstat implementation. ReturnIsFileOnFstat(0); CreateAndOpenFile("/mydir/myfile", O_RDONLY); } TEST_F(FuseCreateAndOpenFilenameTest, CreateAndOpenFileNested2) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnDoesntExistOnLstat("/mydir/mydir2/myfile"); EXPECT_CALL(fsimpl, createAndOpenFile(StrEq("/mydir/mydir2/myfile"), _, _, _)) .Times(1).WillOnce(Return(0)); //For the syscall to succeed, we also need to give an fstat implementation. ReturnIsFileOnFstat(0); CreateAndOpenFile("/mydir/mydir2/myfile", O_RDONLY); } test/fspp/fuse/createAndOpenFile/FuseCreateAndOpenFlagsTest.cpp000066400000000000000000000015361300002025200250600ustar00rootroot00000000000000#include "testutils/FuseCreateAndOpenTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Return; class FuseCreateAndOpenFlagsTest: public FuseCreateAndOpenTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseCreateAndOpenFlagsTest, FuseCreateAndOpenFlagsTest, Values(O_RDWR, O_RDONLY, O_WRONLY)); //TODO Disabled because it doesn't seem to work. Fuse doesn't seem to pass flags to create(). Why? /*TEST_P(FuseCreateAndOpenFlagsTest, testFlags) { ReturnDoesntExistOnLstat(FILENAME); EXPECT_CALL(fsimpl, createAndOpenFile(StrEq(FILENAME), OpenFlagsEq(GetParam()), _, _)) .Times(1).WillOnce(Return(0)); //For the syscall to succeed, we also need to give an fstat implementation. ReturnIsFileOnFstat(0); CreateAndOpenFile(FILENAME, GetParam()); }*/ test/fspp/fuse/createAndOpenFile/testutils/000077500000000000000000000000001300002025200212775ustar00rootroot00000000000000test/fspp/fuse/createAndOpenFile/testutils/FuseCreateAndOpenTest.cpp000066400000000000000000000013721300002025200261410ustar00rootroot00000000000000#include "FuseCreateAndOpenTest.h" using ::testing::_; int FuseCreateAndOpenTest::CreateAndOpenFile(const char *filename, int flags) { int fd = CreateAndOpenFileAllowError(filename, flags); EXPECT_GE(fd, 0); return fd; } int FuseCreateAndOpenTest::CreateAndOpenFileReturnError(const char *filename, int flags) { int fd = CreateAndOpenFileAllowError(filename, flags); if (fd >= 0) { return 0; } else { return -fd; } } int FuseCreateAndOpenTest::CreateAndOpenFileAllowError(const char *filename, int flags) { auto fs = TestFS(); auto realpath = fs->mountDir() / filename; int fd = ::open(realpath.c_str(), flags | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); if (fd >= 0) { return fd; } else { return -errno; } } test/fspp/fuse/createAndOpenFile/testutils/FuseCreateAndOpenTest.h000066400000000000000000000011571300002025200256070ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_CREATEANDOPENFILE_TESTUTILS_FUSECREATEANDOPENTEST_H_ #define MESSMER_FSPP_TEST_FUSE_CREATEANDOPENFILE_TESTUTILS_FUSECREATEANDOPENTEST_H_ #include "../../../testutils/FuseTest.h" class FuseCreateAndOpenTest: public FuseTest { public: const char *FILENAME = "/myfile"; int CreateAndOpenFile(const char *FILENAME, int flags); int CreateAndOpenFileReturnError(const char *FILENAME, int flags); private: int CreateAndOpenFileAllowError(const char *FILENAME, int flags); }; MATCHER_P(OpenFlagsEq, expectedFlags, "") { return expectedFlags == (O_ACCMODE & arg); } #endif test/fspp/fuse/fdatasync/000077500000000000000000000000001300002025200157035ustar00rootroot00000000000000test/fspp/fuse/fdatasync/FuseFdatasyncErrorTest.cpp000066400000000000000000000013731300002025200230240ustar00rootroot00000000000000#include "testutils/FuseFdatasyncTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using namespace fspp::fuse; class FuseFdatasyncErrorTest: public FuseFdatasyncTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseFdatasyncErrorTest, FuseFdatasyncErrorTest, Values(EBADF, EIO, EROFS, EINVAL)); TEST_P(FuseFdatasyncErrorTest, ReturnedErrorIsCorrect) { ReturnIsFileOnLstat(FILENAME); OnOpenReturnFileDescriptor(FILENAME, 0); EXPECT_CALL(fsimpl, fdatasync(0)) .Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); int error = FdatasyncFileReturnError(FILENAME); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/fdatasync/FuseFdatasyncFileDescriptorTest.cpp000066400000000000000000000013721300002025200246500ustar00rootroot00000000000000#include "testutils/FuseFdatasyncTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Eq; using ::testing::Return; using namespace fspp::fuse; class FuseFdatasyncFileDescriptorTest: public FuseFdatasyncTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseFdatasyncFileDescriptorTest, FuseFdatasyncFileDescriptorTest, Values(0,1,10,1000,1024*1024*1024)); TEST_P(FuseFdatasyncFileDescriptorTest, FileDescriptorIsCorrect) { ReturnIsFileOnLstat(FILENAME); OnOpenReturnFileDescriptor(FILENAME, GetParam()); EXPECT_CALL(fsimpl, fdatasync(Eq(GetParam()))) .Times(1).WillOnce(Return()); FdatasyncFile(FILENAME); } test/fspp/fuse/fdatasync/testutils/000077500000000000000000000000001300002025200177435ustar00rootroot00000000000000test/fspp/fuse/fdatasync/testutils/FuseFdatasyncTest.cpp000066400000000000000000000014111300002025200240430ustar00rootroot00000000000000#include "FuseFdatasyncTest.h" #include void FuseFdatasyncTest::FdatasyncFile(const char *filename) { int error = FdatasyncFileReturnError(filename); EXPECT_EQ(0, error); } int FuseFdatasyncTest::FdatasyncFileReturnError(const char *filename) { auto fs = TestFS(); int fd = OpenFile(fs.get(), filename); #ifdef F_FULLFSYNC // This is MacOSX, which doesn't know fdatasync int retval = fcntl(fd, F_FULLFSYNC); #else int retval = ::fdatasync(fd); #endif if (retval != -1) { return 0; } else { return errno; } } int FuseFdatasyncTest::OpenFile(const TempTestFS *fs, const char *filename) { auto realpath = fs->mountDir() / filename; int fd = ::open(realpath.c_str(), O_RDWR); EXPECT_GE(fd, 0) << "Error opening file"; return fd; } test/fspp/fuse/fdatasync/testutils/FuseFdatasyncTest.h000066400000000000000000000007231300002025200235150ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_FDATASYNC_TESTUTILS_FUSEFDATASYNCTEST_H_ #define MESSMER_FSPP_TEST_FUSE_FDATASYNC_TESTUTILS_FUSEFDATASYNCTEST_H_ #include "../../../testutils/FuseTest.h" class FuseFdatasyncTest: public FuseTest { public: const char *FILENAME = "/myfile"; void FdatasyncFile(const char *filename); int FdatasyncFileReturnError(const char *filename); private: int OpenFile(const TempTestFS *fs, const char *filename); }; #endif test/fspp/fuse/flush/000077500000000000000000000000001300002025200150505ustar00rootroot00000000000000test/fspp/fuse/flush/FuseFlushErrorTest.cpp000066400000000000000000000016461300002025200213410ustar00rootroot00000000000000#include "testutils/FuseFlushTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::WithParamInterface; using ::testing::StrEq; using ::testing::Eq; using ::testing::Return; using ::testing::Throw; using ::testing::AtLeast; using ::testing::Values; using ::testing::_; using fspp::fuse::FuseErrnoException; class FuseFlushErrorTest: public FuseFlushTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseFlushErrorTest, FuseFlushErrorTest, Values(EBADF, EINTR, EIO)); TEST_P(FuseFlushErrorTest, ReturnErrorFromFlush) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, openFile(StrEq(FILENAME), _)).WillOnce(Return(GetParam())); EXPECT_CALL(fsimpl, flush(Eq(GetParam()))).Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); auto fs = TestFS(); int fd = OpenFile(fs.get(), FILENAME); int close_result = ::close(fd); EXPECT_EQ(GetParam(), errno); EXPECT_EQ(-1, close_result); } test/fspp/fuse/flush/FuseFlushFileDescriptorTest.cpp000066400000000000000000000026541300002025200231660ustar00rootroot00000000000000#include "testutils/FuseFlushTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Eq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Return; using ::testing::AtLeast; using std::string; // The fuse behaviour is: For each open(), there will be exactly one call to release(). // Directly before this call to release(), flush() will be called. After flush() returns, // the ::close() syscall (in the process using the filesystem) returns. So the fuse release() call is // called asynchronously afterwards. Errors have to be returned in the implementation of flush(). // Citing FUSE spec: // 1) Flush is called on each close() of a file descriptor. // 2) Filesystems shouldn't assume that flush will always be called after some writes, or that if will be called at all. // I can't get these sentences together. For the test cases here, I go with the first one and assume that // flush() will ALWAYS be called on a file close. class FuseFlushFileDescriptorTest: public FuseFlushTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseFlushFileDescriptorTest, FuseFlushFileDescriptorTest, Values(0, 1, 2, 100, 1024*1024*1024)); TEST_P(FuseFlushFileDescriptorTest, FlushOnCloseFile) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, openFile(StrEq(FILENAME), _)).WillOnce(Return(GetParam())); EXPECT_CALL(fsimpl, flush(Eq(GetParam()))).Times(1); OpenAndCloseFile(FILENAME); } test/fspp/fuse/flush/testutils/000077500000000000000000000000001300002025200171105ustar00rootroot00000000000000test/fspp/fuse/flush/testutils/FuseFlushTest.cpp000066400000000000000000000007751300002025200223710ustar00rootroot00000000000000#include "FuseFlushTest.h" void FuseFlushTest::OpenAndCloseFile(const std::string &filename) { auto fs = TestFS(); int fd = OpenFile(fs.get(), filename); CloseFile(fd); } int FuseFlushTest::OpenFile(const TempTestFS *fs, const std::string &filename) { auto real_path = fs->mountDir() / filename; int fd = ::open(real_path.c_str(), O_RDONLY); EXPECT_GE(fd, 0) << "Opening file failed"; return fd; } void FuseFlushTest::CloseFile(int fd) { int retval = ::close(fd); EXPECT_EQ(0, retval); } test/fspp/fuse/flush/testutils/FuseFlushTest.h000066400000000000000000000006611300002025200220300ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_FLUSH_TESTUTILS_FUSEFLUSHTEST_H_ #define MESSMER_FSPP_TEST_FUSE_FLUSH_TESTUTILS_FUSEFLUSHTEST_H_ #include "../../../testutils/FuseTest.h" class FuseFlushTest: public FuseTest { public: const std::string FILENAME = "/myfile"; void OpenAndCloseFile(const std::string &filename); int OpenFile(const TempTestFS *fs, const std::string &filename); void CloseFile(int fd); }; #endif test/fspp/fuse/fstat/000077500000000000000000000000001300002025200150505ustar00rootroot00000000000000test/fspp/fuse/fstat/FuseFstatErrorTest.cpp000066400000000000000000000025611300002025200213360ustar00rootroot00000000000000#include "testutils/FuseFstatTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Eq; using ::testing::Return; using ::testing::Throw; using namespace fspp::fuse; // Cite from FUSE documentation on the fgetattr function: // "Currently this is only called after the create() method if that is implemented (see above). // Later it may be called for invocations of fstat() too." // So we need to issue a create to get our fstat called. class FuseFstatErrorTest: public FuseFstatTest, public WithParamInterface { public: int CreateFileAllowErrors(const TempTestFS *fs, const std::string &filename) { auto real_path = fs->mountDir() / filename; return ::open(real_path.c_str(), O_RDWR | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); } }; INSTANTIATE_TEST_CASE_P(FuseFstatErrorTest, FuseFstatErrorTest, Values(EACCES, EBADF, EFAULT, ELOOP, ENAMETOOLONG, ENOENT, ENOMEM, ENOTDIR, EOVERFLOW)); TEST_P(FuseFstatErrorTest, ReturnedErrorCodeIsCorrect) { ReturnDoesntExistOnLstat(FILENAME); OnCreateAndOpenReturnFileDescriptor(FILENAME, 0); EXPECT_CALL(fsimpl, fstat(Eq(0), _)).Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); auto fs = TestFS(); int error = CreateFileReturnError(fs.get(), FILENAME); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/fstat/FuseFstatParameterTest.cpp000066400000000000000000000021651300002025200221650ustar00rootroot00000000000000#include "testutils/FuseFstatTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Eq; using ::testing::Return; using ::testing::Throw; using namespace fspp::fuse; // Cite from FUSE documentation on the fgetattr function: // "Currently this is only called after the create() method if that is implemented (see above). // Later it may be called for invocations of fstat() too." // So we need to issue a create to get our fstat called. class FuseFstatParameterTest: public FuseFstatTest, public WithParamInterface { public: void CallFstat(const char *filename) { auto fs = TestFS(); CreateFile(fs.get(), filename); } }; INSTANTIATE_TEST_CASE_P(FuseFstatParameterTest, FuseFstatParameterTest, Values(0,1,10,1000,1024*1024*1024)); TEST_P(FuseFstatParameterTest, FileDescriptorIsCorrect) { ReturnDoesntExistOnLstat(FILENAME); OnCreateAndOpenReturnFileDescriptor(FILENAME, GetParam()); EXPECT_CALL(fsimpl, fstat(Eq(GetParam()), _)).Times(1).WillOnce(ReturnIsFileFstat); CallFstat(FILENAME); } test/fspp/fuse/fstat/README000066400000000000000000000005731300002025200157350ustar00rootroot00000000000000Cite from FUSE documentation on the fgetattr function: Currently this is only called after the create() method if that is implemented (see above). Later it may be called for invocations of fstat() too. So we need to issue a create to get our fstat called. Since fstat is currently only called after create, we can't call it directly. So we can't test the returned values.test/fspp/fuse/fstat/testutils/000077500000000000000000000000001300002025200171105ustar00rootroot00000000000000test/fspp/fuse/fstat/testutils/FuseFstatTest.cpp000066400000000000000000000017551300002025200223700ustar00rootroot00000000000000#include "FuseFstatTest.h" using ::testing::StrEq; using ::testing::_; using ::testing::Return; int FuseFstatTest::CreateFile(const TempTestFS *fs, const std::string &filename) { int fd = CreateFileAllowErrors(fs, filename); EXPECT_GE(fd, 0) << "Opening file failed"; return fd; } int FuseFstatTest::CreateFileReturnError(const TempTestFS *fs, const std::string &filename) { int fd = CreateFileAllowErrors(fs, filename); if (fd >= 0) { return 0; } else { return -fd; } } int FuseFstatTest::CreateFileAllowErrors(const TempTestFS *fs, const std::string &filename) { auto real_path = fs->mountDir() / filename; int fd = ::open(real_path.c_str(), O_RDWR | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); if (fd >= 0) { return fd; } else { return -errno; } } void FuseFstatTest::OnCreateAndOpenReturnFileDescriptor(const char *filename, int descriptor) { EXPECT_CALL(fsimpl, createAndOpenFile(StrEq(filename), _, _, _)).Times(1).WillOnce(Return(descriptor)); } test/fspp/fuse/fstat/testutils/FuseFstatTest.h000066400000000000000000000010631300002025200220250ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_FSTAT_TESTUTILS_FUSEFSTATTEST_H_ #define MESSMER_FSPP_TEST_FUSE_FSTAT_TESTUTILS_FUSEFSTATTEST_H_ #include "../../../testutils/FuseTest.h" class FuseFstatTest: public FuseTest { public: int CreateFile(const TempTestFS *fs, const std::string &filename); int CreateFileReturnError(const TempTestFS *fs, const std::string &filename); void OnCreateAndOpenReturnFileDescriptor(const char *filename, int descriptor); private: int CreateFileAllowErrors(const TempTestFS *fs, const std::string &filename); }; #endif test/fspp/fuse/fsync/000077500000000000000000000000001300002025200150515ustar00rootroot00000000000000test/fspp/fuse/fsync/FuseFsyncErrorTest.cpp000066400000000000000000000013331300002025200213340ustar00rootroot00000000000000#include "testutils/FuseFsyncTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using namespace fspp::fuse; class FuseFsyncErrorTest: public FuseFsyncTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseFsyncErrorTest, FuseFsyncErrorTest, Values(EBADF, EIO, EROFS, EINVAL)); TEST_P(FuseFsyncErrorTest, ReturnedErrorIsCorrect) { ReturnIsFileOnLstat(FILENAME); OnOpenReturnFileDescriptor(FILENAME, 0); EXPECT_CALL(fsimpl, fsync(0)) .Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); int error = FsyncFileReturnError(FILENAME); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/fsync/FuseFsyncFileDescriptorTest.cpp000066400000000000000000000013321300002025200231600ustar00rootroot00000000000000#include "testutils/FuseFsyncTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Eq; using ::testing::Return; using namespace fspp::fuse; class FuseFsyncFileDescriptorTest: public FuseFsyncTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseFsyncFileDescriptorTest, FuseFsyncFileDescriptorTest, Values(0,1,10,1000,1024*1024*1024)); TEST_P(FuseFsyncFileDescriptorTest, FileDescriptorIsCorrect) { ReturnIsFileOnLstat(FILENAME); OnOpenReturnFileDescriptor(FILENAME, GetParam()); EXPECT_CALL(fsimpl, fsync(Eq(GetParam()))) .Times(1).WillOnce(Return()); FsyncFile(FILENAME); } test/fspp/fuse/fsync/testutils/000077500000000000000000000000001300002025200171115ustar00rootroot00000000000000test/fspp/fuse/fsync/testutils/FuseFsyncTest.cpp000066400000000000000000000011341300002025200223610ustar00rootroot00000000000000#include "FuseFsyncTest.h" void FuseFsyncTest::FsyncFile(const char *filename) { int error = FsyncFileReturnError(filename); EXPECT_EQ(0, error); } int FuseFsyncTest::FsyncFileReturnError(const char *filename) { auto fs = TestFS(); int fd = OpenFile(fs.get(), filename); int retval = ::fsync(fd); if (retval == 0) { return 0; } else { return errno; } } int FuseFsyncTest::OpenFile(const TempTestFS *fs, const char *filename) { auto realpath = fs->mountDir() / filename; int fd = ::open(realpath.c_str(), O_RDWR); EXPECT_GE(fd, 0) << "Error opening file"; return fd; } test/fspp/fuse/fsync/testutils/FuseFsyncTest.h000066400000000000000000000006671300002025200220400ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_FSYNC_TESTUTILS_FUSEFSYNCTEST_H_ #define MESSMER_FSPP_TEST_FUSE_FSYNC_TESTUTILS_FUSEFSYNCTEST_H_ #include "../../../testutils/FuseTest.h" class FuseFsyncTest: public FuseTest { public: const char *FILENAME = "/myfile"; void FsyncFile(const char *filename); int FsyncFileReturnError(const char *filename); private: int OpenFile(const TempTestFS *fs, const char *filename); }; #endif test/fspp/fuse/ftruncate/000077500000000000000000000000001300002025200157225ustar00rootroot00000000000000test/fspp/fuse/ftruncate/FuseFTruncateErrorTest.cpp000066400000000000000000000016661300002025200230270ustar00rootroot00000000000000#include "testutils/FuseFTruncateTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using namespace fspp::fuse; class FuseFTruncateErrorTest: public FuseFTruncateTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseFTruncateErrorTest, FuseFTruncateErrorTest, Values(EACCES, EFAULT, EFBIG, EINTR, EINVAL, EIO, EISDIR, ELOOP, ENAMETOOLONG, ENOENT, ENOTDIR, EPERM, EROFS, ETXTBSY, EBADF)); TEST_P(FuseFTruncateErrorTest, ReturnedErrorIsCorrect) { ReturnIsFileOnLstat(FILENAME); OnOpenReturnFileDescriptor(FILENAME, 0); EXPECT_CALL(fsimpl, ftruncate(0, _)) .Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); //Needed to make ::ftruncate system call return successfully ReturnIsFileOnFstat(0); int error = FTruncateFileReturnError(FILENAME, 0); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/ftruncate/FuseFTruncateFileDescriptorTest.cpp000066400000000000000000000015721300002025200246500ustar00rootroot00000000000000#include "testutils/FuseFTruncateTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Eq; using ::testing::Return; using ::testing::Throw; using namespace fspp::fuse; class FuseFTruncateFileDescriptorTest: public FuseFTruncateTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseFTruncateFileDescriptorTest, FuseFTruncateFileDescriptorTest, Values(0,1,10,1000,1024*1024*1024)); TEST_P(FuseFTruncateFileDescriptorTest, FileDescriptorIsCorrect) { ReturnIsFileOnLstat(FILENAME); OnOpenReturnFileDescriptor(FILENAME, GetParam()); EXPECT_CALL(fsimpl, ftruncate(Eq(GetParam()), _)) .Times(1).WillOnce(Return()); //Needed to make ::ftruncate system call return successfully ReturnIsFileOnFstat(GetParam()); FTruncateFile(FILENAME, 0); } test/fspp/fuse/ftruncate/FuseFTruncateSizeTest.cpp000066400000000000000000000013451300002025200226420ustar00rootroot00000000000000#include "testutils/FuseFTruncateTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Eq; using ::testing::Return; using ::testing::WithParamInterface; using ::testing::Values; class FuseFTruncateSizeTest: public FuseFTruncateTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseFTruncateSizeTest, FuseFTruncateSizeTest, Values(0, 1, 10, 1024, 1024*1024*1024)); TEST_P(FuseFTruncateSizeTest, FTruncateFile) { ReturnIsFileOnLstat(FILENAME); OnOpenReturnFileDescriptor(FILENAME, 0); EXPECT_CALL(fsimpl, ftruncate(Eq(0), GetParam())) .Times(1).WillOnce(Return()); //Needed to make ::ftruncate system call return successfully ReturnIsFileOnFstat(0); FTruncateFile(FILENAME, GetParam()); } test/fspp/fuse/ftruncate/testutils/000077500000000000000000000000001300002025200177625ustar00rootroot00000000000000test/fspp/fuse/ftruncate/testutils/FuseFTruncateTest.cpp000066400000000000000000000012401300002025200240410ustar00rootroot00000000000000#include "FuseFTruncateTest.h" void FuseFTruncateTest::FTruncateFile(const char *filename, off_t size) { int error = FTruncateFileReturnError(filename, size); EXPECT_EQ(0, error); } int FuseFTruncateTest::FTruncateFileReturnError(const char *filename, off_t size) { auto fs = TestFS(); int fd = OpenFile(fs.get(), filename); int retval = ::ftruncate(fd, size); if (0 == retval) { return 0; } else { return errno; } } int FuseFTruncateTest::OpenFile(const TempTestFS *fs, const char *filename) { auto realpath = fs->mountDir() / filename; int fd = ::open(realpath.c_str(), O_RDWR); EXPECT_GE(fd, 0) << "Error opening file"; return fd; } test/fspp/fuse/ftruncate/testutils/FuseFTruncateTest.h000066400000000000000000000007531300002025200235160ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_FTRUNCATE_TESTUTILS_FUSEFTRUNCATETEST_H_ #define MESSMER_FSPP_TEST_FUSE_FTRUNCATE_TESTUTILS_FUSEFTRUNCATETEST_H_ #include "../../../testutils/FuseTest.h" class FuseFTruncateTest: public FuseTest { public: const char *FILENAME = "/myfile"; void FTruncateFile(const char *filename, off_t size); int FTruncateFileReturnError(const char *filename, off_t size); private: int OpenFile(const TempTestFS *fs, const char *filename); }; #endif test/fspp/fuse/lstat/000077500000000000000000000000001300002025200150565ustar00rootroot00000000000000test/fspp/fuse/lstat/FuseLstatErrorTest.cpp000066400000000000000000000017571300002025200213600ustar00rootroot00000000000000#include "testutils/FuseLstatTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::StrEq; using ::testing::_; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::AtLeast; using fspp::fuse::FuseErrnoException; class FuseLstatErrorTest: public FuseLstatTest, public WithParamInterface { public: }; INSTANTIATE_TEST_CASE_P(LstatErrorCodes, FuseLstatErrorTest, Values(EACCES, EBADF, EFAULT, ELOOP, ENAMETOOLONG, ENOENT, ENOMEM, ENOTDIR, EOVERFLOW, EINVAL, ENOTDIR)); TEST_F(FuseLstatErrorTest, ReturnNoError) { EXPECT_CALL(fsimpl, lstat(StrEq(FILENAME), _)).Times(AtLeast(1)).WillRepeatedly(ReturnIsFile); errno = 0; int error = LstatPathReturnError(FILENAME); EXPECT_EQ(0, error); } TEST_P(FuseLstatErrorTest, ReturnError) { EXPECT_CALL(fsimpl, lstat(StrEq(FILENAME), _)).Times(AtLeast(1)).WillRepeatedly(Throw(FuseErrnoException(GetParam()))); int error = LstatPathReturnError(FILENAME); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/lstat/FuseLstatPathParameterTest.cpp000066400000000000000000000024501300002025200230130ustar00rootroot00000000000000#include "testutils/FuseLstatTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::AtLeast; class FuseLstatPathParameterTest: public FuseLstatTest { }; TEST_F(FuseLstatPathParameterTest, PathParameterIsCorrectRoot) { EXPECT_CALL(fsimpl, lstat(StrEq("/"), _)).Times(AtLeast(1)).WillRepeatedly(ReturnIsDir); LstatPath("/"); } TEST_F(FuseLstatPathParameterTest, PathParameterIsCorrectSimpleFile) { EXPECT_CALL(fsimpl, lstat(StrEq("/myfile"), _)).Times(AtLeast(1)).WillRepeatedly(ReturnIsFile); LstatPath("/myfile"); } TEST_F(FuseLstatPathParameterTest, PathParameterIsCorrectSimpleDir) { EXPECT_CALL(fsimpl, lstat(StrEq("/mydir"), _)).Times(AtLeast(1)).WillRepeatedly(ReturnIsDir); LstatPath("/mydir/"); } TEST_F(FuseLstatPathParameterTest, PathParameterIsCorrectNestedFile) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); EXPECT_CALL(fsimpl, lstat(StrEq("/mydir/mydir2/myfile"), _)).Times(AtLeast(1)).WillRepeatedly(ReturnIsFile); LstatPath("/mydir/mydir2/myfile"); } TEST_F(FuseLstatPathParameterTest, PathParameterIsCorrectNestedDir) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); EXPECT_CALL(fsimpl, lstat(StrEq("/mydir/mydir2/mydir3"), _)).Times(AtLeast(1)).WillRepeatedly(ReturnIsDir); LstatPath("/mydir/mydir2/mydir3/"); } test/fspp/fuse/lstat/FuseLstatReturnAtimeTest.cpp000066400000000000000000000015251300002025200225170ustar00rootroot00000000000000#include "testutils/FuseLstatReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseLstatReturnATimeTest: public FuseLstatReturnTest, public WithParamInterface { private: void set(struct stat *stat, time_t value) override { stat->st_atime = value; } }; INSTANTIATE_TEST_CASE_P(FuseLstatReturnATimeTest, FuseLstatReturnATimeTest, Values( 0, 100, 1416496809, // current timestamp as of writing the test 32503680000 // needs a 64bit timestamp )); TEST_P(FuseLstatReturnATimeTest, ReturnedFileAtimeIsCorrect) { struct ::stat result = CallFileLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_atime); } TEST_P(FuseLstatReturnATimeTest, ReturnedDirAtimeIsCorrect) { struct ::stat result = CallDirLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_atime); } test/fspp/fuse/lstat/FuseLstatReturnCtimeTest.cpp000066400000000000000000000015251300002025200225210ustar00rootroot00000000000000#include "testutils/FuseLstatReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseLstatReturnCtimeTest: public FuseLstatReturnTest, public WithParamInterface { private: void set(struct stat *stat, time_t value) override { stat->st_ctime = value; } }; INSTANTIATE_TEST_CASE_P(FuseLstatReturnCtimeTest, FuseLstatReturnCtimeTest, Values( 0, 100, 1416496809, // current timestamp as of writing the test 32503680000 // needs a 64bit timestamp )); TEST_P(FuseLstatReturnCtimeTest, ReturnedFileCtimeIsCorrect) { struct ::stat result = CallFileLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_ctime); } TEST_P(FuseLstatReturnCtimeTest, ReturnedDirCtimeIsCorrect) { struct ::stat result = CallDirLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_ctime); } test/fspp/fuse/lstat/FuseLstatReturnGidTest.cpp000066400000000000000000000013251300002025200221610ustar00rootroot00000000000000#include "testutils/FuseLstatReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseLstatReturnGidTest: public FuseLstatReturnTest, public WithParamInterface { private: void set(struct stat *stat, gid_t value) override { stat->st_gid = value; } }; INSTANTIATE_TEST_CASE_P(FuseLstatReturnGidTest, FuseLstatReturnGidTest, Values( 0, 10 )); TEST_P(FuseLstatReturnGidTest, ReturnedFileGidIsCorrect) { struct ::stat result = CallFileLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_gid); } TEST_P(FuseLstatReturnGidTest, ReturnedDirGidIsCorrect) { struct ::stat result = CallDirLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_gid); } test/fspp/fuse/lstat/FuseLstatReturnModeTest.cpp000066400000000000000000000014141300002025200223410ustar00rootroot00000000000000#include "testutils/FuseLstatReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseLstatReturnModeTest: public FuseLstatTest, public WithParamInterface { public: struct stat CallLstatWithValue(mode_t mode) { return CallLstatWithImpl([mode] (struct stat *stat) { stat->st_mode = mode; }); } }; INSTANTIATE_TEST_CASE_P(FuseLstatReturnModeTest, FuseLstatReturnModeTest, Values( S_IFREG, S_IFDIR, S_IFREG | S_IRUSR | S_IWGRP | S_IXOTH, // a file with some access bits set S_IFDIR | S_IWUSR | S_IXGRP | S_IROTH // a dir with some access bits set )); TEST_P(FuseLstatReturnModeTest, ReturnedModeIsCorrect) { struct ::stat result = CallLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_mode); } test/fspp/fuse/lstat/FuseLstatReturnMtimeTest.cpp000066400000000000000000000015251300002025200225330ustar00rootroot00000000000000#include "testutils/FuseLstatReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseLstatReturnMtimeTest: public FuseLstatReturnTest, public WithParamInterface { private: void set(struct stat *stat, time_t value) override { stat->st_mtime = value; } }; INSTANTIATE_TEST_CASE_P(FuseLstatReturnMtimeTest, FuseLstatReturnMtimeTest, Values( 0, 100, 1416496809, // current timestamp as of writing the test 32503680000 // needs a 64bit timestamp )); TEST_P(FuseLstatReturnMtimeTest, ReturnedFileMtimeIsCorrect) { struct ::stat result = CallFileLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_mtime); } TEST_P(FuseLstatReturnMtimeTest, ReturnedDirMtimeIsCorrect) { struct ::stat result = CallDirLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_mtime); } test/fspp/fuse/lstat/FuseLstatReturnNlinkTest.cpp000066400000000000000000000013761300002025200225370ustar00rootroot00000000000000#include "testutils/FuseLstatReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseLstatReturnNlinkTest: public FuseLstatReturnTest, public WithParamInterface { private: void set(struct stat *stat, nlink_t value) override { stat->st_nlink = value; } }; INSTANTIATE_TEST_CASE_P(FuseLstatReturnNlinkTest, FuseLstatReturnNlinkTest, Values( 1, 2, 5, 100 )); TEST_P(FuseLstatReturnNlinkTest, ReturnedFileNlinkIsCorrect) { struct ::stat result = CallDirLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_nlink); } TEST_P(FuseLstatReturnNlinkTest, ReturnedDirNlinkIsCorrect) { struct ::stat result = CallDirLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_nlink); } test/fspp/fuse/lstat/FuseLstatReturnSizeTest.cpp000066400000000000000000000013731300002025200223730ustar00rootroot00000000000000#include "testutils/FuseLstatReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseLstatReturnSizeTest: public FuseLstatReturnTest, public WithParamInterface { private: void set(struct stat *stat, off_t value) override { stat->st_size = value; } }; INSTANTIATE_TEST_CASE_P(FuseLstatReturnSizeTest, FuseLstatReturnSizeTest, Values( 0, 1, 4096, 1024*1024*1024 )); TEST_P(FuseLstatReturnSizeTest, ReturnedFileSizeIsCorrect) { struct ::stat result = CallDirLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_size); } TEST_P(FuseLstatReturnSizeTest, ReturnedDirSizeIsCorrect) { struct ::stat result = CallDirLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_size); } test/fspp/fuse/lstat/FuseLstatReturnUidTest.cpp000066400000000000000000000013251300002025200221770ustar00rootroot00000000000000#include "testutils/FuseLstatReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseLstatReturnUidTest: public FuseLstatReturnTest, public WithParamInterface { private: void set(struct stat *stat, uid_t value) override { stat->st_uid = value; } }; INSTANTIATE_TEST_CASE_P(FuseLstatReturnUidTest, FuseLstatReturnUidTest, Values( 0, 10 )); TEST_P(FuseLstatReturnUidTest, ReturnedFileUidIsCorrect) { struct ::stat result = CallFileLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_uid); } TEST_P(FuseLstatReturnUidTest, ReturnedDirUidIsCorrect) { struct ::stat result = CallDirLstatWithValue(GetParam()); EXPECT_EQ(GetParam(), result.st_uid); } test/fspp/fuse/lstat/testutils/000077500000000000000000000000001300002025200171165ustar00rootroot00000000000000test/fspp/fuse/lstat/testutils/FuseLstatReturnTest.h000066400000000000000000000031421300002025200232410ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_LSTAT_TESTUTILS_FUSELSTATRETURNTEST_H_ #define MESSMER_FSPP_TEST_FUSE_LSTAT_TESTUTILS_FUSELSTATRETURNTEST_H_ #include "FuseLstatTest.h" // This class offers test helpers for testing (struct stat) entries. We return them from // our mock filesystem, set up a temporary filesystem, call lstat syscall on it, and // then check the return value. template class FuseLstatReturnTest: public FuseLstatTest { public: // Set the specified (struct stat) entry to the given value, and test whether it is correctly returned from the syscall. // The CallFile[...] version tests it on a file node of the filesystem, the CallDir[...] version on a dir node. struct stat CallFileLstatWithValue(Property value); struct stat CallDirLstatWithValue(Property value); private: std::function SetPropertyImpl(Property value); // Override this function to specify, how to set the specified (struct stat) entry on the passed (struct stat *) object. virtual void set(struct stat *stat, Property value) = 0; }; template struct stat FuseLstatReturnTest::CallFileLstatWithValue(Property value) { return CallFileLstatWithImpl(SetPropertyImpl(value)); } template struct stat FuseLstatReturnTest::CallDirLstatWithValue(Property value) { return CallDirLstatWithImpl(SetPropertyImpl(value)); } template std::function FuseLstatReturnTest::SetPropertyImpl(Property value) { return [this, value] (struct stat *stat) { set(stat, value); }; } #endif test/fspp/fuse/lstat/testutils/FuseLstatTest.cpp000066400000000000000000000032701300002025200223760ustar00rootroot00000000000000#include "FuseLstatTest.h" using std::function; using ::testing::StrEq; using ::testing::_; using ::testing::Invoke; void FuseLstatTest::LstatPath(const std::string &path) { struct stat dummy; LstatPath(path, &dummy); } int FuseLstatTest::LstatPathReturnError(const std::string &path) { struct stat dummy; return LstatPathReturnError(path, &dummy); } void FuseLstatTest::LstatPath(const std::string &path, struct stat *result) { int error = LstatPathReturnError(path, result); EXPECT_EQ(0, error) << "lstat syscall failed. errno: " << error; } int FuseLstatTest::LstatPathReturnError(const std::string &path, struct stat *result) { auto fs = TestFS(); auto realpath = fs->mountDir() / path; int retval = ::lstat(realpath.c_str(), result); if (retval == 0) { return 0; } else { return errno; } } struct stat FuseLstatTest::CallFileLstatWithImpl(function implementation) { return CallLstatWithModeAndImpl(S_IFREG, implementation); } struct stat FuseLstatTest::CallDirLstatWithImpl(function implementation) { return CallLstatWithModeAndImpl(S_IFDIR, implementation); } struct stat FuseLstatTest::CallLstatWithImpl(function implementation) { EXPECT_CALL(fsimpl, lstat(StrEq(FILENAME), _)).WillRepeatedly(Invoke([implementation](const char*, struct ::stat *stat) { implementation(stat); })); struct stat result; LstatPath(FILENAME, &result); return result; } struct stat FuseLstatTest::CallLstatWithModeAndImpl(mode_t mode, function implementation) { return CallLstatWithImpl([mode, implementation] (struct stat *stat) { stat->st_mode = mode; implementation(stat); }); } test/fspp/fuse/lstat/testutils/FuseLstatTest.h000066400000000000000000000037101300002025200220420ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_LSTAT_TESTUTILS_FUSELSTATTEST_H_ #define MESSMER_FSPP_TEST_FUSE_LSTAT_TESTUTILS_FUSELSTATTEST_H_ #include #include #include #include "../../../testutils/FuseTest.h" // This class offers some utility functions for testing lstat(). class FuseLstatTest: public FuseTest { protected: const char *FILENAME = "/myfile"; // Set up a temporary filesystem (using the fsimpl mock in FuseTest as filesystem implementation) // and call the lstat syscall on the given (filesystem-relative) path. void LstatPath(const std::string &path); // Same as LstatPath above, but also return the result of the lstat syscall. void LstatPath(const std::string &path, struct stat *result); // These two functions are the same as LstatPath above, but they don't fail the test when the lstat syscall // crashes. Instead, they return the value of errno after calling ::lstat. int LstatPathReturnError(const std::string &path); int LstatPathReturnError(const std::string &path, struct stat *result); // You can specify an implementation, which can modify the (struct stat *) result, // our fuse mock filesystem implementation will then return this to fuse on an lstat call. // This functions then set up a temporary filesystem with this mock, call lstat on a filesystem node // and return the (struct stat) returned from an lstat syscall to this filesystem. struct stat CallLstatWithImpl(std::function implementation); // These two functions are like CallLstatWithImpl, but they also modify the (struct stat).st_mode // field, so the node accessed is specified to be a file/directory. struct stat CallFileLstatWithImpl(std::function implementation); struct stat CallDirLstatWithImpl(std::function implementation); private: struct stat CallLstatWithModeAndImpl(mode_t mode, std::function implementation); }; #endif test/fspp/fuse/mkdir/000077500000000000000000000000001300002025200150355ustar00rootroot00000000000000test/fspp/fuse/mkdir/FuseMkdirDirnameTest.cpp000066400000000000000000000025641300002025200216010ustar00rootroot00000000000000#include "testutils/FuseMkdirTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; using ::testing::Invoke; using ::testing::Action; class FuseMkdirDirnameTest: public FuseMkdirTest { }; TEST_F(FuseMkdirDirnameTest, Mkdir) { ReturnDoesntExistOnLstat("/mydir"); EXPECT_CALL(fsimpl, mkdir(StrEq("/mydir"), _, _, _)) // After mkdir was called, lstat should return that it is a dir. // This is needed to make the ::mkdir() syscall pass. .Times(1).WillOnce(FromNowOnReturnIsDirOnLstat()); Mkdir("/mydir", 0); } TEST_F(FuseMkdirDirnameTest, MkdirNested) { ReturnIsDirOnLstat("/mydir"); ReturnDoesntExistOnLstat("/mydir/mysubdir"); EXPECT_CALL(fsimpl, mkdir(StrEq("/mydir/mysubdir"), _, _, _)) // After mkdir was called, lstat should return that it is a dir. // This is needed to make the ::mkdir() syscall pass. .Times(1).WillOnce(FromNowOnReturnIsDirOnLstat()); Mkdir("/mydir/mysubdir", 0); } TEST_F(FuseMkdirDirnameTest, MkdirNested2) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnDoesntExistOnLstat("/mydir/mydir2/mydir3"); EXPECT_CALL(fsimpl, mkdir(StrEq("/mydir/mydir2/mydir3"), _, _, _)) // After mkdir was called, lstat should return that it is a dir. // This is needed to make the ::mkdir() syscall pass. .Times(1).WillOnce(FromNowOnReturnIsDirOnLstat()); Mkdir("/mydir/mydir2/mydir3", 0); } test/fspp/fuse/mkdir/FuseMkdirErrorTest.cpp000066400000000000000000000020371300002025200213060ustar00rootroot00000000000000#include "testutils/FuseMkdirTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using namespace fspp::fuse; class FuseMkdirErrorTest: public FuseMkdirTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseMkdirErrorTest, FuseMkdirErrorTest, Values(EACCES, EDQUOT, EEXIST, EFAULT, ELOOP, EMLINK, ENAMETOOLONG, ENOENT, ENOMEM, ENOSPC, ENOTDIR, EPERM, EROFS, EBADF)); TEST_F(FuseMkdirErrorTest, NoError) { ReturnDoesntExistOnLstat(DIRNAME); EXPECT_CALL(fsimpl, mkdir(StrEq(DIRNAME), _, _, _)) .Times(1).WillOnce(FromNowOnReturnIsDirOnLstat()); int error = MkdirReturnError(DIRNAME, 0); EXPECT_EQ(0, error); } TEST_P(FuseMkdirErrorTest, ReturnedErrorIsCorrect) { ReturnDoesntExistOnLstat(DIRNAME); EXPECT_CALL(fsimpl, mkdir(StrEq(DIRNAME), _, _, _)) .Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); int error = MkdirReturnError(DIRNAME, 0); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/mkdir/FuseMkdirModeTest.cpp000066400000000000000000000011471300002025200211020ustar00rootroot00000000000000#include "testutils/FuseMkdirTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; using ::testing::WithParamInterface; using ::testing::Values; class FuseMkdirModeTest: public FuseMkdirTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseMkdirModeTest, FuseMkdirModeTest, Values(0, S_IRUSR, S_IRGRP, S_IXOTH, S_IRUSR|S_IRGRP|S_IROTH|S_IRGRP)); TEST_P(FuseMkdirModeTest, Mkdir) { ReturnDoesntExistOnLstat(DIRNAME); EXPECT_CALL(fsimpl, mkdir(StrEq(DIRNAME), GetParam(), _, _)) .Times(1).WillOnce(FromNowOnReturnIsDirOnLstat()); Mkdir(DIRNAME, GetParam()); } test/fspp/fuse/mkdir/testutils/000077500000000000000000000000001300002025200170755ustar00rootroot00000000000000test/fspp/fuse/mkdir/testutils/FuseMkdirTest.cpp000066400000000000000000000012441300002025200223330ustar00rootroot00000000000000#include "FuseMkdirTest.h" using ::testing::Action; using ::testing::Invoke; void FuseMkdirTest::Mkdir(const char *dirname, mode_t mode) { int error = MkdirReturnError(dirname, mode); EXPECT_EQ(0, error); } int FuseMkdirTest::MkdirReturnError(const char *dirname, mode_t mode) { auto fs = TestFS(); auto realpath = fs->mountDir() / dirname; int retval = ::mkdir(realpath.c_str(), mode); if (retval == 0) { return 0; } else { return errno; } } Action FuseMkdirTest::FromNowOnReturnIsDirOnLstat() { return Invoke([this](const char *dirname, mode_t, uid_t, gid_t) { ReturnIsDirOnLstat(dirname); }); } test/fspp/fuse/mkdir/testutils/FuseMkdirTest.h000066400000000000000000000007341300002025200220030ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_MKDIR_TESTUTILS_FUSEMKDIRTEST_H_ #define MESSMER_FSPP_TEST_FUSE_MKDIR_TESTUTILS_FUSEMKDIRTEST_H_ #include "../../../testutils/FuseTest.h" class FuseMkdirTest: public FuseTest { public: const char *DIRNAME = "/mydir"; void Mkdir(const char *dirname, mode_t mode); int MkdirReturnError(const char *dirname, mode_t mode); ::testing::Action FromNowOnReturnIsDirOnLstat(); }; #endif test/fspp/fuse/openFile/000077500000000000000000000000001300002025200154705ustar00rootroot00000000000000test/fspp/fuse/openFile/FuseOpenErrorTest.cpp000066400000000000000000000022161300002025200215730ustar00rootroot00000000000000#include "testutils/FuseOpenTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Return; using ::testing::Throw; using ::testing::StrEq; using ::testing::_; using namespace fspp::fuse; class FuseOpenErrorTest: public FuseOpenTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseOpenErrorTest, FuseOpenErrorTest, Values(EACCES, EDQUOT, EEXIST, EFAULT, EFBIG, EINTR, EOVERFLOW, EINVAL, EISDIR, ELOOP, EMFILE, ENAMETOOLONG, ENFILE, ENODEV, ENOENT, ENOMEM, ENOSPC, ENOTDIR, ENXIO, EOPNOTSUPP, EPERM, EROFS, ETXTBSY, EWOULDBLOCK, EBADF, ENOTDIR)); TEST_F(FuseOpenErrorTest, ReturnNoError) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, openFile(StrEq(FILENAME), _)).Times(1).WillOnce(Return(1)); errno = 0; int error = OpenFileReturnError(FILENAME, O_RDONLY); EXPECT_EQ(0, error); } TEST_P(FuseOpenErrorTest, ReturnError) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, openFile(StrEq(FILENAME), _)).Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); int error = OpenFileReturnError(FILENAME, O_RDONLY); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/openFile/FuseOpenFileDescriptorTest.cpp000066400000000000000000000022741300002025200234240ustar00rootroot00000000000000#include "testutils/FuseOpenTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Return; class FuseOpenFileDescriptorTest: public FuseOpenTest, public WithParamInterface { public: void OpenAndReadFile(const char *filename) { auto fs = TestFS(); int fd = OpenFile(fs.get(), filename); ReadFile(fd); } private: int OpenFile(const TempTestFS *fs, const char *filename) { auto realpath = fs->mountDir() / filename; int fd = ::open(realpath.c_str(), O_RDONLY); EXPECT_GE(fd, 0) << "Opening file failed"; return fd; } void ReadFile(int fd) { uint8_t buf; int retval = ::read(fd, &buf, 1); EXPECT_EQ(1, retval) << "Reading file failed"; } }; INSTANTIATE_TEST_CASE_P(FuseOpenFileDescriptorTest, FuseOpenFileDescriptorTest, Values(0, 2, 5, 1000, 1024*1024*1024)); TEST_P(FuseOpenFileDescriptorTest, TestReturnedFileDescriptor) { ReturnIsFileOnLstatWithSize(FILENAME, 1); EXPECT_CALL(fsimpl, openFile(StrEq(FILENAME), _)) .Times(1).WillOnce(Return(GetParam())); EXPECT_CALL(fsimpl, read(GetParam(), _, _, _)).Times(1).WillOnce(Return(1)); OpenAndReadFile(FILENAME); } test/fspp/fuse/openFile/FuseOpenFilenameTest.cpp000066400000000000000000000016551300002025200222300ustar00rootroot00000000000000#include "testutils/FuseOpenTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; class FuseOpenFilenameTest: public FuseOpenTest { public: }; TEST_F(FuseOpenFilenameTest, OpenFile) { ReturnIsFileOnLstat("/myfile"); EXPECT_CALL(fsimpl, openFile(StrEq("/myfile"), _)) .Times(1).WillOnce(Return(0)); OpenFile("/myfile", O_RDONLY); } TEST_F(FuseOpenFilenameTest, OpenFileNested) { ReturnIsDirOnLstat("/mydir"); ReturnIsFileOnLstat("/mydir/myfile"); EXPECT_CALL(fsimpl, openFile(StrEq("/mydir/myfile"), _)) .Times(1).WillOnce(Return(0)); OpenFile("/mydir/myfile", O_RDONLY); } TEST_F(FuseOpenFilenameTest, OpenFileNested2) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnIsFileOnLstat("/mydir/mydir2/myfile"); EXPECT_CALL(fsimpl, openFile(StrEq("/mydir/mydir2/myfile"), _)) .Times(1).WillOnce(Return(0)); OpenFile("/mydir/mydir2/myfile", O_RDONLY); } test/fspp/fuse/openFile/FuseOpenFlagsTest.cpp000066400000000000000000000010711300002025200215340ustar00rootroot00000000000000#include "testutils/FuseOpenTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Return; class FuseOpenFlagsTest: public FuseOpenTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseOpenFlagsTest, FuseOpenFlagsTest, Values(O_RDWR, O_RDONLY, O_WRONLY)); TEST_P(FuseOpenFlagsTest, testFlags) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, openFile(StrEq(FILENAME), OpenFlagsEq(GetParam()))) .Times(1).WillOnce(Return(0)); OpenFile(FILENAME, GetParam()); } test/fspp/fuse/openFile/testutils/000077500000000000000000000000001300002025200175305ustar00rootroot00000000000000test/fspp/fuse/openFile/testutils/FuseOpenTest.cpp000066400000000000000000000011431300002025200226170ustar00rootroot00000000000000#include "FuseOpenTest.h" int FuseOpenTest::OpenFile(const char *filename, int flags) { int fd = OpenFileAllowError(filename, flags); EXPECT_GE(fd, 0); return fd; } int FuseOpenTest::OpenFileReturnError(const char *filename, int flags) { int fd = OpenFileAllowError(filename, flags); if (fd >= 0) { return 0; } else { return -fd; } } int FuseOpenTest::OpenFileAllowError(const char *filename, int flags) { auto fs = TestFS(); auto realpath = fs->mountDir() / filename; int fd = ::open(realpath.c_str(), flags); if (fd >= 0) { return fd; } else { return -errno; } } test/fspp/fuse/openFile/testutils/FuseOpenTest.h000066400000000000000000000010471300002025200222670ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_OPENFILE_TESTUTILS_FUSEOPENTEST_H_ #define MESSMER_FSPP_TEST_FUSE_OPENFILE_TESTUTILS_FUSEOPENTEST_H_ #include "../../../testutils/FuseTest.h" class FuseOpenTest: public FuseTest { public: const char *FILENAME = "/myfile"; int OpenFile(const char *FILENAME, int flags); int OpenFileReturnError(const char *FILENAME, int flags); private: int OpenFileAllowError(const char *FILENAME, int flags); }; MATCHER_P(OpenFlagsEq, expectedFlags, "") { return expectedFlags == (O_ACCMODE & arg); } #endif test/fspp/fuse/read/000077500000000000000000000000001300002025200146425ustar00rootroot00000000000000test/fspp/fuse/read/FuseReadErrorTest.cpp000066400000000000000000000041751300002025200207250ustar00rootroot00000000000000#include "testutils/FuseReadTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Eq; using ::testing::Ne; using ::testing::Return; using ::testing::Invoke; using ::testing::Throw; using namespace fspp::fuse; class FuseReadErrorTest: public FuseReadTest, public WithParamInterface { public: size_t FILESIZE = 64*1024*1024; size_t READCOUNT = 32*1024*1024; void SetUp() override { //Make the file size big enough that fuse should issue at least two reads ReturnIsFileOnLstatWithSize(FILENAME, FILESIZE); OnOpenReturnFileDescriptor(FILENAME, 0); } }; INSTANTIATE_TEST_CASE_P(FuseReadErrorTest, FuseReadErrorTest, Values(EAGAIN, EBADF, EFAULT, EINTR, EINVAL, EIO, EISDIR, EOVERFLOW, ESPIPE, ENXIO)); TEST_P(FuseReadErrorTest, ReturnErrorOnFirstReadCall) { EXPECT_CALL(fsimpl, read(0, _, _, _)) .WillRepeatedly(Throw(FuseErrnoException(GetParam()))); char *buf = new char[READCOUNT]; auto retval = ReadFileReturnError(FILENAME, buf, READCOUNT, 0); EXPECT_EQ(GetParam(), retval.error); delete[] buf; } TEST_P(FuseReadErrorTest, ReturnErrorOnSecondReadCall) { // The first read request is from the beginning of the file and works, but the later ones fail. // We store the number of bytes the first call could successfully read and check later that our // read syscall returns exactly this number of bytes size_t successfullyReadBytes = -1; EXPECT_CALL(fsimpl, read(0, _, _, Eq(0))) .Times(1) .WillOnce(Invoke([&successfullyReadBytes](int, void*, size_t count, off_t) { // Store the number of successfully read bytes successfullyReadBytes = count; return count; })); EXPECT_CALL(fsimpl, read(0, _, _, Ne(0))) .WillRepeatedly(Throw(FuseErrnoException(GetParam()))); char *buf = new char[READCOUNT]; auto retval = ReadFileReturnError(FILENAME, buf, READCOUNT, 0); EXPECT_EQ(0, retval.error); EXPECT_EQ(successfullyReadBytes, retval.read_bytes); // Check that we're getting the number of successfully read bytes (the first read call) returned delete[] buf; } test/fspp/fuse/read/FuseReadFileDescriptorTest.cpp000066400000000000000000000014751300002025200225520ustar00rootroot00000000000000#include "testutils/FuseReadTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Eq; using ::testing::Return; using ::testing::Invoke; using ::testing::Throw; using namespace fspp::fuse; class FuseReadFileDescriptorTest: public FuseReadTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseReadFileDescriptorTest, FuseReadFileDescriptorTest, Values(0,1,10,1000,1024*1024*1024)); TEST_P(FuseReadFileDescriptorTest, FileDescriptorIsCorrect) { ReturnIsFileOnLstatWithSize(FILENAME, 1); OnOpenReturnFileDescriptor(FILENAME, GetParam()); EXPECT_CALL(fsimpl, read(Eq(GetParam()), _, _, _)) .Times(1).WillOnce(ReturnSuccessfulRead); char buf[1]; ReadFile(FILENAME, buf, 1, 0); } test/fspp/fuse/read/FuseReadOverflowTest.cpp000066400000000000000000000020431300002025200214270ustar00rootroot00000000000000#include "testutils/FuseReadTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Eq; using ::testing::Return; using ::testing::Invoke; using ::testing::Action; using std::min; using namespace fspp::fuse; class FuseReadOverflowTest: public FuseReadTest { public: const size_t FILESIZE = 1000; const size_t READSIZE = 2000; const size_t OFFSET = 500; void SetUp() override { ReturnIsFileOnLstatWithSize(FILENAME, FILESIZE); OnOpenReturnFileDescriptor(FILENAME, 0); EXPECT_CALL(fsimpl, read(0, _, _, _)).WillRepeatedly(ReturnSuccessfulReadRegardingSize(FILESIZE)); } }; TEST_F(FuseReadOverflowTest, ReadMoreThanFileSizeFromBeginning) { char buf[READSIZE]; auto retval = ReadFileReturnError(FILENAME, buf, READSIZE, 0); EXPECT_EQ(FILESIZE, retval.read_bytes); } TEST_F(FuseReadOverflowTest, ReadMoreThanFileSizeFromMiddle) { char buf[READSIZE]; auto retval = ReadFileReturnError(FILENAME, buf, READSIZE, OFFSET); EXPECT_EQ(FILESIZE-OFFSET, retval.read_bytes); } test/fspp/fuse/read/FuseReadReturnedDataTest.cpp000066400000000000000000000053411300002025200222120ustar00rootroot00000000000000#include #include #include "../../testutils/InMemoryFile.h" #include "testutils/FuseReadTest.h" #include #include "fspp/fuse/FuseErrnoException.h" #include #include using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Combine; using ::testing::Eq; using ::testing::Return; using ::testing::Invoke; using ::testing::Action; using std::tuple; using std::get; using std::min; using cpputils::Data; using cpputils::DataFixture; using namespace fspp::fuse; // We can't test the count or size parameter directly, because fuse doesn't pass them 1:1. // It usually asks to read bigger blocks (probably does some caching). // But we can test that the data returned from the ::read syscall is the correct data region. struct TestData { TestData(): count(0), offset(0), additional_bytes_at_end_of_file(0) {} TestData(const tuple &data): count(get<0>(data)), offset(get<1>(data)), additional_bytes_at_end_of_file(get<2>(data)) {} size_t count; off_t offset; //How many more bytes does the file have after the read block? size_t additional_bytes_at_end_of_file; size_t fileSize() { return count + offset + additional_bytes_at_end_of_file; } }; // The testcase creates random data in memory, offers a mock read() implementation to read from this // memory region and check methods to check for data equality of a region. class FuseReadReturnedDataTest: public FuseReadTest, public WithParamInterface> { public: std::unique_ptr testFile; TestData testData; FuseReadReturnedDataTest() : testFile(nullptr), testData(GetParam()) { testFile = std::make_unique(DataFixture::generate(testData.fileSize())); ReturnIsFileOnLstatWithSize(FILENAME, testData.fileSize()); OnOpenReturnFileDescriptor(FILENAME, 0); EXPECT_CALL(fsimpl, read(0, _, _, _)) .WillRepeatedly(ReadFromFile); } // This read() mock implementation reads from the stored virtual file (testFile). Action ReadFromFile = Invoke([this](int, void *buf, size_t count, off_t offset) { return testFile->read(buf, count, offset); }); }; INSTANTIATE_TEST_CASE_P(FuseReadReturnedDataTest, FuseReadReturnedDataTest, Combine(Values(0,1,10,1000,1024, 10*1024*1024), Values(0, 1, 10, 1024, 10*1024*1024), Values(0, 1, 10, 1024, 10*1024*1024))); TEST_P(FuseReadReturnedDataTest, ReturnedDataRangeIsCorrect) { Data buf(testData.count); ReadFile(FILENAME, buf.data(), testData.count, testData.offset); EXPECT_TRUE(testFile->fileContentEquals(buf, testData.offset)); } test/fspp/fuse/read/testutils/000077500000000000000000000000001300002025200167025ustar00rootroot00000000000000test/fspp/fuse/read/testutils/FuseReadTest.cpp000066400000000000000000000014371300002025200217510ustar00rootroot00000000000000#include "FuseReadTest.h" void FuseReadTest::ReadFile(const char *filename, void *buf, size_t count, off_t offset) { auto retval = ReadFileReturnError(filename, buf, count, offset); EXPECT_EQ(0, retval.error); EXPECT_EQ(count, retval.read_bytes); } FuseReadTest::ReadError FuseReadTest::ReadFileReturnError(const char *filename, void *buf, size_t count, off_t offset) { auto fs = TestFS(); int fd = OpenFile(fs.get(), filename); ReadError result; errno = 0; result.read_bytes = ::pread(fd, buf, count, offset); result.error = errno; return result; } int FuseReadTest::OpenFile(const TempTestFS *fs, const char *filename) { auto realpath = fs->mountDir() / filename; int fd = ::open(realpath.c_str(), O_RDONLY); EXPECT_GE(fd, 0) << "Error opening file"; return fd; } test/fspp/fuse/read/testutils/FuseReadTest.h000066400000000000000000000020441300002025200214110ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_READ_TESTUTILS_FUSEREADTEST_H_ #define MESSMER_FSPP_TEST_FUSE_READ_TESTUTILS_FUSEREADTEST_H_ #include "../../../testutils/FuseTest.h" class FuseReadTest: public FuseTest { public: const char *FILENAME = "/myfile"; struct ReadError { int error; size_t read_bytes; }; void ReadFile(const char *filename, void *buf, size_t count, off_t offset); ReadError ReadFileReturnError(const char *filename, void *buf, size_t count, off_t offset); ::testing::Action ReturnSuccessfulRead = ::testing::Invoke([](int, void *, size_t count, off_t) { return count; }); ::testing::Action ReturnSuccessfulReadRegardingSize(size_t filesize) { return ::testing::Invoke([filesize](int, void *, size_t count, off_t offset) { size_t ableToReadCount = std::min(count, (size_t)(filesize - offset)); return ableToReadCount; }); } private: int OpenFile(const TempTestFS *fs, const char *filename); }; #endif test/fspp/fuse/readDir/000077500000000000000000000000001300002025200153015ustar00rootroot00000000000000test/fspp/fuse/readDir/FuseReadDirDirnameTest.cpp000066400000000000000000000021501300002025200223000ustar00rootroot00000000000000#include "testutils/FuseReadDirTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; using std::vector; using std::string; class FuseReadDirDirnameTest: public FuseReadDirTest { public: }; TEST_F(FuseReadDirDirnameTest, ReadRootDir) { EXPECT_CALL(fsimpl, readDir(StrEq("/"))) .Times(1).WillOnce(ReturnDirEntries({})); ReadDir("/"); } TEST_F(FuseReadDirDirnameTest, ReadDir) { ReturnIsDirOnLstat("/mydir"); EXPECT_CALL(fsimpl, readDir(StrEq("/mydir"))) .Times(1).WillOnce(ReturnDirEntries({})); ReadDir("/mydir"); } TEST_F(FuseReadDirDirnameTest, ReadDirNested) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); EXPECT_CALL(fsimpl, readDir(StrEq("/mydir/mydir2"))) .Times(1).WillOnce(ReturnDirEntries({})); ReadDir("/mydir/mydir2"); } TEST_F(FuseReadDirDirnameTest, ReadDirNested2) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnIsDirOnLstat("/mydir/mydir2/mydir3"); EXPECT_CALL(fsimpl, readDir(StrEq("/mydir/mydir2/mydir3"))) .Times(1).WillOnce(ReturnDirEntries({})); ReadDir("/mydir/mydir2/mydir3"); } test/fspp/fuse/readDir/FuseReadDirErrorTest.cpp000066400000000000000000000021711300002025200220150ustar00rootroot00000000000000#include "testutils/FuseReadDirTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using std::vector; using std::string; using namespace fspp::fuse; class FuseReadDirErrorTest: public FuseReadDirTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseReadDirErrorTest, FuseReadDirErrorTest, Values(EACCES, EBADF, EMFILE, ENFILE, ENOMEM, ENOTDIR, EFAULT, EINVAL)); //TODO On ENOENT, libfuse doesn't return the ENOENT error, but returns a success response with an empty directory. Why? TEST_F(FuseReadDirErrorTest, NoError) { ReturnIsDirOnLstat(DIRNAME); EXPECT_CALL(fsimpl, readDir(StrEq(DIRNAME))) .Times(1).WillOnce(ReturnDirEntries({})); int error = ReadDirReturnError(DIRNAME); EXPECT_EQ(0, error); } TEST_P(FuseReadDirErrorTest, ReturnedErrorCodeIsCorrect) { ReturnIsDirOnLstat(DIRNAME); EXPECT_CALL(fsimpl, readDir(StrEq(DIRNAME))) .Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); int error = ReadDirReturnError(DIRNAME); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/readDir/FuseReadDirReturnTest.cpp000066400000000000000000000042461300002025200222100ustar00rootroot00000000000000#include "testutils/FuseReadDirTest.h" #include #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using cpputils::unique_ref; using cpputils::make_unique_ref; using std::vector; using std::string; using namespace fspp::fuse; using fspp::Dir; unique_ref> LARGE_DIR(int num_entries) { auto result = make_unique_ref>(); result->reserve(num_entries); for(int i=0; ipush_back("File "+std::to_string(i)+" file"); } return result; } class FuseReadDirReturnTest: public FuseReadDirTest, public WithParamInterface> { public: void testDirEntriesAreCorrect(const vector &direntries) { ReturnIsDirOnLstat(DIRNAME); EXPECT_CALL(fsimpl, readDir(StrEq(DIRNAME))) .Times(1).WillOnce(ReturnDirEntries(direntries)); auto returned_dir_entries = ReadDir(DIRNAME); EXPECT_EQ(direntries, *returned_dir_entries); } }; INSTANTIATE_TEST_CASE_P(FuseReadDirReturnTest, FuseReadDirReturnTest, Values( vector({}), vector({"oneentry"}), vector({"twoentries_1", "twoentries_2"}), vector({"file1", "file with spaces"}), vector({"file1", ".dotfile"}) )); TEST_P(FuseReadDirReturnTest, ReturnedDirEntriesAreCorrect) { testDirEntriesAreCorrect(GetParam()); } // If using this with GTest Value-Parametrized TEST_P, it breaks some other unrelated tests // (probably because it is doing a lot of construction work on the start of the test program) TEST_F(FuseReadDirReturnTest, ReturnedDirEntriesAreCorrect_LargeDir1000) { auto direntries = LARGE_DIR(1000); testDirEntriesAreCorrect(*direntries); } // If using this with GTest Value-Parametrized TEST_P, it breaks some other unrelated tests // (probably because it is doing a lot of construction work on the start of the test program) // DISABLED, because it uses a lot of memory TEST_F(FuseReadDirReturnTest, DISABLED_ReturnedDirEntriesAreCorrect_LargeDir1000000) { auto direntries = LARGE_DIR(1000000); testDirEntriesAreCorrect(*direntries); } test/fspp/fuse/readDir/testutils/000077500000000000000000000000001300002025200173415ustar00rootroot00000000000000test/fspp/fuse/readDir/testutils/FuseReadDirTest.cpp000066400000000000000000000046431300002025200230510ustar00rootroot00000000000000#include "FuseReadDirTest.h" using cpputils::unique_ref; using cpputils::make_unique_ref; using std::vector; using std::string; using std::initializer_list; using ::testing::Action; using ::testing::Return; unique_ref> FuseReadDirTest::ReadDir(const char *dirname) { auto fs = TestFS(); DIR *dir = openDir(fs.get(), dirname); auto result = make_unique_ref>(); readDirEntries(dir, result.get()); closeDir(dir); return result; } int FuseReadDirTest::ReadDirReturnError(const char *dirname) { auto fs = TestFS(); errno = 0; DIR *dir = openDirAllowError(fs.get(), dirname); EXPECT_EQ(errno!=0, dir==nullptr) << "errno should exactly be != 0 if opendir returned nullptr"; if (errno != 0) { return errno; } auto result = make_unique_ref>(); int error = readDirEntriesAllowError(dir, result.get()); closeDir(dir); return error; } DIR *FuseReadDirTest::openDir(TempTestFS *fs, const char *dirname) { DIR *dir = openDirAllowError(fs, dirname); EXPECT_NE(nullptr, dir) << "Opening directory failed"; return dir; } DIR *FuseReadDirTest::openDirAllowError(TempTestFS *fs, const char *dirname) { auto realpath = fs->mountDir() / dirname; return ::opendir(realpath.c_str()); } void FuseReadDirTest::readDirEntries(DIR *dir, vector *result) { int error = readDirEntriesAllowError(dir, result); EXPECT_EQ(0, error); } int FuseReadDirTest::readDirEntriesAllowError(DIR *dir, vector *result) { struct dirent *entry = nullptr; int error = readNextDirEntryAllowError(dir, &entry); if (error != 0) { return error; } while(entry != nullptr) { result->push_back(entry->d_name); int error = readNextDirEntryAllowError(dir, &entry); if (error != 0) { return error; } } return 0; } int FuseReadDirTest::readNextDirEntryAllowError(DIR *dir, struct dirent **result) { errno = 0; *result = ::readdir(dir); return errno; } void FuseReadDirTest::closeDir(DIR *dir) { int retval = ::closedir(dir); EXPECT_EQ(0, retval) << "Closing dir failed"; } Action*(const char*)> FuseReadDirTest::ReturnDirEntries(vector entries) { vector *direntries = new vector(entries.size(), fspp::Dir::Entry(fspp::Dir::EntryType::FILE, "")); for(unsigned int i = 0; i < entries.size(); ++i) { (*direntries)[i].name = entries[i]; } return Return(direntries); } test/fspp/fuse/readDir/testutils/FuseReadDirTest.h000066400000000000000000000016751300002025200225200ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_READDIR_TESTUTILS_FUSEREADDIRTEST_H_ #define MESSMER_FSPP_TEST_FUSE_READDIR_TESTUTILS_FUSEREADDIRTEST_H_ #include "../../../testutils/FuseTest.h" #include #include "fspp/fs_interface/Dir.h" class FuseReadDirTest: public FuseTest { public: const char *DIRNAME = "/mydir"; cpputils::unique_ref> ReadDir(const char *dirname); int ReadDirReturnError(const char *dirname); static ::testing::Action*(const char*)> ReturnDirEntries(std::vector entries); private: DIR *openDir(TempTestFS *fs, const char *dirname); DIR *openDirAllowError(TempTestFS *fs, const char *dirname); void readDirEntries(DIR *dir, std::vector *result); int readDirEntriesAllowError(DIR *dir, std::vector *result); int readNextDirEntryAllowError(DIR *dir, struct dirent **result); void closeDir(DIR *dir); }; #endif test/fspp/fuse/rename/000077500000000000000000000000001300002025200151765ustar00rootroot00000000000000test/fspp/fuse/rename/FuseRenameErrorTest.cpp000066400000000000000000000016221300002025200216070ustar00rootroot00000000000000#include "testutils/FuseRenameTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using namespace fspp::fuse; class FuseRenameErrorTest: public FuseRenameTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseRenameErrorTest, FuseRenameErrorTest, Values(EACCES, EBUSY, EDQUOT, EFAULT, EINVAL, EISDIR, ELOOP, EMLINK, ENAMETOOLONG, ENOENT, ENOMEM, ENOSPC, ENOTDIR, ENOTEMPTY, EEXIST, EPERM, EROFS, EXDEV, EBADF, ENOTDIR)); TEST_P(FuseRenameErrorTest, ReturnedErrorIsCorrect) { ReturnIsFileOnLstat(FILENAME1); ReturnDoesntExistOnLstat(FILENAME2); EXPECT_CALL(fsimpl, rename(StrEq(FILENAME1), StrEq(FILENAME2))) .Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); int error = RenameReturnError(FILENAME1, FILENAME2); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/rename/FuseRenameFilenameTest.cpp000066400000000000000000000110501300002025200222320ustar00rootroot00000000000000#include "testutils/FuseRenameTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; using ::testing::Invoke; using ::testing::Action; class FuseRenameFilenameTest: public FuseRenameTest { }; TEST_F(FuseRenameFilenameTest, RenameFileRootToRoot) { ReturnIsFileOnLstat("/myfile"); ReturnDoesntExistOnLstat("/myrenamedfile"); EXPECT_CALL(fsimpl, rename(StrEq("/myfile"), StrEq("/myrenamedfile"))) .Times(1).WillOnce(Return()); Rename("/myfile", "/myrenamedfile"); } TEST_F(FuseRenameFilenameTest, RenameFileRootToNested) { ReturnIsFileOnLstat("/myfile"); ReturnIsDirOnLstat("/mydir"); ReturnDoesntExistOnLstat("/mydir/myrenamedfile"); EXPECT_CALL(fsimpl, rename(StrEq("/myfile"), StrEq("/mydir/myrenamedfile"))) .Times(1).WillOnce(Return()); Rename("/myfile", "/mydir/myrenamedfile"); } TEST_F(FuseRenameFilenameTest, RenameFileNestedToRoot) { ReturnDoesntExistOnLstat("/myrenamedfile"); ReturnIsDirOnLstat("/mydir"); ReturnIsFileOnLstat("/mydir/myfile"); EXPECT_CALL(fsimpl, rename(StrEq("/mydir/myfile"), StrEq("/myrenamedfile"))) .Times(1).WillOnce(Return()); Rename("/mydir/myfile", "/myrenamedfile"); } TEST_F(FuseRenameFilenameTest, RenameFileNestedToNested) { ReturnIsDirOnLstat("/mydir"); ReturnIsFileOnLstat("/mydir/myfile"); ReturnDoesntExistOnLstat("/mydir/myrenamedfile"); EXPECT_CALL(fsimpl, rename(StrEq("/mydir/myfile"), StrEq("/mydir/myrenamedfile"))) .Times(1).WillOnce(Return()); Rename("/mydir/myfile", "/mydir/myrenamedfile"); } TEST_F(FuseRenameFilenameTest, RenameFileNestedToNested2) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnIsFileOnLstat("/mydir/mydir2/myfile"); ReturnDoesntExistOnLstat("/mydir/mydir2/myrenamedfile"); EXPECT_CALL(fsimpl, rename(StrEq("/mydir/mydir2/myfile"), StrEq("/mydir/mydir2/myrenamedfile"))) .Times(1).WillOnce(Return()); Rename("/mydir/mydir2/myfile", "/mydir/mydir2/myrenamedfile"); } TEST_F(FuseRenameFilenameTest, RenameFileNestedToNested_DifferentFolder) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir2"); ReturnIsFileOnLstat("/mydir/myfile"); ReturnDoesntExistOnLstat("/mydir2/myrenamedfile"); EXPECT_CALL(fsimpl, rename(StrEq("/mydir/myfile"), StrEq("/mydir2/myrenamedfile"))) .Times(1).WillOnce(Return()); Rename("/mydir/myfile", "/mydir2/myrenamedfile"); } TEST_F(FuseRenameFilenameTest, RenameDirRootToRoot) { ReturnIsDirOnLstat("/mydir"); ReturnDoesntExistOnLstat("/myrenameddir"); EXPECT_CALL(fsimpl, rename(StrEq("/mydir"), StrEq("/myrenameddir"))) .Times(1).WillOnce(Return()); Rename("/mydir", "/myrenameddir"); } TEST_F(FuseRenameFilenameTest, RenameDirRootToNested) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/myrootdir"); ReturnDoesntExistOnLstat("/myrootdir/myrenameddir"); EXPECT_CALL(fsimpl, rename(StrEq("/mydir"), StrEq("/myrootdir/myrenameddir"))) .Times(1).WillOnce(Return()); Rename("/mydir", "/myrootdir/myrenameddir"); } TEST_F(FuseRenameFilenameTest, RenameDirNestedToRoot) { ReturnDoesntExistOnLstat("/myrenameddir"); ReturnIsDirOnLstat("/myrootdir"); ReturnIsDirOnLstat("/myrootdir/mydir"); EXPECT_CALL(fsimpl, rename(StrEq("/myrootdir/mydir"), StrEq("/myrenameddir"))) .Times(1).WillOnce(Return()); Rename("/myrootdir/mydir", "/myrenameddir"); } TEST_F(FuseRenameFilenameTest, RenameDirNestedToNested) { ReturnIsDirOnLstat("/myrootdir"); ReturnIsDirOnLstat("/myrootdir/mydir"); ReturnDoesntExistOnLstat("/myrootdir/myrenameddir"); EXPECT_CALL(fsimpl, rename(StrEq("/myrootdir/mydir"), StrEq("/myrootdir/myrenameddir"))) .Times(1).WillOnce(Return()); Rename("/myrootdir/mydir", "/myrootdir/myrenameddir"); } TEST_F(FuseRenameFilenameTest, RenameDirNestedToNested2) { ReturnIsDirOnLstat("/myrootdir"); ReturnIsDirOnLstat("/myrootdir/myrootdir2"); ReturnIsDirOnLstat("/myrootdir/myrootdir2/mydir"); ReturnDoesntExistOnLstat("/myrootdir/myrootdir2/myrenameddir"); EXPECT_CALL(fsimpl, rename(StrEq("/myrootdir/myrootdir2/mydir"), StrEq("/myrootdir/myrootdir2/myrenameddir"))) .Times(1).WillOnce(Return()); Rename("/myrootdir/myrootdir2/mydir", "/myrootdir/myrootdir2/myrenameddir"); } TEST_F(FuseRenameFilenameTest, RenameDirNestedToNested_DifferentFolder) { ReturnIsDirOnLstat("/myrootdir"); ReturnIsDirOnLstat("/myrootdir2"); ReturnIsDirOnLstat("/myrootdir/mydir"); ReturnDoesntExistOnLstat("/myrootdir2/myrenameddir"); EXPECT_CALL(fsimpl, rename(StrEq("/myrootdir/mydir"), StrEq("/myrootdir2/myrenameddir"))) .Times(1).WillOnce(Return()); Rename("/myrootdir/mydir", "/myrootdir2/myrenameddir"); } test/fspp/fuse/rename/testutils/000077500000000000000000000000001300002025200172365ustar00rootroot00000000000000test/fspp/fuse/rename/testutils/FuseRenameTest.cpp000066400000000000000000000010051300002025200226300ustar00rootroot00000000000000#include "FuseRenameTest.h" using ::testing::Action; using ::testing::Invoke; void FuseRenameTest::Rename(const char *from, const char *to) { int error = RenameReturnError(from, to); EXPECT_EQ(0, error); } int FuseRenameTest::RenameReturnError(const char *from, const char *to) { auto fs = TestFS(); auto realfrom = fs->mountDir() / from; auto realto = fs->mountDir() / to; int retval = ::rename(realfrom.c_str(), realto.c_str()); if (0 == retval) { return 0; } else { return errno; } } test/fspp/fuse/rename/testutils/FuseRenameTest.h000066400000000000000000000006601300002025200223030ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_RENAME_TESTUTILS_FUSERENAMETEST_H_ #define MESSMER_FSPP_TEST_FUSE_RENAME_TESTUTILS_FUSERENAMETEST_H_ #include "../../../testutils/FuseTest.h" class FuseRenameTest: public FuseTest { public: const char *FILENAME1 = "/myfile1"; const char *FILENAME2 = "/myfile2"; void Rename(const char *from, const char *to); int RenameReturnError(const char *from, const char *to); }; #endif test/fspp/fuse/rmdir/000077500000000000000000000000001300002025200150445ustar00rootroot00000000000000test/fspp/fuse/rmdir/FuseRmdirDirnameTest.cpp000066400000000000000000000026061300002025200216140ustar00rootroot00000000000000#include "testutils/FuseRmdirTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; using ::testing::Invoke; using ::testing::Action; class FuseRmdirDirnameTest: public FuseRmdirTest { }; TEST_F(FuseRmdirDirnameTest, Rmdir) { ReturnIsDirOnLstat("/mydir"); EXPECT_CALL(fsimpl, rmdir(StrEq("/mydir"))) // After rmdir was called, lstat should return that it doesn't exist anymore // This is needed to make the ::rmdir() syscall pass. .Times(1).WillOnce(FromNowOnReturnDoesntExistOnLstat()); Rmdir("/mydir"); } TEST_F(FuseRmdirDirnameTest, RmdirNested) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mysubdir"); EXPECT_CALL(fsimpl, rmdir(StrEq("/mydir/mysubdir"))) // After rmdir was called, lstat should return that it doesn't exist anymore // This is needed to make the ::rmdir() syscall pass. .Times(1).WillOnce(FromNowOnReturnDoesntExistOnLstat()); Rmdir("/mydir/mysubdir"); } TEST_F(FuseRmdirDirnameTest, RmdirNested2) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnIsDirOnLstat("/mydir/mydir2/mydir3"); EXPECT_CALL(fsimpl, rmdir(StrEq("/mydir/mydir2/mydir3"))) // After rmdir was called, lstat should return that it doesn't exist anymore // This is needed to make the ::rmdir() syscall pass. .Times(1).WillOnce(FromNowOnReturnDoesntExistOnLstat()); Rmdir("/mydir/mydir2/mydir3"); } test/fspp/fuse/rmdir/FuseRmdirErrorTest.cpp000066400000000000000000000014001300002025200213150ustar00rootroot00000000000000#include "testutils/FuseRmdirTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using namespace fspp::fuse; class FuseRmdirErrorTest: public FuseRmdirTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseRmdirErrorTest, FuseRmdirErrorTest, Values(EACCES, EBUSY, EFAULT, EINVAL, ELOOP, ENAMETOOLONG, ENOENT, ENOMEM, ENOTDIR, ENOTEMPTY, EPERM, EROFS)); TEST_P(FuseRmdirErrorTest, ReturnedErrorIsCorrect) { ReturnIsDirOnLstat(DIRNAME); EXPECT_CALL(fsimpl, rmdir(StrEq(DIRNAME))) .Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); int error = RmdirReturnError(DIRNAME); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/rmdir/testutils/000077500000000000000000000000001300002025200171045ustar00rootroot00000000000000test/fspp/fuse/rmdir/testutils/FuseRmdirTest.cpp000066400000000000000000000011361300002025200223510ustar00rootroot00000000000000#include "FuseRmdirTest.h" using ::testing::Action; using ::testing::Invoke; void FuseRmdirTest::Rmdir(const char *dirname) { int error = RmdirReturnError(dirname); EXPECT_EQ(0, error); } int FuseRmdirTest::RmdirReturnError(const char *dirname) { auto fs = TestFS(); auto realpath = fs->mountDir() / dirname; int retval = ::rmdir(realpath.c_str()); if (retval == 0) { return 0; } else { return errno; } } Action FuseRmdirTest::FromNowOnReturnDoesntExistOnLstat() { return Invoke([this](const char *dirname) { ReturnDoesntExistOnLstat(dirname); }); } test/fspp/fuse/rmdir/testutils/FuseRmdirTest.h000066400000000000000000000006621300002025200220210ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_RMDIR_TESTUTILS_FUSERMDIRTEST_H_ #define MESSMER_FSPP_TEST_FUSE_RMDIR_TESTUTILS_FUSERMDIRTEST_H_ #include "../../../testutils/FuseTest.h" class FuseRmdirTest: public FuseTest { public: const char *DIRNAME = "/mydir"; void Rmdir(const char *dirname); int RmdirReturnError(const char *dirname); ::testing::Action FromNowOnReturnDoesntExistOnLstat(); }; #endif test/fspp/fuse/statfs/000077500000000000000000000000001300002025200152335ustar00rootroot00000000000000test/fspp/fuse/statfs/FuseStatfsErrorTest.cpp000066400000000000000000000020121300002025200216730ustar00rootroot00000000000000#include "testutils/FuseStatfsTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::StrEq; using ::testing::_; using ::testing::Throw; using ::testing::Return; using ::testing::WithParamInterface; using ::testing::Values; using fspp::fuse::FuseErrnoException; class FuseStatfsErrorTest: public FuseStatfsTest, public WithParamInterface { public: }; INSTANTIATE_TEST_CASE_P(FuseStatfsErrorTest, FuseStatfsErrorTest, Values(EACCES, EBADF, EFAULT, EINTR, EIO, ELOOP, ENAMETOOLONG, ENOENT, ENOMEM, ENOSYS, ENOTDIR, EOVERFLOW)); TEST_F(FuseStatfsErrorTest, ReturnNoError) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, statfs(StrEq(FILENAME), _)).Times(1).WillOnce(Return()); int error = StatfsReturnError(FILENAME); EXPECT_EQ(0, error); } TEST_P(FuseStatfsErrorTest, ReturnError) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, statfs(StrEq(FILENAME), _)).Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); int error = StatfsReturnError(FILENAME); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/statfs/FuseStatfsPathParameterTest.cpp000066400000000000000000000025461300002025200233530ustar00rootroot00000000000000#include "testutils/FuseStatfsTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; class FuseStatfsPathParameterTest: public FuseStatfsTest { }; TEST_F(FuseStatfsPathParameterTest, PathParameterIsCorrectRoot) { EXPECT_CALL(fsimpl, statfs(StrEq("/"), _)).Times(1).WillOnce(Return()); Statfs("/"); } TEST_F(FuseStatfsPathParameterTest, PathParameterIsCorrectSimpleFile) { ReturnIsFileOnLstat("/myfile"); EXPECT_CALL(fsimpl, statfs(StrEq("/myfile"), _)).Times(1).WillOnce(Return()); Statfs("/myfile"); } TEST_F(FuseStatfsPathParameterTest, PathParameterIsCorrectSimpleDir) { ReturnIsDirOnLstat("/mydir"); EXPECT_CALL(fsimpl, statfs(StrEq("/mydir"), _)).Times(1).WillOnce(Return()); Statfs("/mydir"); } TEST_F(FuseStatfsPathParameterTest, PathParameterIsCorrectNestedFile) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnIsFileOnLstat("/mydir/mydir2/myfile"); EXPECT_CALL(fsimpl, statfs(StrEq("/mydir/mydir2/myfile"), _)).Times(1).WillOnce(Return()); Statfs("/mydir/mydir2/myfile"); } TEST_F(FuseStatfsPathParameterTest, PathParameterIsCorrectNestedDir) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnIsDirOnLstat("/mydir/mydir2/mydir3"); EXPECT_CALL(fsimpl, statfs(StrEq("/mydir/mydir2/mydir3"), _)).Times(1).WillOnce(Return()); Statfs("/mydir/mydir2/mydir3"); } test/fspp/fuse/statfs/FuseStatfsReturnBavailTest.cpp000066400000000000000000000011721300002025200232060ustar00rootroot00000000000000#include "testutils/FuseStatfsReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseStatfsReturnBavailTest: public FuseStatfsReturnTest, public WithParamInterface { private: void set(struct ::statvfs *stat, fsblkcnt_t value) override { stat->f_bavail = value; } }; INSTANTIATE_TEST_CASE_P(FuseStatfsReturnBavailTest, FuseStatfsReturnBavailTest, Values( 0, 10, 256, 1024, 4096 )); TEST_P(FuseStatfsReturnBavailTest, ReturnedBavailIsCorrect) { struct ::statvfs result = CallStatfsWithValue(GetParam()); EXPECT_EQ(GetParam(), result.f_bavail); } test/fspp/fuse/statfs/FuseStatfsReturnBfreeTest.cpp000066400000000000000000000011631300002025200230330ustar00rootroot00000000000000#include "testutils/FuseStatfsReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseStatfsReturnBfreeTest: public FuseStatfsReturnTest, public WithParamInterface { private: void set(struct ::statvfs *stat, fsblkcnt_t value) override { stat->f_bfree = value; } }; INSTANTIATE_TEST_CASE_P(FuseStatfsReturnBfreeTest, FuseStatfsReturnBfreeTest, Values( 0, 10, 256, 1024, 4096 )); TEST_P(FuseStatfsReturnBfreeTest, ReturnedBfreeIsCorrect) { struct ::statvfs result = CallStatfsWithValue(GetParam()); EXPECT_EQ(GetParam(), result.f_bfree); } test/fspp/fuse/statfs/FuseStatfsReturnBlocksTest.cpp000066400000000000000000000011721300002025200232250ustar00rootroot00000000000000#include "testutils/FuseStatfsReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseStatfsReturnBlocksTest: public FuseStatfsReturnTest, public WithParamInterface { private: void set(struct ::statvfs *stat, fsblkcnt_t value) override { stat->f_blocks = value; } }; INSTANTIATE_TEST_CASE_P(FuseStatfsReturnBlocksTest, FuseStatfsReturnBlocksTest, Values( 0, 10, 256, 1024, 4096 )); TEST_P(FuseStatfsReturnBlocksTest, ReturnedBlocksIsCorrect) { struct ::statvfs result = CallStatfsWithValue(GetParam()); EXPECT_EQ(GetParam(), result.f_blocks); } test/fspp/fuse/statfs/FuseStatfsReturnBsizeTest.cpp000066400000000000000000000011741300002025200230660ustar00rootroot00000000000000#include "testutils/FuseStatfsReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseStatfsReturnBsizeTest: public FuseStatfsReturnTest, public WithParamInterface { private: void set(struct ::statvfs *stat, unsigned long value) override { stat->f_bsize = value; } }; INSTANTIATE_TEST_CASE_P(FuseStatfsReturnBsizeTest, FuseStatfsReturnBsizeTest, Values( 0, 10, 256, 1024, 4096 )); TEST_P(FuseStatfsReturnBsizeTest, ReturnedBsizeIsCorrect) { struct ::statvfs result = CallStatfsWithValue(GetParam()); EXPECT_EQ(GetParam(), result.f_bsize); } test/fspp/fuse/statfs/FuseStatfsReturnFfreeTest.cpp000066400000000000000000000011631300002025200230370ustar00rootroot00000000000000#include "testutils/FuseStatfsReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseStatfsReturnFfreeTest: public FuseStatfsReturnTest, public WithParamInterface { private: void set(struct ::statvfs *stat, fsfilcnt_t value) override { stat->f_ffree = value; } }; INSTANTIATE_TEST_CASE_P(FuseStatfsReturnFfreeTest, FuseStatfsReturnFfreeTest, Values( 0, 10, 256, 1024, 4096 )); TEST_P(FuseStatfsReturnFfreeTest, ReturnedFfreeIsCorrect) { struct ::statvfs result = CallStatfsWithValue(GetParam()); EXPECT_EQ(GetParam(), result.f_ffree); } test/fspp/fuse/statfs/FuseStatfsReturnFilesTest.cpp000066400000000000000000000011631300002025200230520ustar00rootroot00000000000000#include "testutils/FuseStatfsReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseStatfsReturnFilesTest: public FuseStatfsReturnTest, public WithParamInterface { private: void set(struct ::statvfs *stat, fsfilcnt_t value) override { stat->f_files = value; } }; INSTANTIATE_TEST_CASE_P(FuseStatfsReturnFilesTest, FuseStatfsReturnFilesTest, Values( 0, 10, 256, 1024, 4096 )); TEST_P(FuseStatfsReturnFilesTest, ReturnedFilesIsCorrect) { struct ::statvfs result = CallStatfsWithValue(GetParam()); EXPECT_EQ(GetParam(), result.f_files); } test/fspp/fuse/statfs/FuseStatfsReturnNamemaxTest.cpp000066400000000000000000000012121300002025200233710ustar00rootroot00000000000000#include "testutils/FuseStatfsReturnTest.h" using ::testing::WithParamInterface; using ::testing::Values; class FuseStatfsReturnNamemaxTest: public FuseStatfsReturnTest, public WithParamInterface { private: void set(struct ::statvfs *stat, unsigned long value) override { stat->f_namemax = value; } }; INSTANTIATE_TEST_CASE_P(FuseStatfsReturnNamemaxTest, FuseStatfsReturnNamemaxTest, Values( 0, 10, 256, 1024, 4096 )); TEST_P(FuseStatfsReturnNamemaxTest, ReturnedNamemaxIsCorrect) { struct ::statvfs result = CallStatfsWithValue(GetParam()); EXPECT_EQ(GetParam(), result.f_namemax); } test/fspp/fuse/statfs/testutils/000077500000000000000000000000001300002025200172735ustar00rootroot00000000000000test/fspp/fuse/statfs/testutils/FuseStatfsReturnTest.h000066400000000000000000000024731300002025200236010ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_STATFS_TESTUTILS_FUSESTATFSRETURNTEST_H_ #define MESSMER_FSPP_TEST_FUSE_STATFS_TESTUTILS_FUSESTATFSRETURNTEST_H_ #include "FuseStatfsTest.h" // This class offers test helpers for testing (struct statfs) entries. We return them from // our mock filesystem, set up a temporary filesystem, call statfs syscall on it, and // then check the return value. template class FuseStatfsReturnTest: public FuseStatfsTest { public: // Set the specified (struct statfs) entry to the given value, and test whether it is correctly returned from the syscall. struct ::statvfs CallStatfsWithValue(Property value); private: std::function SetPropertyImpl(Property value); // Override this function to specify, how to set the specified (struct statfs) entry on the passed (struct statfs *) object. virtual void set(struct ::statvfs *statfs, Property value) = 0; }; template struct ::statvfs FuseStatfsReturnTest::CallStatfsWithValue(Property value) { return CallStatfsWithImpl(SetPropertyImpl(value)); } template std::function FuseStatfsReturnTest::SetPropertyImpl(Property value) { return [this, value] (struct ::statvfs *stat) { set(stat, value); }; } #endif test/fspp/fuse/statfs/testutils/FuseStatfsTest.cpp000066400000000000000000000023001300002025200227210ustar00rootroot00000000000000#include "FuseStatfsTest.h" using std::function; using ::testing::StrEq; using ::testing::_; using ::testing::Invoke; void FuseStatfsTest::Statfs(const std::string &path) { struct ::statvfs dummy; Statfs(path, &dummy); } int FuseStatfsTest::StatfsReturnError(const std::string &path) { struct ::statvfs dummy; return StatfsReturnError(path, &dummy); } void FuseStatfsTest::Statfs(const std::string &path, struct ::statvfs *result) { int error = StatfsReturnError(path, result); EXPECT_EQ(0, error) << "lstat syscall failed. errno: " << errno; } int FuseStatfsTest::StatfsReturnError(const std::string &path, struct ::statvfs *result) { auto fs = TestFS(); auto realpath = fs->mountDir() / path; int retval = ::statvfs(realpath.c_str(), result); if (retval == 0) { return 0; } else { return errno; } } struct ::statvfs FuseStatfsTest::CallStatfsWithImpl(function implementation) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, statfs(StrEq(FILENAME), _)).WillRepeatedly(Invoke([implementation](const char*, struct ::statvfs *stat) { implementation(stat); })); struct ::statvfs result; Statfs(FILENAME, &result); return result; } test/fspp/fuse/statfs/testutils/FuseStatfsTest.h000066400000000000000000000030241300002025200223720ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_STATFS_TESTUTILS_FUSESTATFSTEST_H_ #define MESSMER_FSPP_TEST_FUSE_STATFS_TESTUTILS_FUSESTATFSTEST_H_ #include #include #include #include "../../../testutils/FuseTest.h" // This class offers some utility functions for testing statfs(). class FuseStatfsTest: public FuseTest { protected: const char *FILENAME = "/myfile"; // Set up a temporary filesystem (using the fsimpl mock in FuseTest as filesystem implementation) // and call the statfs syscall on the given (filesystem-relative) path. void Statfs(const std::string &path); // Same as Statfs above, but also return the result of the statfs syscall. void Statfs(const std::string &path, struct ::statvfs *result); // These two functions are the same as Statfs above, but they don't fail the test when the statfs syscall // crashes. Instead, they return the result value of the statfs syscall. int StatfsReturnError(const std::string &path); int StatfsReturnError(const std::string &path, struct ::statvfs *result); // You can specify an implementation, which can modify the (struct statfs *) result, // our fuse mock filesystem implementation will then return this to fuse on an statfs call. // This functions then set up a temporary filesystem with this mock, calls statfs on a filesystem node // and returns the (struct statfs) returned from an statfs syscall to this filesystem. struct ::statvfs CallStatfsWithImpl(std::function implementation); }; #endif test/fspp/fuse/truncate/000077500000000000000000000000001300002025200155545ustar00rootroot00000000000000test/fspp/fuse/truncate/FuseTruncateErrorTest.cpp000066400000000000000000000014601300002025200225430ustar00rootroot00000000000000#include "testutils/FuseTruncateTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using namespace fspp::fuse; class FuseTruncateErrorTest: public FuseTruncateTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseTruncateErrorTest, FuseTruncateErrorTest, Values(EACCES, EFAULT, EFBIG, EINTR, EINVAL, EIO, EISDIR, ELOOP, ENAMETOOLONG, ENOENT, ENOTDIR, EPERM, EROFS, ETXTBSY)); TEST_P(FuseTruncateErrorTest, ReturnedErrorIsCorrect) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, truncate(StrEq(FILENAME), _)) .Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); int error = TruncateFileReturnError(FILENAME, 0); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/truncate/FuseTruncateFilenameTest.cpp000066400000000000000000000016751300002025200232020ustar00rootroot00000000000000#include "testutils/FuseTruncateTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; class FuseTruncateFilenameTest: public FuseTruncateTest { }; TEST_F(FuseTruncateFilenameTest, TruncateFile) { ReturnIsFileOnLstat("/myfile"); EXPECT_CALL(fsimpl, truncate(StrEq("/myfile"), _)) .Times(1).WillOnce(Return()); TruncateFile("/myfile", 0); } TEST_F(FuseTruncateFilenameTest, TruncateFileNested) { ReturnIsDirOnLstat("/mydir"); ReturnIsFileOnLstat("/mydir/myfile"); EXPECT_CALL(fsimpl, truncate(StrEq("/mydir/myfile"), _)) .Times(1).WillOnce(Return()); TruncateFile("/mydir/myfile", 0); } TEST_F(FuseTruncateFilenameTest, TruncateFileNested2) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnIsFileOnLstat("/mydir/mydir2/myfile"); EXPECT_CALL(fsimpl, truncate(StrEq("/mydir/mydir2/myfile"), _)) .Times(1).WillOnce(Return()); TruncateFile("/mydir/mydir2/myfile", 0); } test/fspp/fuse/truncate/FuseTruncateSizeTest.cpp000066400000000000000000000011151300002025200223610ustar00rootroot00000000000000#include "testutils/FuseTruncateTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; using ::testing::WithParamInterface; using ::testing::Values; class FuseTruncateSizeTest: public FuseTruncateTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseTruncateSizeTest, FuseTruncateSizeTest, Values(0, 1, 10, 1024, 1024*1024*1024)); TEST_P(FuseTruncateSizeTest, TruncateFile) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, truncate(StrEq(FILENAME), GetParam())) .Times(1).WillOnce(Return()); TruncateFile(FILENAME, GetParam()); } test/fspp/fuse/truncate/testutils/000077500000000000000000000000001300002025200176145ustar00rootroot00000000000000test/fspp/fuse/truncate/testutils/FuseTruncateTest.cpp000066400000000000000000000007071300002025200235740ustar00rootroot00000000000000#include "FuseTruncateTest.h" void FuseTruncateTest::TruncateFile(const char *filename, off_t size) { int error = TruncateFileReturnError(filename, size); EXPECT_EQ(0, error); } int FuseTruncateTest::TruncateFileReturnError(const char *filename, off_t size) { auto fs = TestFS(); auto realpath = fs->mountDir() / filename; int retval = ::truncate(realpath.c_str(), size); if (retval == 0) { return 0; } else { return errno; } } test/fspp/fuse/truncate/testutils/FuseTruncateTest.h000066400000000000000000000006361300002025200232420ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_TRUNCATE_TESTUTILS_FUSETRUNCATETEST_H_ #define MESSMER_FSPP_TEST_FUSE_TRUNCATE_TESTUTILS_FUSETRUNCATETEST_H_ #include "../../../testutils/FuseTest.h" class FuseTruncateTest: public FuseTest { public: const char *FILENAME = "/myfile"; void TruncateFile(const char *filename, off_t size); int TruncateFileReturnError(const char *filename, off_t size); }; #endif test/fspp/fuse/unlink/000077500000000000000000000000001300002025200152275ustar00rootroot00000000000000test/fspp/fuse/unlink/FuseUnlinkErrorTest.cpp000066400000000000000000000014161300002025200216720ustar00rootroot00000000000000#include "testutils/FuseUnlinkTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using namespace fspp::fuse; class FuseUnlinkErrorTest: public FuseUnlinkTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseUnlinkErrorTest, FuseUnlinkErrorTest, Values(EACCES, EBUSY, EFAULT, EIO, EISDIR, ELOOP, ENAMETOOLONG, ENOENT, ENOMEM, ENOTDIR, EPERM, EROFS, EINVAL)); TEST_P(FuseUnlinkErrorTest, ReturnedErrorIsCorrect) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, unlink(StrEq(FILENAME))) .Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); int error = UnlinkReturnError(FILENAME); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/unlink/FuseUnlinkFilenameTest.cpp000066400000000000000000000026341300002025200223240ustar00rootroot00000000000000#include "testutils/FuseUnlinkTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; using ::testing::Invoke; using ::testing::Action; class FuseUnlinkFilenameTest: public FuseUnlinkTest { }; TEST_F(FuseUnlinkFilenameTest, Unlink) { ReturnIsFileOnLstat("/mydir"); EXPECT_CALL(fsimpl, unlink(StrEq("/mydir"))) // After rmdir was called, lstat should return that it doesn't exist anymore // This is needed to make the ::rmdir() syscall pass. .Times(1).WillOnce(FromNowOnReturnDoesntExistOnLstat()); Unlink("/mydir"); } TEST_F(FuseUnlinkFilenameTest, UnlinkNested) { ReturnIsDirOnLstat("/mydir"); ReturnIsFileOnLstat("/mydir/mysubdir"); EXPECT_CALL(fsimpl, unlink(StrEq("/mydir/mysubdir"))) // After rmdir was called, lstat should return that it doesn't exist anymore // This is needed to make the ::rmdir() syscall pass. .Times(1).WillOnce(FromNowOnReturnDoesntExistOnLstat()); Unlink("/mydir/mysubdir"); } TEST_F(FuseUnlinkFilenameTest, UnlinkNested2) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnIsFileOnLstat("/mydir/mydir2/mydir3"); EXPECT_CALL(fsimpl, unlink(StrEq("/mydir/mydir2/mydir3"))) // After rmdir was called, lstat should return that it doesn't exist anymore // This is needed to make the ::rmdir() syscall pass. .Times(1).WillOnce(FromNowOnReturnDoesntExistOnLstat()); Unlink("/mydir/mydir2/mydir3"); } test/fspp/fuse/unlink/testutils/000077500000000000000000000000001300002025200172675ustar00rootroot00000000000000test/fspp/fuse/unlink/testutils/FuseUnlinkTest.cpp000066400000000000000000000011541300002025200227170ustar00rootroot00000000000000#include "FuseUnlinkTest.h" using ::testing::Action; using ::testing::Invoke; void FuseUnlinkTest::Unlink(const char *filename) { int error = UnlinkReturnError(filename); EXPECT_EQ(0, error); } int FuseUnlinkTest::UnlinkReturnError(const char *filename) { auto fs = TestFS(); auto realpath = fs->mountDir() / filename; int retval = ::unlink(realpath.c_str()); if (0 == retval) { return 0; } else { return errno; } } Action FuseUnlinkTest::FromNowOnReturnDoesntExistOnLstat() { return Invoke([this](const char *filename) { ReturnDoesntExistOnLstat(filename); }); } test/fspp/fuse/unlink/testutils/FuseUnlinkTest.h000066400000000000000000000006751300002025200223730ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_UNLINK_TESTUTILS_FUSEUNLINKTEST_H_ #define MESSMER_FSPP_TEST_FUSE_UNLINK_TESTUTILS_FUSEUNLINKTEST_H_ #include "../../../testutils/FuseTest.h" class FuseUnlinkTest: public FuseTest { public: const char *FILENAME = "/myfile"; void Unlink(const char *filename); int UnlinkReturnError(const char *filename); ::testing::Action FromNowOnReturnDoesntExistOnLstat(); }; #endif test/fspp/fuse/utimens/000077500000000000000000000000001300002025200154135ustar00rootroot00000000000000test/fspp/fuse/utimens/FuseUtimensErrorTest.cpp000066400000000000000000000013501300002025200222370ustar00rootroot00000000000000#include "testutils/FuseUtimensTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Throw; using ::testing::WithParamInterface; using ::testing::Values; using namespace fspp::fuse; class FuseUtimensErrorTest: public FuseUtimensTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseUtimensErrorTest, FuseUtimensErrorTest, Values(EACCES, ENOENT, EPERM, EROFS)); TEST_P(FuseUtimensErrorTest, ReturnedErrorIsCorrect) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, utimens(StrEq(FILENAME), _, _)) .Times(1).WillOnce(Throw(FuseErrnoException(GetParam()))); int error = UtimensReturnError(FILENAME, TIMEVALUE, TIMEVALUE); EXPECT_EQ(GetParam(), error); } test/fspp/fuse/utimens/FuseUtimensFilenameTest.cpp000066400000000000000000000034261300002025200226740ustar00rootroot00000000000000#include "testutils/FuseUtimensTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; class FuseUtimensFilenameTest: public FuseUtimensTest { }; TEST_F(FuseUtimensFilenameTest, UtimensFile) { ReturnIsFileOnLstat("/myfile"); EXPECT_CALL(fsimpl, utimens(StrEq("/myfile"), _, _)) .Times(1).WillOnce(Return()); Utimens("/myfile", TIMEVALUE, TIMEVALUE); } TEST_F(FuseUtimensFilenameTest, UtimensFileNested) { ReturnIsDirOnLstat("/mydir"); ReturnIsFileOnLstat("/mydir/myfile"); EXPECT_CALL(fsimpl, utimens(StrEq("/mydir/myfile"), _, _)) .Times(1).WillOnce(Return()); Utimens("/mydir/myfile", TIMEVALUE, TIMEVALUE); } TEST_F(FuseUtimensFilenameTest, UtimensFileNested2) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnIsFileOnLstat("/mydir/mydir2/myfile"); EXPECT_CALL(fsimpl, utimens(StrEq("/mydir/mydir2/myfile"), _, _)) .Times(1).WillOnce(Return()); Utimens("/mydir/mydir2/myfile", TIMEVALUE, TIMEVALUE); } TEST_F(FuseUtimensFilenameTest, UtimensDir) { ReturnIsDirOnLstat("/mydir"); EXPECT_CALL(fsimpl, utimens(StrEq("/mydir"), _, _)) .Times(1).WillOnce(Return()); Utimens("/mydir", TIMEVALUE, TIMEVALUE); } TEST_F(FuseUtimensFilenameTest, UtimensDirNested) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); EXPECT_CALL(fsimpl, utimens(StrEq("/mydir/mydir2"), _, _)) .Times(1).WillOnce(Return()); Utimens("/mydir/mydir2", TIMEVALUE, TIMEVALUE); } TEST_F(FuseUtimensFilenameTest, UtimensDirNested2) { ReturnIsDirOnLstat("/mydir"); ReturnIsDirOnLstat("/mydir/mydir2"); ReturnIsDirOnLstat("/mydir/mydir2/mydir3"); EXPECT_CALL(fsimpl, utimens(StrEq("/mydir/mydir2/mydir3"), _, _)) .Times(1).WillOnce(Return()); Utimens("/mydir/mydir2/mydir3", TIMEVALUE, TIMEVALUE); } test/fspp/fuse/utimens/FuseUtimensTimeParameterTest.cpp000066400000000000000000000037371300002025200237200ustar00rootroot00000000000000#include "testutils/FuseUtimensTest.h" using ::testing::_; using ::testing::StrEq; using ::testing::Return; using ::testing::WithParamInterface; using ::testing::Values; class FuseUtimensTimeParameterTest: public FuseUtimensTest, public WithParamInterface { }; const timespec TIMEVAL1[2] = {FuseUtimensTest::makeTimespec(0,0), FuseUtimensTest::makeTimespec(0,0)}; const timespec TIMEVAL2[2] = {FuseUtimensTest::makeTimespec(1000,0), FuseUtimensTest::makeTimespec(0,0)}; const timespec TIMEVAL3[2] = {FuseUtimensTest::makeTimespec(0,1000), FuseUtimensTest::makeTimespec(0,0)}; const timespec TIMEVAL4[2] = {FuseUtimensTest::makeTimespec(1000,1000), FuseUtimensTest::makeTimespec(0,0)}; const timespec TIMEVAL5[2] = {FuseUtimensTest::makeTimespec(0,0), FuseUtimensTest::makeTimespec(0,0)}; const timespec TIMEVAL6[2] = {FuseUtimensTest::makeTimespec(0,0), FuseUtimensTest::makeTimespec(1000,0)}; const timespec TIMEVAL7[2] = {FuseUtimensTest::makeTimespec(0,0), FuseUtimensTest::makeTimespec(0,1000)}; const timespec TIMEVAL8[2] = {FuseUtimensTest::makeTimespec(0,0), FuseUtimensTest::makeTimespec(1000,1000)}; const timespec TIMEVAL9[2] = {FuseUtimensTest::makeTimespec(1417196126,123000), FuseUtimensTest::makeTimespec(1417109713,321000)}; // current timestamp and the day before as of writing this test case const timespec TIMEVAL10[2] = {FuseUtimensTest::makeTimespec(UINT64_C(1024)*1024*1024*1024,999000), FuseUtimensTest::makeTimespec(UINT64_C(2*1024)*1024*1024*1024,321000)}; // needs 64bit for timestamp representation INSTANTIATE_TEST_CASE_P(FuseUtimensTimeParameterTest, FuseUtimensTimeParameterTest, Values(TIMEVAL1, TIMEVAL2, TIMEVAL3, TIMEVAL4, TIMEVAL5, TIMEVAL6, TIMEVAL7, TIMEVAL8, TIMEVAL9, TIMEVAL10)); TEST_P(FuseUtimensTimeParameterTest, Utimens) { ReturnIsFileOnLstat(FILENAME); EXPECT_CALL(fsimpl, utimens(StrEq(FILENAME), TimeSpecEq(GetParam()[0]), TimeSpecEq(GetParam()[1]))) .Times(1).WillOnce(Return()); Utimens(FILENAME, GetParam()[0], GetParam()[1]); } test/fspp/fuse/utimens/testutils/000077500000000000000000000000001300002025200174535ustar00rootroot00000000000000test/fspp/fuse/utimens/testutils/FuseUtimensTest.cpp000066400000000000000000000016531300002025200232730ustar00rootroot00000000000000#include "FuseUtimensTest.h" #include #include void FuseUtimensTest::Utimens(const char *filename, timespec lastAccessTime, timespec lastModificationTime) { int error = UtimensReturnError(filename, lastAccessTime, lastModificationTime); EXPECT_EQ(0, error); } int FuseUtimensTest::UtimensReturnError(const char *filename, timespec lastAccessTime, timespec lastModificationTime) { auto fs = TestFS(); auto realpath = fs->mountDir() / filename; struct timeval casted_times[2]; TIMESPEC_TO_TIMEVAL(&casted_times[0], &lastAccessTime); TIMESPEC_TO_TIMEVAL(&casted_times[1], &lastModificationTime); int retval = ::utimes(realpath.c_str(), casted_times); if (0 == retval) { return 0; } else { return errno; } } struct timespec FuseUtimensTest::makeTimespec(time_t tv_sec, long tv_nsec) { struct timespec result; result.tv_sec = tv_sec; result.tv_nsec = tv_nsec; return result; } test/fspp/fuse/utimens/testutils/FuseUtimensTest.h000066400000000000000000000013121300002025200227300ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_UTIMENS_TESTUTILS_FUSEUTIMENSTEST_H_ #define MESSMER_FSPP_TEST_FUSE_UTIMENS_TESTUTILS_FUSEUTIMENSTEST_H_ #include "../../../testutils/FuseTest.h" class FuseUtimensTest: public FuseTest { public: const char *FILENAME = "/myfile"; timespec TIMEVALUE = makeTimespec(0,0); void Utimens(const char *filename, timespec lastAccessTime, timespec lastModificationTime); int UtimensReturnError(const char *filename, timespec lastAccessTime, timespec lastModificationTime); static struct timespec makeTimespec(time_t tv_sec, long tv_nsec); }; MATCHER_P(TimeSpecEq, expected, "") { return expected.tv_sec == arg.tv_sec && expected.tv_nsec == arg.tv_nsec; } #endif test/fspp/fuse/write/000077500000000000000000000000001300002025200150615ustar00rootroot00000000000000test/fspp/fuse/write/FuseWriteDataTest.cpp000066400000000000000000000060301300002025200211330ustar00rootroot00000000000000#include #include "testutils/FuseWriteTest.h" #include "../../testutils/InMemoryFile.h" #include "fspp/fuse/FuseErrnoException.h" #include #include using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Combine; using ::testing::Eq; using ::testing::Return; using ::testing::Invoke; using ::testing::Action; using std::tuple; using std::get; using std::min; using cpputils::Data; using cpputils::DataFixture; using namespace fspp::fuse; // We can't test the count or size parameter directly, because fuse doesn't pass them 1:1. // But we can test that the data passed to the ::write syscall is correctly written. struct TestData { TestData(): count(0), offset(0), additional_bytes_at_end_of_file(0) {} TestData(const tuple &data): count(get<0>(data)), offset(get<1>(data)), additional_bytes_at_end_of_file(get<2>(data)) {} size_t count; off_t offset; //How many more bytes does the file have after the read block? size_t additional_bytes_at_end_of_file; size_t fileSize() { return count + offset + additional_bytes_at_end_of_file; } }; // The testcase creates random data in memory, offers a mock write() implementation to write to this // memory region and check methods to check for data equality of a region. class FuseWriteDataTest: public FuseWriteTest, public WithParamInterface> { public: std::unique_ptr testFile; TestData testData; FuseWriteDataTest() : testFile(nullptr), testData(GetParam()) { testFile = std::make_unique(DataFixture::generate(testData.fileSize(), 1)); ReturnIsFileOnLstatWithSize(FILENAME, testData.fileSize()); OnOpenReturnFileDescriptor(FILENAME, 0); EXPECT_CALL(fsimpl, write(0, _, _, _)) .WillRepeatedly(WriteToFile); } // This write() mock implementation writes to the stored virtual file. Action WriteToFile = Invoke([this](int, const void *buf, size_t count, off_t offset) { testFile->write(buf, count, offset); }); }; INSTANTIATE_TEST_CASE_P(FuseWriteDataTest, FuseWriteDataTest, Combine(Values(0,1,10,1000,1024, 10*1024*1024), Values(0, 1, 10, 1024, 10*1024*1024), Values(0, 1, 10, 1024, 10*1024*1024))); TEST_P(FuseWriteDataTest, DataWasCorrectlyWritten) { Data randomWriteData = DataFixture::generate(testData.count, 2); WriteFile(FILENAME, randomWriteData.data(), testData.count, testData.offset); EXPECT_TRUE(testFile->fileContentEquals(randomWriteData, testData.offset)); } TEST_P(FuseWriteDataTest, RestOfFileIsUnchanged) { Data randomWriteData = DataFixture::generate(testData.count, 2); WriteFile(FILENAME, randomWriteData.data(), testData.count, testData.offset); EXPECT_TRUE(testFile->sizeUnchanged()); EXPECT_TRUE(testFile->regionUnchanged(0, testData.offset)); EXPECT_TRUE(testFile->regionUnchanged(testData.offset + testData.count, testData.additional_bytes_at_end_of_file)); } test/fspp/fuse/write/FuseWriteErrorTest.cpp000066400000000000000000000043011300002025200213520ustar00rootroot00000000000000#include "testutils/FuseWriteTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Eq; using ::testing::Ne; using ::testing::Return; using ::testing::Invoke; using ::testing::Throw; using namespace fspp::fuse; class FuseWriteErrorTest: public FuseWriteTest, public WithParamInterface { public: size_t FILESIZE = 64*1024*1024; size_t WRITECOUNT = 32*1024*1024; void SetUp() override { //Make the file size big enough that fuse should issue at least two writes ReturnIsFileOnLstatWithSize(FILENAME, FILESIZE); OnOpenReturnFileDescriptor(FILENAME, 0); } }; INSTANTIATE_TEST_CASE_P(FuseWriteErrorTest, FuseWriteErrorTest, Values(EAGAIN, EBADF, EDESTADDRREQ, EDQUOT, EFAULT, EFBIG, EINTR, EINVAL, EIO, ENOSPC, EPIPE, EOVERFLOW, ESPIPE, ENXIO)); TEST_P(FuseWriteErrorTest, ReturnErrorOnFirstWriteCall) { EXPECT_CALL(fsimpl, write(0, _, _, _)) .WillRepeatedly(Throw(FuseErrnoException(GetParam()))); char *buf = new char[WRITECOUNT]; auto retval = WriteFileReturnError(FILENAME, buf, WRITECOUNT, 0); EXPECT_EQ(GetParam(), retval.error); delete[] buf; } TEST_P(FuseWriteErrorTest, ReturnErrorOnSecondWriteCall) { // The first write request is from the beginning of the file and works, but the later ones fail. // We store the number of bytes the first call could successfully write and check later that our // write syscall returns exactly this number of bytes size_t successfullyWrittenBytes = -1; EXPECT_CALL(fsimpl, write(0, _, _, Eq(0))) .Times(1) .WillOnce(Invoke([&successfullyWrittenBytes](int, const void*, size_t count, off_t) { // Store the number of successfully written bytes successfullyWrittenBytes = count; })); EXPECT_CALL(fsimpl, write(0, _, _, Ne(0))) .WillRepeatedly(Throw(FuseErrnoException(GetParam()))); char *buf = new char[WRITECOUNT]; auto retval = WriteFileReturnError(FILENAME, buf, WRITECOUNT, 0); EXPECT_EQ(0, retval.error); EXPECT_EQ(successfullyWrittenBytes, retval.written_bytes); // Check that we're getting the number of successfully written bytes (the first write call) returned delete[] buf; } test/fspp/fuse/write/FuseWriteFileDescriptorTest.cpp000066400000000000000000000014561300002025200232070ustar00rootroot00000000000000#include "testutils/FuseWriteTest.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::WithParamInterface; using ::testing::Values; using ::testing::Eq; using ::testing::Return; using ::testing::Invoke; using ::testing::Throw; using namespace fspp::fuse; class FuseWriteFileDescriptorTest: public FuseWriteTest, public WithParamInterface { }; INSTANTIATE_TEST_CASE_P(FuseWriteFileDescriptorTest, FuseWriteFileDescriptorTest, Values(0,1,10,1000,1024*1024*1024)); TEST_P(FuseWriteFileDescriptorTest, FileDescriptorIsCorrect) { ReturnIsFileOnLstat(FILENAME); OnOpenReturnFileDescriptor(FILENAME, GetParam()); EXPECT_CALL(fsimpl, write(Eq(GetParam()), _, _, _)) .Times(1).WillOnce(Return()); char buf[1]; WriteFile(FILENAME, buf, 1, 0); } test/fspp/fuse/write/FuseWriteOverflowTest.cpp000066400000000000000000000055411300002025200220730ustar00rootroot00000000000000#include #include "testutils/FuseWriteTest.h" #include "../../testutils/InMemoryFile.h" #include "fspp/fuse/FuseErrnoException.h" using ::testing::_; using ::testing::StrEq; using ::testing::Eq; using ::testing::Return; using ::testing::Invoke; using ::testing::Action; using std::min; using cpputils::DataFixture; using cpputils::Data; using namespace fspp::fuse; class FuseWriteOverflowTest: public FuseWriteTest { public: size_t FILESIZE; size_t WRITESIZE; size_t OFFSET; WriteableInMemoryFile testFile; Data writeData; FuseWriteOverflowTest(size_t filesize, size_t writesize, size_t offset) : FILESIZE(filesize), WRITESIZE(writesize), OFFSET(offset), testFile(DataFixture::generate(FILESIZE)), writeData(DataFixture::generate(WRITESIZE)) { ReturnIsFileOnLstatWithSize(FILENAME, FILESIZE); OnOpenReturnFileDescriptor(FILENAME, 0); EXPECT_CALL(fsimpl, write(0, _, _, _)).WillRepeatedly(WriteToFile); } // This write() mock implementation writes to the stored virtual file. Action WriteToFile = Invoke([this](int, const void *buf, size_t count, off_t offset) { testFile.write(buf, count, offset); }); }; class FuseWriteOverflowTestWithNonemptyFile: public FuseWriteOverflowTest { public: FuseWriteOverflowTestWithNonemptyFile(): FuseWriteOverflowTest(1000, 2000, 500) {} }; TEST_F(FuseWriteOverflowTestWithNonemptyFile, WriteMoreThanFileSizeFromBeginning) { WriteFile(FILENAME, writeData.data(), WRITESIZE, 0); EXPECT_EQ(WRITESIZE, testFile.size()); EXPECT_TRUE(testFile.fileContentEquals(writeData, 0)); } TEST_F(FuseWriteOverflowTestWithNonemptyFile, WriteMoreThanFileSizeFromMiddle) { WriteFile(FILENAME, writeData.data(), WRITESIZE, OFFSET); EXPECT_EQ(OFFSET + WRITESIZE, testFile.size()); EXPECT_TRUE(testFile.regionUnchanged(0, OFFSET)); EXPECT_TRUE(testFile.fileContentEquals(writeData, OFFSET)); } TEST_F(FuseWriteOverflowTestWithNonemptyFile, WriteAfterFileEnd) { WriteFile(FILENAME, writeData.data(), WRITESIZE, FILESIZE + OFFSET); EXPECT_EQ(FILESIZE + OFFSET + WRITESIZE, testFile.size()); EXPECT_TRUE(testFile.regionUnchanged(0, FILESIZE)); EXPECT_TRUE(testFile.fileContentEquals(writeData, FILESIZE + OFFSET)); } class FuseWriteOverflowTestWithEmptyFile: public FuseWriteOverflowTest { public: FuseWriteOverflowTestWithEmptyFile(): FuseWriteOverflowTest(0, 2000, 500) {} }; TEST_F(FuseWriteOverflowTestWithEmptyFile, WriteToBeginOfEmptyFile) { WriteFile(FILENAME, writeData.data(), WRITESIZE, 0); EXPECT_EQ(WRITESIZE, testFile.size()); EXPECT_TRUE(testFile.fileContentEquals(writeData, 0)); } TEST_F(FuseWriteOverflowTestWithEmptyFile, WriteAfterFileEnd) { WriteFile(FILENAME, writeData.data(), WRITESIZE, OFFSET); EXPECT_EQ(OFFSET + WRITESIZE, testFile.size()); EXPECT_TRUE(testFile.fileContentEquals(writeData, OFFSET)); } test/fspp/fuse/write/testutils/000077500000000000000000000000001300002025200171215ustar00rootroot00000000000000test/fspp/fuse/write/testutils/FuseWriteTest.cpp000066400000000000000000000014741300002025200224100ustar00rootroot00000000000000#include "FuseWriteTest.h" void FuseWriteTest::WriteFile(const char *filename, const void *buf, size_t count, off_t offset) { auto retval = WriteFileReturnError(filename, buf, count, offset); EXPECT_EQ(0, retval.error); EXPECT_EQ(count, retval.written_bytes); } FuseWriteTest::WriteError FuseWriteTest::WriteFileReturnError(const char *filename, const void *buf, size_t count, off_t offset) { auto fs = TestFS(); int fd = OpenFile(fs.get(), filename); WriteError result; errno = 0; result.written_bytes = ::pwrite(fd, buf, count, offset); result.error = errno; return result; } int FuseWriteTest::OpenFile(const TempTestFS *fs, const char *filename) { auto realpath = fs->mountDir() / filename; int fd = ::open(realpath.c_str(), O_WRONLY); EXPECT_GE(fd, 0) << "Error opening file"; return fd; } test/fspp/fuse/write/testutils/FuseWriteTest.h000066400000000000000000000011351300002025200220470ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_FUSE_WRITE_TESTUTILS_FUSEWRITETEST_H_ #define MESSMER_FSPP_TEST_FUSE_WRITE_TESTUTILS_FUSEWRITETEST_H_ #include "../../../testutils/FuseTest.h" class FuseWriteTest: public FuseTest { public: const char *FILENAME = "/myfile"; struct WriteError { int error; size_t written_bytes; }; void WriteFile(const char *filename, const void *buf, size_t count, off_t offset); WriteError WriteFileReturnError(const char *filename, const void *buf, size_t count, off_t offset); private: int OpenFile(const TempTestFS *fs, const char *filename); }; #endif test/fspp/impl/000077500000000000000000000000001300002025200137265ustar00rootroot00000000000000test/fspp/impl/FuseOpenFileListTest.cpp000066400000000000000000000064121300002025200204550ustar00rootroot00000000000000#include #include #include "fspp/impl/FuseOpenFileList.h" #include using cpputils::make_unique_ref; using namespace fspp; class MockOpenFile: public OpenFile { public: MockOpenFile(int fileid_, int flags_): fileid(fileid_), flags(flags_), destructed(false) {} int fileid, flags; bool destructed; ~MockOpenFile() {destructed = true;} MOCK_CONST_METHOD1(stat, void(struct ::stat*)); MOCK_CONST_METHOD1(truncate, void(off_t)); MOCK_CONST_METHOD3(read, size_t(void*, size_t, off_t)); MOCK_METHOD3(write, void(const void*, size_t, off_t)); MOCK_METHOD0(flush, void()); MOCK_METHOD0(fsync, void()); MOCK_METHOD0(fdatasync, void()); }; struct FuseOpenFileListTest: public ::testing::Test { static constexpr int FILEID1 = 4; static constexpr int FLAGS1 = 5; static constexpr int FILEID2 = 6; static constexpr int FLAGS2 = 7; static constexpr int FILEID3 = 8; static constexpr int FLAGS3 = 9; FuseOpenFileListTest(): list() {} FuseOpenFileList list; int open(int fileid, int flags) { return list.open(make_unique_ref(fileid, flags)); } int open() { return open(FILEID1, FILEID2); } void check(int id, int fileid, int flags) { MockOpenFile *openFile = dynamic_cast(list.get(id)); EXPECT_EQ(fileid, openFile->fileid); EXPECT_EQ(flags, openFile->flags); } }; TEST_F(FuseOpenFileListTest, EmptyList1) { ASSERT_THROW(list.get(0), std::out_of_range); } TEST_F(FuseOpenFileListTest, EmptyList2) { ASSERT_THROW(list.get(3), std::out_of_range); } TEST_F(FuseOpenFileListTest, InvalidId) { int valid_id = open(); int invalid_id = valid_id + 1; ASSERT_THROW(list.get(invalid_id), std::out_of_range); } TEST_F(FuseOpenFileListTest, Open1AndGet) { int id = open(FILEID1, FLAGS1); check(id, FILEID1, FLAGS1); } TEST_F(FuseOpenFileListTest, Open2AndGet) { int id1 = open(FILEID1, FLAGS1); int id2 = open(FILEID2, FLAGS2); check(id1, FILEID1, FLAGS1); check(id2, FILEID2, FLAGS2); } TEST_F(FuseOpenFileListTest, Open3AndGet) { int id1 = open(FILEID1, FLAGS1); int id2 = open(FILEID2, FLAGS2); int id3 = open(FILEID3, FLAGS3); check(id1, FILEID1, FLAGS1); check(id3, FILEID3, FLAGS3); check(id2, FILEID2, FLAGS2); } //TODO Test case fails. Disabled it. Figure out why and reenable. /*TEST_F(FuseOpenFileListTest, DestructOnClose) { int id = open(); MockOpenFile *openFile = dynamic_cast(list.get(id)); EXPECT_FALSE(openFile->destructed); list.close(id); EXPECT_TRUE(openFile->destructed); }*/ TEST_F(FuseOpenFileListTest, GetClosedItemOnEmptyList) { int id = open(); ASSERT_NO_THROW(list.get(id)); list.close(id); ASSERT_THROW(list.get(id), std::out_of_range); } TEST_F(FuseOpenFileListTest, GetClosedItemOnNonEmptyList) { int id = open(); open(); ASSERT_NO_THROW(list.get(id)); list.close(id); ASSERT_THROW(list.get(id), std::out_of_range); } TEST_F(FuseOpenFileListTest, CloseOnEmptyList1) { ASSERT_THROW(list.close(0), std::out_of_range); } TEST_F(FuseOpenFileListTest, CloseOnEmptyList2) { ASSERT_THROW(list.close(4), std::out_of_range); } TEST_F(FuseOpenFileListTest, RemoveInvalidId) { int valid_id = open(); int invalid_id = valid_id + 1; ASSERT_THROW(list.close(invalid_id), std::out_of_range); } test/fspp/impl/IdListTest.cpp000066400000000000000000000042541300002025200164670ustar00rootroot00000000000000#include #include "fspp/impl/IdList.h" #include using cpputils::make_unique_ref; using namespace fspp; class MyObj { public: MyObj(int val_): val(val_) {} int val; }; struct IdListTest: public ::testing::Test { static constexpr int OBJ1 = 3; static constexpr int OBJ2 = 10; static constexpr int OBJ3 = 8; IdListTest(): list() {} IdList list; int add(int num) { return list.add(make_unique_ref(num)); } int add() { return add(OBJ1); } void check(int id, int num) { EXPECT_EQ(num, list.get(id)->val); } void checkConst(int id, int num) { const IdList &constList = list; EXPECT_EQ(num, constList.get(id)->val); } }; TEST_F(IdListTest, EmptyList1) { ASSERT_THROW(list.get(0), std::out_of_range); } TEST_F(IdListTest, EmptyList2) { ASSERT_THROW(list.get(3), std::out_of_range); } TEST_F(IdListTest, InvalidId) { int valid_id = add(); int invalid_id = valid_id + 1; ASSERT_THROW(list.get(invalid_id), std::out_of_range); } TEST_F(IdListTest, GetRemovedItemOnEmptyList) { int id = add(); list.remove(id); ASSERT_THROW(list.get(id), std::out_of_range); } TEST_F(IdListTest, GetRemovedItemOnNonEmptyList) { int id = add(); add(); list.remove(id); ASSERT_THROW(list.get(id), std::out_of_range); } TEST_F(IdListTest, RemoveOnEmptyList1) { ASSERT_THROW(list.remove(0), std::out_of_range); } TEST_F(IdListTest, RemoveOnEmptyList2) { ASSERT_THROW(list.remove(4), std::out_of_range); } TEST_F(IdListTest, RemoveInvalidId) { int valid_id = add(); int invalid_id = valid_id + 1; ASSERT_THROW(list.remove(invalid_id), std::out_of_range); } TEST_F(IdListTest, Add1AndGet) { int id = add(OBJ1); check(id, OBJ1); } TEST_F(IdListTest, Add2AndGet) { int id1 = add(OBJ1); int id2 = add(OBJ2); check(id1, OBJ1); check(id2, OBJ2); } TEST_F(IdListTest, Add3AndGet) { int id1 = add(OBJ1); int id2 = add(OBJ2); int id3 = add(OBJ3); check(id1, OBJ1); check(id3, OBJ3); check(id2, OBJ2); } TEST_F(IdListTest, Add3AndConstGet) { int id1 = add(OBJ1); int id2 = add(OBJ2); int id3 = add(OBJ3); checkConst(id1, OBJ1); checkConst(id3, OBJ3); checkConst(id2, OBJ2); } test/fspp/testutils/000077500000000000000000000000001300002025200150255ustar00rootroot00000000000000test/fspp/testutils/FuseTest.cpp000066400000000000000000000121521300002025200172740ustar00rootroot00000000000000#include "FuseTest.h" using ::testing::StrEq; using ::testing::_; using ::testing::Return; using ::testing::Throw; using ::testing::Action; using ::testing::Invoke; using cpputils::unique_ref; using cpputils::make_unique_ref; namespace bf = boost::filesystem; using namespace fspp::fuse; MockFilesystem::MockFilesystem() {} MockFilesystem::~MockFilesystem() {} FuseTest::FuseTest(): fsimpl() { auto defaultAction = Throw(FuseErrnoException(EIO)); ON_CALL(fsimpl, openFile(_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, closeFile(_)).WillByDefault(defaultAction); ON_CALL(fsimpl, lstat(_,_)).WillByDefault(Throw(FuseErrnoException(ENOENT))); ON_CALL(fsimpl, fstat(_,_)).WillByDefault(Throw(FuseErrnoException(ENOENT))); ON_CALL(fsimpl, truncate(_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, ftruncate(_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, read(_,_,_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, write(_,_,_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, fsync(_)).WillByDefault(defaultAction); ON_CALL(fsimpl, fdatasync(_)).WillByDefault(defaultAction); ON_CALL(fsimpl, access(_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, createAndOpenFile(_,_,_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, mkdir(_,_,_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, rmdir(_)).WillByDefault(defaultAction); ON_CALL(fsimpl, unlink(_)).WillByDefault(defaultAction); ON_CALL(fsimpl, rename(_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, readDir(_)).WillByDefault(defaultAction); ON_CALL(fsimpl, utimens(_,_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, statfs(_,_)).WillByDefault(Invoke([](const char */*path*/, struct statvfs *result) { ::statvfs("/", result); // As dummy value take the values from the root filesystem })); ON_CALL(fsimpl, chmod(_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, chown(_,_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, createSymlink(_,_,_,_)).WillByDefault(defaultAction); ON_CALL(fsimpl, readSymlink(_,_,_)).WillByDefault(defaultAction); EXPECT_CALL(fsimpl, access(_,_)).WillRepeatedly(Return()); ReturnIsDirOnLstat("/"); } unique_ref FuseTest::TestFS() { return make_unique_ref(&fsimpl); } FuseTest::TempTestFS::TempTestFS(MockFilesystem *fsimpl): _mountDir(), _fuse(fsimpl, "fusetest", boost::none), _fuse_thread(&_fuse) { _fuse_thread.start(_mountDir.path(), {"-f"}); } FuseTest::TempTestFS::~TempTestFS() { _fuse_thread.stop(); } const bf::path &FuseTest::TempTestFS::mountDir() const { return _mountDir.path(); } Action FuseTest::ReturnIsFileWithSize(size_t size) { return Invoke([size](const char*, struct ::stat* result) { result->st_mode = S_IFREG | S_IRUSR | S_IRGRP | S_IROTH; result->st_nlink = 1; result->st_size = size; }); } //TODO Combine ReturnIsFile and ReturnIsFileFstat. This should be possible in gmock by either (a) using ::testing::Undefined as parameter type or (b) using action macros Action FuseTest::ReturnIsFile = ReturnIsFileWithSize(0); Action FuseTest::ReturnIsFileFstat = Invoke([](int, struct ::stat* result) { result->st_mode = S_IFREG | S_IRUSR | S_IRGRP | S_IROTH; result->st_nlink = 1; }); Action FuseTest::ReturnIsFileFstatWithSize(size_t size) { return Invoke([size](int, struct ::stat *result) { result->st_mode = S_IFREG | S_IRUSR | S_IRGRP | S_IROTH; result->st_nlink = 1; result->st_size = size; std::cout << "Return size: " << size < FuseTest::ReturnIsDir = Invoke([](const char*, struct ::stat* result) { result->st_mode = S_IFDIR | S_IRUSR | S_IRGRP | S_IROTH | S_IXUSR | S_IXGRP | S_IXOTH; result->st_nlink = 1; }); Action FuseTest::ReturnDoesntExist = Throw(fspp::fuse::FuseErrnoException(ENOENT)); void FuseTest::OnOpenReturnFileDescriptor(const char *filename, int descriptor) { EXPECT_CALL(fsimpl, openFile(StrEq(filename), _)).Times(1).WillOnce(Return(descriptor)); } void FuseTest::ReturnIsFileOnLstat(const bf::path &path) { EXPECT_CALL(fsimpl, lstat(::testing::StrEq(path.c_str()), ::testing::_)).WillRepeatedly(ReturnIsFile); } void FuseTest::ReturnIsFileOnLstatWithSize(const bf::path &path, const size_t size) { EXPECT_CALL(fsimpl, lstat(::testing::StrEq(path.c_str()), ::testing::_)).WillRepeatedly(ReturnIsFileWithSize(size)); } void FuseTest::ReturnIsDirOnLstat(const bf::path &path) { EXPECT_CALL(fsimpl, lstat(::testing::StrEq(path.c_str()), ::testing::_)).WillRepeatedly(ReturnIsDir); } void FuseTest::ReturnDoesntExistOnLstat(const bf::path &path) { EXPECT_CALL(fsimpl, lstat(::testing::StrEq(path.c_str()), ::testing::_)).WillRepeatedly(ReturnDoesntExist); } void FuseTest::ReturnIsFileOnFstat(int descriptor) { EXPECT_CALL(fsimpl, fstat(descriptor, _)).WillRepeatedly(ReturnIsFileFstat); } void FuseTest::ReturnIsFileOnFstatWithSize(int descriptor, size_t size) { EXPECT_CALL(fsimpl, fstat(descriptor, _)).WillRepeatedly(ReturnIsFileFstatWithSize(size)); }test/fspp/testutils/FuseTest.h000066400000000000000000000132661300002025200167500ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_TESTUTILS_FUSETEST_H_ #define MESSMER_FSPP_TEST_TESTUTILS_FUSETEST_H_ #include #include #include "fspp/fuse/Filesystem.h" #include "fspp/fuse/FuseErrnoException.h" #include "fspp/fuse/Fuse.h" #include "fspp/fs_interface/Dir.h" #include #include #include "FuseThread.h" #define MOCK_PATH_METHOD1(NAME, RETURNTYPE) \ RETURNTYPE NAME(const boost::filesystem::path &path) override { \ return NAME(path.c_str()); \ } \ MOCK_METHOD1(NAME, RETURNTYPE(const char*)); \ #define MOCK_PATH_METHOD2(NAME, RETURNTYPE, PARAM1) \ RETURNTYPE NAME(const boost::filesystem::path &path, PARAM1 param1) override { \ return NAME(path.c_str(), param1); \ } \ MOCK_METHOD2(NAME, RETURNTYPE(const char*, PARAM1)); \ #define MOCK_PATH_METHOD3(NAME, RETURNTYPE, PARAM1, PARAM2) \ RETURNTYPE NAME(const boost::filesystem::path &path, PARAM1 p1, PARAM2 p2) override { \ return NAME(path.c_str(), p1, p2); \ } \ MOCK_METHOD3(NAME, RETURNTYPE(const char*, PARAM1, PARAM2)); \ #define MOCK_PATH_METHOD4(NAME, RETURNTYPE, PARAM1, PARAM2, PARAM3) \ RETURNTYPE NAME(const boost::filesystem::path &path, PARAM1 p1, PARAM2 p2, PARAM3 p3) override { \ return NAME(path.c_str(), p1, p2, p3); \ } \ MOCK_METHOD4(NAME, RETURNTYPE(const char*, PARAM1, PARAM2, PARAM3)); \ class MockFilesystem: public fspp::fuse::Filesystem { public: MockFilesystem(); virtual ~MockFilesystem(); MOCK_PATH_METHOD2(openFile, int, int); MOCK_METHOD1(closeFile, void(int)); MOCK_PATH_METHOD2(lstat, void, struct ::stat*); MOCK_METHOD2(fstat, void(int, struct ::stat*)); MOCK_PATH_METHOD2(truncate, void, off_t); MOCK_METHOD2(ftruncate, void(int, off_t)); MOCK_METHOD4(read, size_t(int, void*, size_t, off_t)); MOCK_METHOD4(write, void(int, const void*, size_t, off_t)); MOCK_METHOD1(flush, void(int)); MOCK_METHOD1(fsync, void(int)); MOCK_METHOD1(fdatasync, void(int)); MOCK_PATH_METHOD2(access, void, int); MOCK_PATH_METHOD4(createAndOpenFile, int, mode_t, uid_t, gid_t); MOCK_PATH_METHOD4(mkdir, void, mode_t, uid_t, gid_t); MOCK_PATH_METHOD1(rmdir, void); MOCK_PATH_METHOD1(unlink, void); void rename(const boost::filesystem::path &from, const boost::filesystem::path &to) override { return rename(from.c_str(), to.c_str()); } MOCK_METHOD2(rename, void(const char*, const char*)); cpputils::unique_ref> readDir(const boost::filesystem::path &path) override { return cpputils::nullcheck(std::unique_ptr>(readDir(path.c_str()))).value(); } MOCK_METHOD1(readDir, std::vector*(const char*)); void utimens(const boost::filesystem::path &path, timespec lastAccessTime, timespec lastModificationTime) override { return utimens(path.c_str(), lastAccessTime, lastModificationTime); } MOCK_METHOD3(utimens, void(const char*, timespec, timespec)); MOCK_PATH_METHOD2(statfs, void, struct statvfs*); void createSymlink(const boost::filesystem::path &to, const boost::filesystem::path &from, uid_t uid, gid_t gid) override { return createSymlink(to.c_str(), from.c_str(), uid, gid); } MOCK_PATH_METHOD2(chmod, void, mode_t); MOCK_PATH_METHOD3(chown, void, uid_t, gid_t); MOCK_METHOD4(createSymlink, void(const char*, const char*, uid_t, gid_t)); MOCK_PATH_METHOD3(readSymlink, void, char*, size_t); }; class FuseTest: public ::testing::Test { public: static constexpr const char* FILENAME = "/myfile"; FuseTest(); class TempTestFS { public: TempTestFS(MockFilesystem *fsimpl); virtual ~TempTestFS(); public: const boost::filesystem::path &mountDir() const; private: cpputils::TempDir _mountDir; fspp::fuse::Fuse _fuse; FuseThread _fuse_thread; }; cpputils::unique_ref TestFS(); MockFilesystem fsimpl; //TODO Combine ReturnIsFile and ReturnIsFileFstat. This should be possible in gmock by either (a) using ::testing::Undefined as parameter type or (b) using action macros static ::testing::Action ReturnIsFile; static ::testing::Action ReturnIsFileWithSize(size_t size); static ::testing::Action ReturnIsFileFstat; static ::testing::Action ReturnIsFileFstatWithSize(size_t size); static ::testing::Action ReturnIsDir; static ::testing::Action ReturnDoesntExist; void ReturnIsFileOnLstat(const boost::filesystem::path &path); void ReturnIsFileOnLstatWithSize(const boost::filesystem::path &path, const size_t size); void ReturnIsDirOnLstat(const boost::filesystem::path &path); void ReturnDoesntExistOnLstat(const boost::filesystem::path &path); void OnOpenReturnFileDescriptor(const char *filename, int descriptor); void ReturnIsFileOnFstat(int descriptor); void ReturnIsFileOnFstatWithSize(int descriptor, const size_t size); }; #endif test/fspp/testutils/FuseThread.cpp000066400000000000000000000023051300002025200175630ustar00rootroot00000000000000#include #include #include #include "FuseThread.h" #include #include #include "fspp/fuse/Fuse.h" using boost::thread; using boost::chrono::seconds; using std::string; using std::vector; namespace bf = boost::filesystem; using fspp::fuse::Fuse; FuseThread::FuseThread(Fuse *fuse) :_fuse(fuse), _child() { } void FuseThread::start(const bf::path &mountDir, const vector &fuseOptions) { _child = thread([this, mountDir, fuseOptions] () { _fuse->run(mountDir, fuseOptions); }); //Wait until it is running (busy waiting is simple and doesn't hurt much here) while(!_fuse->running()) {} #ifdef __APPLE__ // On Mac OS X, _fuse->running() returns true too early, because osxfuse calls init() when it's not ready yet. Give it a bit time. std::this_thread::sleep_for(std::chrono::milliseconds(200)); #endif } void FuseThread::stop() { pthread_kill(_child.native_handle(), SIGINT); bool thread_stopped = _child.try_join_for(seconds(5)); ASSERT(thread_stopped, "FuseThread could not be stopped"); //Wait until it is properly shutdown (busy waiting is simple and doesn't hurt much here) while (_fuse->running()) {} } test/fspp/testutils/FuseThread.h000066400000000000000000000011101300002025200172210ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_TESTUTILS_FUSETHREAD_H_ #define MESSMER_FSPP_TEST_TESTUTILS_FUSETHREAD_H_ #include #include #include #include namespace fspp { namespace fuse { class Fuse; } } class FuseThread { public: FuseThread(fspp::fuse::Fuse *fuse); void start(const boost::filesystem::path &mountDir, const std::vector &fuseOptions); void stop(); private: fspp::fuse::Fuse *_fuse; boost::thread _child; DISALLOW_COPY_AND_ASSIGN(FuseThread); }; #endif test/fspp/testutils/InMemoryFile.cpp000066400000000000000000000031071300002025200200710ustar00rootroot00000000000000#include "InMemoryFile.h" using cpputils::Data; InMemoryFile::InMemoryFile(Data data): _data(std::move(data)) { } InMemoryFile::~InMemoryFile() { } int InMemoryFile::read(void *buf, size_t count, off_t offset) const { size_t realCount = std::min(count, (size_t)(_data.size() - offset)); std::memcpy(buf, (uint8_t*)_data.data() + offset, realCount); return realCount; } const void *InMemoryFile::data() const { return _data.data(); } bool InMemoryFile::fileContentEquals(const Data &expected, off_t offset) const { return 0 == std::memcmp((uint8_t*)expected.data(), (uint8_t*)_data.data() + offset, expected.size()); } size_t InMemoryFile::size() const { return _data.size(); } WriteableInMemoryFile::WriteableInMemoryFile(Data data): InMemoryFile(std::move(data)), _originalData(_data.copy()) { } void WriteableInMemoryFile::write(const void *buf, size_t count, off_t offset) { _extendFileSizeIfNecessary(count + offset); std::memcpy((uint8_t*)_data.data() + offset, buf, count); } void WriteableInMemoryFile::_extendFileSizeIfNecessary(size_t size) { if (size > _data.size()) { _extendFileSize(size); } } void WriteableInMemoryFile::_extendFileSize(size_t size) { Data newfile(size); std::memcpy(newfile.data(), _data.data(), _data.size()); _data = std::move(newfile); } bool WriteableInMemoryFile::sizeUnchanged() const { return _data.size() == _originalData.size(); } bool WriteableInMemoryFile::regionUnchanged(off_t offset, size_t count) const { return 0 == std::memcmp((uint8_t*)_data.data() + offset, (uint8_t*)_originalData.data() + offset, count); } test/fspp/testutils/InMemoryFile.h000066400000000000000000000015441300002025200175410ustar00rootroot00000000000000#pragma once #ifndef MESSMER_FSPP_TEST_TESTUTILS_INMEMORYFILE_H_ #define MESSMER_FSPP_TEST_TESTUTILS_INMEMORYFILE_H_ #include class InMemoryFile { public: InMemoryFile(cpputils::Data data); virtual ~InMemoryFile(); int read(void *buf, size_t count, off_t offset) const; const void *data() const; size_t size() const; bool fileContentEquals(const cpputils::Data &expected, off_t offset) const; protected: cpputils::Data _data; }; class WriteableInMemoryFile: public InMemoryFile { public: WriteableInMemoryFile(cpputils::Data data); void write(const void *buf, size_t count, off_t offset); bool sizeUnchanged() const; bool regionUnchanged(off_t offset, size_t count) const; private: void _extendFileSizeIfNecessary(size_t size); void _extendFileSize(size_t size); cpputils::Data _originalData; }; #endif test/gitversion/000077500000000000000000000000001300002025200142065ustar00rootroot00000000000000test/gitversion/CMakeLists.txt000066400000000000000000000005001300002025200167410ustar00rootroot00000000000000project (gitversion-test) set(SOURCES ParserTest.cpp VersionCompareTest.cpp ) add_executable(${PROJECT_NAME} ${SOURCES}) target_link_libraries(${PROJECT_NAME} googletest gitversion) add_test(${PROJECT_NAME} ${PROJECT_NAME}) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) test/gitversion/ParserTest.cpp000066400000000000000000000225261300002025200170150ustar00rootroot00000000000000#include #include using namespace gitversion; TEST(ParserTest, TestUnknownVersion) { VersionInfo info = Parser::parse("0+unknown"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("0", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("", info.gitCommitId); EXPECT_EQ("", info.versionTag); EXPECT_EQ(0u, info.commitsSinceTag); } TEST(ParserTest, TestReleaseVersion_1) { VersionInfo info = Parser::parse("0.9.2"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("2", info.hotfixVersion); EXPECT_FALSE( info.isDevVersion); EXPECT_TRUE( info.isStableVersion); EXPECT_EQ("", info.gitCommitId); EXPECT_EQ("", info.versionTag); EXPECT_EQ(0u, info.commitsSinceTag); } TEST(ParserTest, TestReleaseVersion_2) { VersionInfo info = Parser::parse("1.02.3"); EXPECT_EQ("1", info.majorVersion); EXPECT_EQ("02", info.minorVersion); EXPECT_EQ("3", info.hotfixVersion); EXPECT_FALSE( info.isDevVersion); EXPECT_TRUE( info.isStableVersion); EXPECT_EQ("", info.gitCommitId); EXPECT_EQ("", info.versionTag); EXPECT_EQ(0u, info.commitsSinceTag); } TEST(ParserTest, TestReleaseVersion_3) { VersionInfo info = Parser::parse("01.020.3"); EXPECT_EQ("01", info.majorVersion); EXPECT_EQ("020", info.minorVersion); EXPECT_EQ("3", info.hotfixVersion); EXPECT_FALSE( info.isDevVersion); EXPECT_TRUE( info.isStableVersion); EXPECT_EQ("", info.gitCommitId); EXPECT_EQ("", info.versionTag); EXPECT_EQ(0u, info.commitsSinceTag); } TEST(ParserTest, TestDirtyReleaseVersion) { VersionInfo info = Parser::parse("0.9.0+0.g5753e4f.dirty"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("5753e4f", info.gitCommitId); EXPECT_EQ("", info.versionTag); EXPECT_EQ(0u, info.commitsSinceTag); } TEST(ParserTest, TestDevVersion) { VersionInfo info = Parser::parse("0.9.0+2.g0123abcdef"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("0123abcdef", info.gitCommitId); EXPECT_EQ("", info.versionTag); EXPECT_EQ(2u, info.commitsSinceTag); } TEST(ParserTest, TestDirtyDevVersion) { VersionInfo info = Parser::parse("0.9.0+20.g0123abcdef.dirty"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("0123abcdef", info.gitCommitId); EXPECT_EQ("", info.versionTag); EXPECT_EQ(20u, info.commitsSinceTag); } TEST(ParserTest, TestReleaseVersion_StableTag) { VersionInfo info = Parser::parse("0.9.2-stable"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("2", info.hotfixVersion); EXPECT_FALSE( info.isDevVersion); EXPECT_TRUE( info.isStableVersion); EXPECT_EQ("", info.gitCommitId); EXPECT_EQ("stable", info.versionTag); EXPECT_EQ(0u, info.commitsSinceTag); } TEST(ParserTest, TestDirtyReleaseVersion_StableTag) { VersionInfo info = Parser::parse("0.9.0-stable+0.g5753e4f.dirty"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("5753e4f", info.gitCommitId); EXPECT_EQ("stable", info.versionTag); EXPECT_EQ(0u, info.commitsSinceTag); } TEST(ParserTest, TestDevVersion_StableTag) { VersionInfo info = Parser::parse("0.9.0-stable+2.g0123abcdef"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("0123abcdef", info.gitCommitId); EXPECT_EQ("stable", info.versionTag); EXPECT_EQ(2u, info.commitsSinceTag); } TEST(ParserTest, TestDirtyDevVersion_StableTag) { VersionInfo info = Parser::parse("0.9.0-stable+20.g0123abcdef.dirty"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("0123abcdef", info.gitCommitId); EXPECT_EQ("stable", info.versionTag); EXPECT_EQ(20u, info.commitsSinceTag); } TEST(ParserTest, TestReleaseVersion_AlphaTag) { VersionInfo info = Parser::parse("0.9.2-alpha"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("2", info.hotfixVersion); EXPECT_FALSE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("", info.gitCommitId); EXPECT_EQ("alpha", info.versionTag); EXPECT_EQ(0u, info.commitsSinceTag); } TEST(ParserTest, TestDirtyReleaseVersion_AlphaTag) { VersionInfo info = Parser::parse("0.9.0-alpha+0.g5753e4f.dirty"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("5753e4f", info.gitCommitId); EXPECT_EQ("alpha", info.versionTag); EXPECT_EQ(0u, info.commitsSinceTag); } TEST(ParserTest, TestDevVersion_AlphaTag) { VersionInfo info = Parser::parse("0.9.0-alpha+2.g0123abcdef"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("0123abcdef", info.gitCommitId); EXPECT_EQ("alpha", info.versionTag); EXPECT_EQ(2u, info.commitsSinceTag); } TEST(ParserTest, TestDirtyDevVersion_AlphaTag) { VersionInfo info = Parser::parse("0.9.0-alpha+20.g0123abcdef.dirty"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("0123abcdef", info.gitCommitId); EXPECT_EQ("alpha", info.versionTag); EXPECT_EQ(20u, info.commitsSinceTag); } TEST(ParserTest, TestReleaseVersion_WithoutHotfixVersion) { VersionInfo info = Parser::parse("1.0-beta"); EXPECT_EQ("1", info.majorVersion); EXPECT_EQ("0", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_FALSE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("", info.gitCommitId); EXPECT_EQ("beta", info.versionTag); EXPECT_EQ(0u, info.commitsSinceTag); } TEST(ParserTest, TestReleaseVersion_RCTag) { VersionInfo info = Parser::parse("0.9.2-rc1"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("2", info.hotfixVersion); EXPECT_FALSE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("", info.gitCommitId); EXPECT_EQ("rc1", info.versionTag); EXPECT_EQ(0u, info.commitsSinceTag); } TEST(ParserTest, TestDirtyReleaseVersion_RCTag) { VersionInfo info = Parser::parse("0.9.0-rc1+0.g5753e4f.dirty"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("5753e4f", info.gitCommitId); EXPECT_EQ("rc1", info.versionTag); EXPECT_EQ(0u, info.commitsSinceTag); } TEST(ParserTest, TestDevVersion_RCTag) { VersionInfo info = Parser::parse("0.9.0-rc1+2.g0123abcdef"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("0123abcdef", info.gitCommitId); EXPECT_EQ("rc1", info.versionTag); EXPECT_EQ(2u, info.commitsSinceTag); } TEST(ParserTest, TestDirtyDevVersion_RCTag) { VersionInfo info = Parser::parse("0.9.0-rc1+20.g0123abcdef.dirty"); EXPECT_EQ("0", info.majorVersion); EXPECT_EQ("9", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("0123abcdef", info.gitCommitId); EXPECT_EQ("rc1", info.versionTag); EXPECT_EQ(20u, info.commitsSinceTag); } TEST(ParserTest, TestDirtyDevVersion_WithoutMinorVersion) { VersionInfo info = Parser::parse("1-rc1+20.g0123abcdef.dirty"); EXPECT_EQ("1", info.majorVersion); EXPECT_EQ("0", info.minorVersion); EXPECT_EQ("0", info.hotfixVersion); EXPECT_TRUE( info.isDevVersion); EXPECT_FALSE( info.isStableVersion); EXPECT_EQ("0123abcdef", info.gitCommitId); EXPECT_EQ("rc1", info.versionTag); EXPECT_EQ(20u, info.commitsSinceTag); }test/gitversion/VersionCompareTest.cpp000066400000000000000000000053201300002025200205060ustar00rootroot00000000000000#include #include using namespace gitversion; using std::string; class VersionCompareTest : public ::testing::Test { public: void EXPECT_IS_OLDER_THAN(const string &v1, const string &v2) { EXPECT_TRUE(VersionCompare::isOlderThan(v1, v2)); EXPECT_FALSE(VersionCompare::isOlderThan(v2, v1)); } void EXPECT_IS_SAME_AGE(const string &v1, const string &v2) { EXPECT_FALSE(VersionCompare::isOlderThan(v1, v2)); EXPECT_FALSE(VersionCompare::isOlderThan(v2, v1)); } }; TEST_F(VersionCompareTest, IsDifferentVersion) { EXPECT_IS_OLDER_THAN("0.8", "0.8.1"); EXPECT_IS_OLDER_THAN("0.8", "1.0"); EXPECT_IS_OLDER_THAN("0.8", "1.0.1"); EXPECT_IS_OLDER_THAN("0.8.1", "1.0"); EXPECT_IS_OLDER_THAN("0.7.9", "0.8.0"); EXPECT_IS_OLDER_THAN("1.0.0", "1.0.1"); EXPECT_IS_OLDER_THAN("1", "1.0.1"); EXPECT_IS_OLDER_THAN("1.0.0", "1.1"); } TEST_F(VersionCompareTest, IsSameVersion) { EXPECT_IS_SAME_AGE("0.8", "0.8"); EXPECT_IS_SAME_AGE("1.0", "1.0"); EXPECT_IS_SAME_AGE("1", "1.0"); EXPECT_IS_SAME_AGE("1.0.0", "1.0.0"); EXPECT_IS_SAME_AGE("0.8", "0.8.0"); EXPECT_IS_SAME_AGE("1", "1.0.0.0"); } TEST_F(VersionCompareTest, ZeroPrefix) { EXPECT_IS_OLDER_THAN("1.00.0", "1.0.01"); EXPECT_IS_SAME_AGE("1.0.01", "1.0.1"); EXPECT_IS_SAME_AGE("01.0.01", "1.0.1"); } TEST_F(VersionCompareTest, VersionTags) { EXPECT_IS_OLDER_THAN("0.9.3-alpha", "0.9.3-beta"); EXPECT_IS_OLDER_THAN("1.0-beta", "1.0-rc1"); EXPECT_IS_OLDER_THAN("1.0-rc1", "1.0-rc2"); EXPECT_IS_OLDER_THAN("1.0-rc2", "1.0"); EXPECT_IS_OLDER_THAN("1.0-alpha", "1.0"); EXPECT_IS_SAME_AGE("0.9.3-alpha", "0.9.3-alpha"); EXPECT_IS_SAME_AGE("1-beta", "1-beta"); EXPECT_IS_SAME_AGE("0.9.3-rc1", "0.9.3-rc1"); } TEST_F(VersionCompareTest, DevVersions) { EXPECT_IS_OLDER_THAN("0.8", "0.8.1+1.g1234"); EXPECT_IS_OLDER_THAN("0.8.1", "0.8.2+1.g1234"); EXPECT_IS_OLDER_THAN("0.8.1+1.g1234", "0.8.2"); EXPECT_IS_OLDER_THAN("0.8+1.g1234", "0.8.1"); EXPECT_IS_OLDER_THAN("0.8+1.g1234", "0.9"); EXPECT_IS_OLDER_THAN("0.9+1.g1234", "0.9+2.g1234"); EXPECT_IS_SAME_AGE("0.9.1+1.g1234", "0.9.1+1.g3456"); EXPECT_IS_SAME_AGE("0.9.1+5.g1234", "0.9.1+5.g2345.dirty"); } TEST_F(VersionCompareTest, DevVersions_VersionTags) { EXPECT_IS_OLDER_THAN("0.9.3-alpha+3.gabcd", "0.9.3-alpha+4.gabcd"); EXPECT_IS_OLDER_THAN("0.9.3-alpha+5.gabcd", "0.9.3-beta"); EXPECT_IS_OLDER_THAN("0.9.3-alpha+5.gabcd", "0.9.3-beta+1.gabcd"); EXPECT_IS_OLDER_THAN("0.9.3-alpha+5.gabcd", "1+0.gabcd.dirty"); EXPECT_IS_OLDER_THAN("0.9.3-alpha+5.gabcd", "1"); EXPECT_IS_SAME_AGE("0.9.3-alpha+3.gabcd", "0.9.3-alpha+3.gabcd"); }test/parallelaccessstore/000077500000000000000000000000001300002025200160505ustar00rootroot00000000000000test/parallelaccessstore/CMakeLists.txt000066400000000000000000000005321300002025200206100ustar00rootroot00000000000000project (parallelaccessstore-test) set(SOURCES ParallelAccessBaseStoreTest.cpp DummyTest.cpp ) add_executable(${PROJECT_NAME} ${SOURCES}) target_link_libraries(${PROJECT_NAME} googletest parallelaccessstore) add_test(${PROJECT_NAME} ${PROJECT_NAME}) target_enable_style_warnings(${PROJECT_NAME}) target_activate_cpp14(${PROJECT_NAME}) test/parallelaccessstore/DummyTest.cpp000066400000000000000000000000661300002025200205110ustar00rootroot00000000000000#include TEST(Dummy, DummyTest) { } test/parallelaccessstore/ParallelAccessBaseStoreTest.cpp000066400000000000000000000002001300002025200240720ustar00rootroot00000000000000#include "parallelaccessstore/ParallelAccessBaseStore.h" // Test that ParallelAccessBaseStore.h can be included without errors travis.install_boost.sh000077500000000000000000000006451300002025200155650ustar00rootroot00000000000000#!/bin/bash set -e wget -O boost.tar.bz2 https://sourceforge.net/projects/boost/files/boost/1.56.0/boost_1_56_0.tar.bz2/download tar -xf boost.tar.bz2 cd boost_1_56_0 # TODO We should use clang as toolchain for building boost when clang is used for building our code ./bootstrap.sh --with-libraries=filesystem,thread,chrono,program_options sudo ./b2 -d0 -j$NUMCORES install cd .. sudo rm -rf boost.tar.bz2 boost_1_56_0 utils.cmake000066400000000000000000000137071300002025200132100ustar00rootroot00000000000000include(CheckCXXCompilerFlag) ################################################### # Activate C++14 # # Uses: target_activate_cpp14(buildtarget) ################################################### function(target_activate_cpp14 TARGET) if("${CMAKE_VERSION}" VERSION_GREATER "3.1") set_property(TARGET ${TARGET} PROPERTY CXX_STANDARD 14) set_property(TARGET ${TARGET} PROPERTY CXX_STANDARD_REQUIRED ON) else("${CMAKE_VERSION}" VERSION_GREATER "3.1") check_cxx_compiler_flag("-std=c++14" COMPILER_HAS_CPP14_SUPPORT) if (COMPILER_HAS_CPP14_SUPPORT) target_compile_options(${TARGET} PUBLIC -std=c++14) else(COMPILER_HAS_CPP14_SUPPORT) check_cxx_compiler_flag("-std=c++1y" COMPILER_HAS_CPP14_PARTIAL_SUPPORT) if (COMPILER_HAS_CPP14_PARTIAL_SUPPORT) target_compile_options(${TARGET} PUBLIC -std=c++1y) else() message(FATAL_ERROR "Compiler doesn't support C++14") endif() endif(COMPILER_HAS_CPP14_SUPPORT) endif("${CMAKE_VERSION}" VERSION_GREATER "3.1") if(CMAKE_CXX_COMPILER_ID MATCHES "Clang") target_compile_options(${TARGET} PUBLIC -stdlib=libc++) endif(CMAKE_CXX_COMPILER_ID MATCHES "Clang") endfunction(target_activate_cpp14) ################################################# # Enable style compiler warnings # # Uses: target_enable_style_warnings(buildtarget) ################################################# function(target_enable_style_warnings TARGET) target_compile_options(${TARGET} PRIVATE -Wall -Wextra) endfunction(target_enable_style_warnings) ################################################## # Add boost to the project # # Uses: # target_add_boost(buildtarget) # if you're only using header-only boost libs # target_add_boost(buildtarget system filesystem) # list all libraries to link against in the dependencies ################################################## function(target_add_boost TARGET) # Load boost libraries if(NOT DEFINED Boost_USE_STATIC_LIBS OR Boost_USE_STATIC_LIBS) # Many supported systems don't have boost >= 1.56. Better link it statically. message(STATUS "Boost will be statically linked") set(Boost_USE_STATIC_LIBS ON) else(NOT DEFINED Boost_USE_STATIC_LIBS OR Boost_USE_STATIC_LIBS) message(STATUS "Boost will be dynamically linked") set(Boost_USE_STATIC_LIBS OFF) endif(NOT DEFINED Boost_USE_STATIC_LIBS OR Boost_USE_STATIC_LIBS) find_package(Boost 1.56.0 REQUIRED COMPONENTS ${ARGN}) target_include_directories(${TARGET} SYSTEM PUBLIC ${Boost_INCLUDE_DIRS}) target_link_libraries(${TARGET} PUBLIC ${Boost_LIBRARIES}) if(${CMAKE_SYSTEM_NAME} MATCHES "Linux") # Also link to rt, because boost thread needs that. target_link_libraries(${TARGET} PUBLIC rt) endif(${CMAKE_SYSTEM_NAME} MATCHES "Linux") endfunction(target_add_boost) ################################################## # Specify that a specific minimal version of gcc is required # # Uses: # require_gcc_version(4.9) ################################################## function(require_gcc_version VERSION) if (CMAKE_COMPILER_IS_GNUCXX) execute_process(COMMAND ${CMAKE_CXX_COMPILER} -dumpversion OUTPUT_VARIABLE GCC_VERSION) if (GCC_VERSION VERSION_LESS ${VERSION}) message(FATAL_ERROR "Needs at least gcc version ${VERSION}, found gcc ${GCC_VERSION}") endif (GCC_VERSION VERSION_LESS ${VERSION}) endif (CMAKE_COMPILER_IS_GNUCXX) endfunction(require_gcc_version) ################################################## # Specify that a specific minimal version of clang is required # # Uses: # require_clang_version(3.5) ################################################## function(require_clang_version VERSION) if (CMAKE_CXX_COMPILER_ID MATCHES "Clang") if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS ${VERSION}) message(FATAL_ERROR "Needs at least clang version ${VERSION}, found clang ${CMAKE_CXX_COMPILER_VERSION}") endif (CMAKE_CXX_COMPILER_VERSION VERSION_LESS ${VERSION}) endif(CMAKE_CXX_COMPILER_ID MATCHES "Clang") endfunction(require_clang_version) ################################################## # Find the location of a library and return its full path in OUTPUT_VARIABLE. # If PATH_VARIABLE points to a defined variable, then the library will only be searched in this path. # If PATH_VARIABLE points to a undefined variable, default system locations will be searched. # # Uses (the following will search for fuse in system locations by default, and if the user passes -DFUSE_LIB_PATH to cmake, it will only search in this path. # find_library_with_path(MYLIBRARY fuse FUSE_LIB_PATH) # target_link_library(target ${MYLIBRARY}) ################################################## function(find_library_with_path OUTPUT_VARIABLE LIBRARY_NAME PATH_VARIABLE) if(${PATH_VARIABLE}) find_library(${OUTPUT_VARIABLE} ${LIBRARY_NAME} PATHS ${${PATH_VARIABLE}} NO_DEFAULT_PATH) if (${OUTPUT_VARIABLE} MATCHES NOTFOUND) message(FATAL_ERROR "Didn't find ${LIBRARY_NAME} in path specified by the ${PATH_VARIABLE} parameter (${${PATH_VARIABLE}}). Pass in the correct path or remove the parameter to try common system locations.") else(${OUTPUT_VARIABLE} MATCHES NOTFOUND) message(STATUS "Found ${LIBRARY_NAME} in user-defined path ${${PATH_VARIABLE}}") endif(${OUTPUT_VARIABLE} MATCHES NOTFOUND) else(${PATH_VARIABLE}) find_library(${OUTPUT_VARIABLE} ${LIBRARY_NAME}) if (${OUTPUT_VARIABLE} MATCHES NOTFOUND) message(FATAL_ERROR "Didn't find ${LIBRARY_NAME} library. If ${LIBRARY_NAME} is installed, try passing in the library location with -D${PATH_VARIABLE}=/path/to/${LIBRARY_NAME}/lib.") else(${OUTPUT_VARIABLE} MATCHES NOTFOUND) message(STATUS "Found ${LIBRARY_NAME} in system location") endif(${OUTPUT_VARIABLE} MATCHES NOTFOUND) endif(${PATH_VARIABLE}) endfunction(find_library_with_path) vendor/000077500000000000000000000000001300002025200123335ustar00rootroot00000000000000vendor/CMakeLists.txt000066400000000000000000000001171300002025200150720ustar00rootroot00000000000000add_subdirectory(googletest) add_subdirectory(scrypt) add_subdirectory(spdlog) vendor/README000066400000000000000000000006261300002025200132170ustar00rootroot00000000000000This directory contains external projects, taken from the following locations: scrypt: http://www.tarsnap.com/scrypt.html googletest: https://github.com/google/googletest spdlog: https://github.com/gabime/spdlog/commit/0c7beb2e36008598cf80d0e8eb8635ac403febb9 - with own fix: https://github.com/cryfs/spdlog/commit/7b8d507615b8075fc6c8793a0965a32a708288c4 gitversion: https://github.com/smessmer/gitversionvendor/googletest/000077500000000000000000000000001300002025200145075ustar00rootroot00000000000000vendor/googletest/CMakeLists.txt000066400000000000000000000007511300002025200172520ustar00rootroot00000000000000include(CTest) if (BUILD_TESTING) # When test cases are build, disable "make install", because this would also install gtest libraries. macro(install) endmacro(install) add_subdirectory(gtest-1.7.0) project (googletest) add_library(${PROJECT_NAME} dummy.cpp) target_link_libraries(${PROJECT_NAME} gtest gmock gmock_main) target_include_directories(${PROJECT_NAME} SYSTEM INTERFACE ${gtest_INCLUDE_DIRS}/include SYSTEM ${gmock_INCLUDE_DIRS}/include) endif (BUILD_TESTING) vendor/googletest/dummy.cpp000066400000000000000000000000001300002025200163340ustar00rootroot00000000000000vendor/googletest/gtest-1.7.0/000077500000000000000000000000001300002025200162765ustar00rootroot00000000000000vendor/googletest/gtest-1.7.0/CMakeLists.txt000066400000000000000000000005711300002025200210410ustar00rootroot00000000000000cmake_minimum_required(VERSION 2.6.2) project( googletest-distribution ) enable_testing() option(BUILD_GTEST "Builds the googletest subproject" OFF) #Note that googlemock target already builds googletest option(BUILD_GMOCK "Builds the googlemock subproject" ON) if(BUILD_GMOCK) add_subdirectory( googlemock ) elseif(BUILD_GTEST) add_subdirectory( googletest ) endif() vendor/googletest/gtest-1.7.0/README.md000066400000000000000000000113671300002025200175650ustar00rootroot00000000000000 # Google Test # [![Build Status](https://travis-ci.org/google/googletest.svg?branch=master)](https://travis-ci.org/google/googletest) Welcome to **Google Test**, Google's C++ test framework! This repository is a merger of the formerly separate GoogleTest and GoogleMock projects. These were so closely related that it makes sense to maintain and release them together. Please see the project page above for more information as well as the mailing list for questions, discussions, and development. There is also an IRC channel on OFTC (irc.oftc.net) #gtest available. Please join us! Getting started information for **Google Test** is available in the [Google Test Primer](googletest/docs/Primer.md) documentation. **Google Mock** is an extension to Google Test for writing and using C++ mock classes. See the separate [Google Mock documentation](googlemock/README.md). More detailed documentation for googletest (including build instructions) are in its interior [googletest/README.md](googletest/README.md) file. ## Features ## * An [XUnit](https://en.wikipedia.org/wiki/XUnit) test framework. * Test discovery. * A rich set of assertions. * User-defined assertions. * Death tests. * Fatal and non-fatal failures. * Value-parameterized tests. * Type-parameterized tests. * Various options for running the tests. * XML test report generation. ## Platforms ## Google test has been used on a variety of platforms: * Linux * Mac OS X * Windows * Cygwin * MinGW * Windows Mobile * Symbian ## Who Is Using Google Test? ## In addition to many internal projects at Google, Google Test is also used by the following notable projects: * The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser and Chrome OS). * The [LLVM](http://llvm.org/) compiler. * [Protocol Buffers](https://github.com/google/protobuf), Google's data interchange format. * The [OpenCV](http://opencv.org/) computer vision library. ## Related Open Source Projects ## [Google Test UI](https://github.com/ospector/gtest-gbar) is test runner that runs your test binary, allows you to track its progress via a progress bar, and displays a list of test failures. Clicking on one shows failure text. Google Test UI is written in C#. [GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event listener for Google Test that implements the [TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test result output. If your test runner understands TAP, you may find it useful. ## Requirements ## Google Test is designed to have fairly minimal requirements to build and use with your projects, but there are some. Currently, we support Linux, Windows, Mac OS X, and Cygwin. We will also make our best effort to support other platforms (e.g. Solaris, AIX, and z/OS). However, since core members of the Google Test project have no access to these platforms, Google Test may have outstanding issues there. If you notice any problems on your platform, please notify . Patches for fixing them are even more welcome! ### Linux Requirements ### These are the base requirements to build and use Google Test from a source package (as described below): * GNU-compatible Make or gmake * POSIX-standard shell * POSIX(-2) Regular Expressions (regex.h) * A C++98-standard-compliant compiler ### Windows Requirements ### * Microsoft Visual C++ v7.1 or newer ### Cygwin Requirements ### * Cygwin v1.5.25-14 or newer ### Mac OS X Requirements ### * Mac OS X v10.4 Tiger or newer * XCode Developer Tools ### Requirements for Contributors ### We welcome patches. If you plan to contribute a patch, you need to build Google Test and its own tests from a git checkout (described below), which has further requirements: * [Python](https://www.python.org/) v2.3 or newer (for running some of the tests and re-generating certain source files from templates) * [CMake](https://cmake.org/) v2.6.4 or newer ## Regenerating Source Files ## Some of Google Test's source files are generated from templates (not in the C++ sense) using a script. For example, the file include/gtest/internal/gtest-type-util.h.pump is used to generate gtest-type-util.h in the same directory. You don't need to worry about regenerating the source files unless you need to modify them. You would then modify the corresponding `.pump` files and run the '[pump.py](googletest/scripts/pump.py)' generator script. See the [Pump Manual](googletest/docs/PumpManual.md). ### Contributing Code ### We welcome patches. Please read the [Developer's Guide](googletest/docs/DevGuide.md) for how you can contribute. In particular, make sure you have signed the Contributor License Agreement, or we won't be able to accept the patch. Happy testing! vendor/googletest/gtest-1.7.0/googlemock/000077500000000000000000000000001300002025200204245ustar00rootroot00000000000000vendor/googletest/gtest-1.7.0/googlemock/CHANGES000066400000000000000000000126731300002025200214300ustar00rootroot00000000000000Changes for 1.7.0: * All new improvements in Google Test 1.7.0. * New feature: matchers DoubleNear(), FloatNear(), NanSensitiveDoubleNear(), NanSensitiveFloatNear(), UnorderedElementsAre(), UnorderedElementsAreArray(), WhenSorted(), WhenSortedBy(), IsEmpty(), and SizeIs(). * Improvement: Google Mock can now be built as a DLL. * Improvement: when compiled by a C++11 compiler, matchers AllOf() and AnyOf() can accept an arbitrary number of matchers. * Improvement: when compiled by a C++11 compiler, matchers ElementsAreArray() can accept an initializer list. * Improvement: when exceptions are enabled, a mock method with no default action now throws instead crashing the test. * Improvement: added class testing::StringMatchResultListener to aid definition of composite matchers. * Improvement: function return types used in MOCK_METHOD*() macros can now contain unprotected commas. * Improvement (potentially breaking): EXPECT_THAT() and ASSERT_THAT() are now more strict in ensuring that the value type and the matcher type are compatible, catching potential bugs in tests. * Improvement: Pointee() now works on an optional. * Improvement: the ElementsAreArray() matcher can now take a vector or iterator range as input, and makes a copy of its input elements before the conversion to a Matcher. * Improvement: the Google Mock Generator can now generate mocks for some class templates. * Bug fix: mock object destruction triggerred by another mock object's destruction no longer hangs. * Improvement: Google Mock Doctor works better with newer Clang and GCC now. * Compatibility fixes. * Bug/warning fixes. Changes for 1.6.0: * Compilation is much faster and uses much less memory, especially when the constructor and destructor of a mock class are moved out of the class body. * New matchers: Pointwise(), Each(). * New actions: ReturnPointee() and ReturnRefOfCopy(). * CMake support. * Project files for Visual Studio 2010. * AllOf() and AnyOf() can handle up-to 10 arguments now. * Google Mock doctor understands Clang error messages now. * SetArgPointee<> now accepts string literals. * gmock_gen.py handles storage specifier macros and template return types now. * Compatibility fixes. * Bug fixes and implementation clean-ups. * Potentially incompatible changes: disables the harmful 'make install' command in autotools. Potentially breaking changes: * The description string for MATCHER*() changes from Python-style interpolation to an ordinary C++ string expression. * SetArgumentPointee is deprecated in favor of SetArgPointee. * Some non-essential project files for Visual Studio 2005 are removed. Changes for 1.5.0: * New feature: Google Mock can be safely used in multi-threaded tests on platforms having pthreads. * New feature: function for printing a value of arbitrary type. * New feature: function ExplainMatchResult() for easy definition of composite matchers. * The new matcher API lets user-defined matchers generate custom explanations more directly and efficiently. * Better failure messages all around. * NotNull() and IsNull() now work with smart pointers. * Field() and Property() now work when the matcher argument is a pointer passed by reference. * Regular expression matchers on all platforms. * Added GCC 4.0 support for Google Mock Doctor. * Added gmock_all_test.cc for compiling most Google Mock tests in a single file. * Significantly cleaned up compiler warnings. * Bug fixes, better test coverage, and implementation clean-ups. Potentially breaking changes: * Custom matchers defined using MatcherInterface or MakePolymorphicMatcher() need to be updated after upgrading to Google Mock 1.5.0; matchers defined using MATCHER or MATCHER_P* aren't affected. * Dropped support for 'make install'. Changes for 1.4.0 (we skipped 1.2.* and 1.3.* to match the version of Google Test): * Works in more environments: Symbian and minGW, Visual C++ 7.1. * Lighter weight: comes with our own implementation of TR1 tuple (no more dependency on Boost!). * New feature: --gmock_catch_leaked_mocks for detecting leaked mocks. * New feature: ACTION_TEMPLATE for defining templatized actions. * New feature: the .After() clause for specifying expectation order. * New feature: the .With() clause for for specifying inter-argument constraints. * New feature: actions ReturnArg(), ReturnNew(...), and DeleteArg(). * New feature: matchers Key(), Pair(), Args<...>(), AllArgs(), IsNull(), and Contains(). * New feature: utility class MockFunction, useful for checkpoints, etc. * New feature: functions Value(x, m) and SafeMatcherCast(m). * New feature: copying a mock object is rejected at compile time. * New feature: a script for fusing all Google Mock and Google Test source files for easy deployment. * Improved the Google Mock doctor to diagnose more diseases. * Improved the Google Mock generator script. * Compatibility fixes for Mac OS X and gcc. * Bug fixes and implementation clean-ups. Changes for 1.1.0: * New feature: ability to use Google Mock with any testing framework. * New feature: macros for easily defining new matchers * New feature: macros for easily defining new actions. * New feature: more container matchers. * New feature: actions for accessing function arguments and throwing exceptions. * Improved the Google Mock doctor script for diagnosing compiler errors. * Bug fixes and implementation clean-ups. Changes for 1.0.0: * Initial Open Source release of Google Mock vendor/googletest/gtest-1.7.0/googlemock/CMakeLists.txt000066400000000000000000000174461300002025200232000ustar00rootroot00000000000000######################################################################## # CMake build script for Google Mock. # # To run the tests for Google Mock itself on Linux, use 'make test' or # ctest. You can select which tests to run using 'ctest -R regex'. # For more options, run 'ctest --help'. # BUILD_SHARED_LIBS is a standard CMake variable, but we declare it here to # make it prominent in the GUI. option(BUILD_SHARED_LIBS "Build shared libraries (DLLs)." OFF) option(gmock_build_tests "Build all of Google Mock's own tests." OFF) # A directory to find Google Test sources. if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/gtest/CMakeLists.txt") set(gtest_dir gtest) else() set(gtest_dir ../googletest) endif() # Defines pre_project_set_up_hermetic_build() and set_up_hermetic_build(). include("${gtest_dir}/cmake/hermetic_build.cmake" OPTIONAL) if (COMMAND pre_project_set_up_hermetic_build) # Google Test also calls hermetic setup functions from add_subdirectory, # although its changes will not affect things at the current scope. pre_project_set_up_hermetic_build() endif() ######################################################################## # # Project-wide settings # Name of the project. # # CMake files in this project can refer to the root source directory # as ${gmock_SOURCE_DIR} and to the root binary directory as # ${gmock_BINARY_DIR}. # Language "C" is required for find_package(Threads). project(gmock CXX C) cmake_minimum_required(VERSION 2.6.2) if (COMMAND set_up_hermetic_build) set_up_hermetic_build() endif() # Instructs CMake to process Google Test's CMakeLists.txt and add its # targets to the current scope. We are placing Google Test's binary # directory in a subdirectory of our own as VC compilation may break # if they are the same (the default). add_subdirectory("${gtest_dir}" "${gmock_BINARY_DIR}/gtest") # Although Google Test's CMakeLists.txt calls this function, the # changes there don't affect the current scope. Therefore we have to # call it again here. config_compiler_and_linker() # from ${gtest_dir}/cmake/internal_utils.cmake # Adds Google Mock's and Google Test's header directories to the search path. include_directories("${gmock_SOURCE_DIR}/include" "${gmock_SOURCE_DIR}" "${gtest_SOURCE_DIR}/include" # This directory is needed to build directly from Google # Test sources. "${gtest_SOURCE_DIR}") # Summary of tuple support for Microsoft Visual Studio: # Compiler version(MS) version(cmake) Support # ---------- ----------- -------------- ----------------------------- # <= VS 2010 <= 10 <= 1600 Use Google Tests's own tuple. # VS 2012 11 1700 std::tr1::tuple + _VARIADIC_MAX=10 # VS 2013 12 1800 std::tr1::tuple if (MSVC AND MSVC_VERSION EQUAL 1700) add_definitions(/D _VARIADIC_MAX=10) endif() ######################################################################## # # Defines the gmock & gmock_main libraries. User tests should link # with one of them. # Google Mock libraries. We build them using more strict warnings than what # are used for other targets, to ensure that Google Mock can be compiled by # a user aggressive about warnings. cxx_library(gmock "${cxx_strict}" "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc) cxx_library(gmock_main "${cxx_strict}" "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) # If the CMake version supports it, attach header directory information # to the targets for when we are part of a parent build (ie being pulled # in via add_subdirectory() rather than being a standalone build). if (DEFINED CMAKE_VERSION AND NOT "${CMAKE_VERSION}" VERSION_LESS "2.8.11") target_include_directories(gmock INTERFACE "${gmock_SOURCE_DIR}/include") target_include_directories(gmock_main INTERFACE "${gmock_SOURCE_DIR}/include") endif() ######################################################################## # # Install rules install(TARGETS gmock gmock_main DESTINATION lib) install(DIRECTORY ${gmock_SOURCE_DIR}/include/gmock DESTINATION include) ######################################################################## # # Google Mock's own tests. # # You can skip this section if you aren't interested in testing # Google Mock itself. # # The tests are not built by default. To build them, set the # gmock_build_tests option to ON. You can do it by running ccmake # or specifying the -Dgmock_build_tests=ON flag when running cmake. if (gmock_build_tests) # This must be set in the root directory for the tests to be run by # 'make test' or ctest. enable_testing() ############################################################ # C++ tests built with standard compiler flags. cxx_test(gmock-actions_test gmock_main) cxx_test(gmock-cardinalities_test gmock_main) cxx_test(gmock_ex_test gmock_main) cxx_test(gmock-generated-actions_test gmock_main) cxx_test(gmock-generated-function-mockers_test gmock_main) cxx_test(gmock-generated-internal-utils_test gmock_main) cxx_test(gmock-generated-matchers_test gmock_main) cxx_test(gmock-internal-utils_test gmock_main) cxx_test(gmock-matchers_test gmock_main) cxx_test(gmock-more-actions_test gmock_main) cxx_test(gmock-nice-strict_test gmock_main) cxx_test(gmock-port_test gmock_main) cxx_test(gmock-spec-builders_test gmock_main) cxx_test(gmock_link_test gmock_main test/gmock_link2_test.cc) cxx_test(gmock_test gmock_main) if (CMAKE_USE_PTHREADS_INIT) cxx_test(gmock_stress_test gmock) endif() # gmock_all_test is commented to save time building and running tests. # Uncomment if necessary. # cxx_test(gmock_all_test gmock_main) ############################################################ # C++ tests built with non-standard compiler flags. cxx_library(gmock_main_no_exception "${cxx_no_exception}" "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) cxx_library(gmock_main_no_rtti "${cxx_no_rtti}" "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) if (NOT MSVC OR MSVC_VERSION LESS 1600) # 1600 is Visual Studio 2010. # Visual Studio 2010, 2012, and 2013 define symbols in std::tr1 that # conflict with our own definitions. Therefore using our own tuple does not # work on those compilers. cxx_library(gmock_main_use_own_tuple "${cxx_use_own_tuple}" "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) cxx_test_with_flags(gmock_use_own_tuple_test "${cxx_use_own_tuple}" gmock_main_use_own_tuple test/gmock-spec-builders_test.cc) endif() cxx_test_with_flags(gmock-more-actions_no_exception_test "${cxx_no_exception}" gmock_main_no_exception test/gmock-more-actions_test.cc) cxx_test_with_flags(gmock_no_rtti_test "${cxx_no_rtti}" gmock_main_no_rtti test/gmock-spec-builders_test.cc) cxx_shared_library(shared_gmock_main "${cxx_default}" "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) # Tests that a binary can be built with Google Mock as a shared library. On # some system configurations, it may not possible to run the binary without # knowing more details about the system configurations. We do not try to run # this binary. To get a more robust shared library coverage, configure with # -DBUILD_SHARED_LIBS=ON. cxx_executable_with_flags(shared_gmock_test_ "${cxx_default}" shared_gmock_main test/gmock-spec-builders_test.cc) set_target_properties(shared_gmock_test_ PROPERTIES COMPILE_DEFINITIONS "GTEST_LINKED_AS_SHARED_LIBRARY=1") ############################################################ # Python tests. cxx_executable(gmock_leak_test_ test gmock_main) py_test(gmock_leak_test) cxx_executable(gmock_output_test_ test gmock) py_test(gmock_output_test) endif() vendor/googletest/gtest-1.7.0/googlemock/CONTRIBUTORS000066400000000000000000000025311300002025200223050ustar00rootroot00000000000000# This file contains a list of people who've made non-trivial # contribution to the Google C++ Mocking Framework project. People # who commit code to the project are encouraged to add their names # here. Please keep the list sorted by first names. Benoit Sigoure Bogdan Piloca Chandler Carruth Dave MacLachlan David Anderson Dean Sturtevant Gene Volovich Hal Burch Jeffrey Yasskin Jim Keller Joe Walnes Jon Wray Keir Mierle Keith Ray Kostya Serebryany Lev Makhlis Manuel Klimek Mario Tanev Mark Paskin Markus Heule Matthew Simmons Mike Bland Neal Norwitz Nermin Ozkiranartli Owen Carlsen Paneendra Ba Paul Menage Piotr Kaminski Russ Rufer Sverre Sundsdal Takeshi Yoshino Vadim Berman Vlad Losev Wolfgang Klier Zhanyong Wan vendor/googletest/gtest-1.7.0/googlemock/LICENSE000066400000000000000000000027031300002025200214330ustar00rootroot00000000000000Copyright 2008, Google Inc. 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 Google Inc. 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. vendor/googletest/gtest-1.7.0/googlemock/Makefile.am000066400000000000000000000167131300002025200224700ustar00rootroot00000000000000# Automake file # Nonstandard package files for distribution. EXTRA_DIST = LICENSE # We may need to build our internally packaged gtest. If so, it will be # included in the 'subdirs' variable. SUBDIRS = $(subdirs) # This is generated by the configure script, so clean it for distribution. DISTCLEANFILES = scripts/gmock-config # We define the global AM_CPPFLAGS as everything we compile includes from these # directories. AM_CPPFLAGS = $(GTEST_CPPFLAGS) -I$(srcdir)/include # Modifies compiler and linker flags for pthreads compatibility. if HAVE_PTHREADS AM_CXXFLAGS = @PTHREAD_CFLAGS@ -DGTEST_HAS_PTHREAD=1 AM_LIBS = @PTHREAD_LIBS@ endif # Build rules for libraries. lib_LTLIBRARIES = lib/libgmock.la lib/libgmock_main.la lib_libgmock_la_SOURCES = src/gmock-all.cc pkginclude_HEADERS = \ include/gmock/gmock-actions.h \ include/gmock/gmock-cardinalities.h \ include/gmock/gmock-generated-actions.h \ include/gmock/gmock-generated-function-mockers.h \ include/gmock/gmock-generated-matchers.h \ include/gmock/gmock-generated-nice-strict.h \ include/gmock/gmock-matchers.h \ include/gmock/gmock-more-actions.h \ include/gmock/gmock-more-matchers.h \ include/gmock/gmock-spec-builders.h \ include/gmock/gmock.h pkginclude_internaldir = $(pkgincludedir)/internal pkginclude_internal_HEADERS = \ include/gmock/internal/gmock-generated-internal-utils.h \ include/gmock/internal/gmock-internal-utils.h \ include/gmock/internal/gmock-port.h \ include/gmock/internal/custom/gmock-generated-actions.h \ include/gmock/internal/custom/gmock-matchers.h \ include/gmock/internal/custom/gmock-port.h lib_libgmock_main_la_SOURCES = src/gmock_main.cc lib_libgmock_main_la_LIBADD = lib/libgmock.la # Build rules for tests. Automake's naming for some of these variables isn't # terribly obvious, so this is a brief reference: # # TESTS -- Programs run automatically by "make check" # check_PROGRAMS -- Programs built by "make check" but not necessarily run TESTS= check_PROGRAMS= AM_LDFLAGS = $(GTEST_LDFLAGS) # This exercises all major components of Google Mock. It also # verifies that libgmock works. TESTS += test/gmock-spec-builders_test check_PROGRAMS += test/gmock-spec-builders_test test_gmock_spec_builders_test_SOURCES = test/gmock-spec-builders_test.cc test_gmock_spec_builders_test_LDADD = $(GTEST_LIBS) lib/libgmock.la # This tests using Google Mock in multiple translation units. It also # verifies that libgmock_main and libgmock work. TESTS += test/gmock_link_test check_PROGRAMS += test/gmock_link_test test_gmock_link_test_SOURCES = \ test/gmock_link2_test.cc \ test/gmock_link_test.cc \ test/gmock_link_test.h test_gmock_link_test_LDADD = $(GTEST_LIBS) lib/libgmock_main.la lib/libgmock.la if HAVE_PYTHON # Tests that fused gmock files compile and work. TESTS += test/gmock_fused_test check_PROGRAMS += test/gmock_fused_test test_gmock_fused_test_SOURCES = \ fused-src/gmock-gtest-all.cc \ fused-src/gmock/gmock.h \ fused-src/gmock_main.cc \ fused-src/gtest/gtest.h \ test/gmock_test.cc test_gmock_fused_test_CPPFLAGS = -I"$(srcdir)/fused-src" endif # Google Mock source files that we don't compile directly. GMOCK_SOURCE_INGLUDES = \ src/gmock-cardinalities.cc \ src/gmock-internal-utils.cc \ src/gmock-matchers.cc \ src/gmock-spec-builders.cc \ src/gmock.cc EXTRA_DIST += $(GMOCK_SOURCE_INGLUDES) # C++ tests that we don't compile using autotools. EXTRA_DIST += \ test/gmock-actions_test.cc \ test/gmock_all_test.cc \ test/gmock-cardinalities_test.cc \ test/gmock_ex_test.cc \ test/gmock-generated-actions_test.cc \ test/gmock-generated-function-mockers_test.cc \ test/gmock-generated-internal-utils_test.cc \ test/gmock-generated-matchers_test.cc \ test/gmock-internal-utils_test.cc \ test/gmock-matchers_test.cc \ test/gmock-more-actions_test.cc \ test/gmock-nice-strict_test.cc \ test/gmock-port_test.cc \ test/gmock_stress_test.cc # Python tests, which we don't run using autotools. EXTRA_DIST += \ test/gmock_leak_test.py \ test/gmock_leak_test_.cc \ test/gmock_output_test.py \ test/gmock_output_test_.cc \ test/gmock_output_test_golden.txt \ test/gmock_test_utils.py # Nonstandard package files for distribution. EXTRA_DIST += \ CHANGES \ CONTRIBUTORS \ make/Makefile # Pump scripts for generating Google Mock headers. # TODO(chandlerc@google.com): automate the generation of *.h from *.h.pump. EXTRA_DIST += \ include/gmock/gmock-generated-actions.h.pump \ include/gmock/gmock-generated-function-mockers.h.pump \ include/gmock/gmock-generated-matchers.h.pump \ include/gmock/gmock-generated-nice-strict.h.pump \ include/gmock/internal/gmock-generated-internal-utils.h.pump \ include/gmock/internal/custom/gmock-generated-actions.h.pump # Script for fusing Google Mock and Google Test source files. EXTRA_DIST += scripts/fuse_gmock_files.py # The Google Mock Generator tool from the cppclean project. EXTRA_DIST += \ scripts/generator/LICENSE \ scripts/generator/README \ scripts/generator/README.cppclean \ scripts/generator/cpp/__init__.py \ scripts/generator/cpp/ast.py \ scripts/generator/cpp/gmock_class.py \ scripts/generator/cpp/keywords.py \ scripts/generator/cpp/tokenize.py \ scripts/generator/cpp/utils.py \ scripts/generator/gmock_gen.py # Script for diagnosing compiler errors in programs that use Google # Mock. EXTRA_DIST += scripts/gmock_doctor.py # CMake scripts. EXTRA_DIST += \ CMakeLists.txt # Microsoft Visual Studio 2005 projects. EXTRA_DIST += \ msvc/2005/gmock.sln \ msvc/2005/gmock.vcproj \ msvc/2005/gmock_config.vsprops \ msvc/2005/gmock_main.vcproj \ msvc/2005/gmock_test.vcproj # Microsoft Visual Studio 2010 projects. EXTRA_DIST += \ msvc/2010/gmock.sln \ msvc/2010/gmock.vcxproj \ msvc/2010/gmock_config.props \ msvc/2010/gmock_main.vcxproj \ msvc/2010/gmock_test.vcxproj if HAVE_PYTHON # gmock_test.cc does not really depend on files generated by the # fused-gmock-internal rule. However, gmock_test.o does, and it is # important to include test/gmock_test.cc as part of this rule in order to # prevent compiling gmock_test.o until all dependent files have been # generated. $(test_gmock_fused_test_SOURCES): fused-gmock-internal # TODO(vladl@google.com): Find a way to add Google Tests's sources here. fused-gmock-internal: $(pkginclude_HEADERS) $(pkginclude_internal_HEADERS) \ $(lib_libgmock_la_SOURCES) $(GMOCK_SOURCE_INGLUDES) \ $(lib_libgmock_main_la_SOURCES) \ scripts/fuse_gmock_files.py mkdir -p "$(srcdir)/fused-src" chmod -R u+w "$(srcdir)/fused-src" rm -f "$(srcdir)/fused-src/gtest/gtest.h" rm -f "$(srcdir)/fused-src/gmock/gmock.h" rm -f "$(srcdir)/fused-src/gmock-gtest-all.cc" "$(srcdir)/scripts/fuse_gmock_files.py" "$(srcdir)/fused-src" cp -f "$(srcdir)/src/gmock_main.cc" "$(srcdir)/fused-src" maintainer-clean-local: rm -rf "$(srcdir)/fused-src" endif # Death tests may produce core dumps in the build directory. In case # this happens, clean them to keep distcleancheck happy. CLEANFILES = core # Disables 'make install' as installing a compiled version of Google # Mock can lead to undefined behavior due to violation of the # One-Definition Rule. install-exec-local: echo "'make install' is dangerous and not supported. Instead, see README for how to integrate Google Mock into your build system." false install-data-local: echo "'make install' is dangerous and not supported. Instead, see README for how to integrate Google Mock into your build system." false vendor/googletest/gtest-1.7.0/googlemock/README.md000066400000000000000000000305741300002025200217140ustar00rootroot00000000000000## Google Mock ## The Google C++ mocking framework. ### Overview ### Google's framework for writing and using C++ mock classes. It can help you derive better designs of your system and write better tests. It is inspired by: * [jMock](http://www.jmock.org/), * [EasyMock](http://www.easymock.org/), and * [Hamcrest](http://code.google.com/p/hamcrest/), and designed with C++'s specifics in mind. Google mock: * lets you create mock classes trivially using simple macros. * supports a rich set of matchers and actions. * handles unordered, partially ordered, or completely ordered expectations. * is extensible by users. We hope you find it useful! ### Features ### * Provides a declarative syntax for defining mocks. * Can easily define partial (hybrid) mocks, which are a cross of real and mock objects. * Handles functions of arbitrary types and overloaded functions. * Comes with a rich set of matchers for validating function arguments. * Uses an intuitive syntax for controlling the behavior of a mock. * Does automatic verification of expectations (no record-and-replay needed). * Allows arbitrary (partial) ordering constraints on function calls to be expressed,. * Lets a user extend it by defining new matchers and actions. * Does not use exceptions. * Is easy to learn and use. Please see the project page above for more information as well as the mailing list for questions, discussions, and development. There is also an IRC channel on OFTC (irc.oftc.net) #gtest available. Please join us! Please note that code under [scripts/generator](scripts/generator/) is from [cppclean](http://code.google.com/p/cppclean/) and released under the Apache License, which is different from Google Mock's license. ## Getting Started ## If you are new to the project, we suggest that you read the user documentation in the following order: * Learn the [basics](../googletest/docs/Primer.md) of Google Test, if you choose to use Google Mock with it (recommended). * Read [Google Mock for Dummies](docs/ForDummies.md). * Read the instructions below on how to build Google Mock. You can also watch Zhanyong's [talk](http://www.youtube.com/watch?v=sYpCyLI47rM) on Google Mock's usage and implementation. Once you understand the basics, check out the rest of the docs: * [CheatSheet](docs/CheatSheet.md) - all the commonly used stuff at a glance. * [CookBook](docs/CookBook.md) - recipes for getting things done, including advanced techniques. If you need help, please check the [KnownIssues](docs/KnownIssues.md) and [FrequentlyAskedQuestions](docs/FrequentlyAskedQuestions.md) before posting a question on the [discussion group](http://groups.google.com/group/googlemock). ### Using Google Mock Without Google Test ### Google Mock is not a testing framework itself. Instead, it needs a testing framework for writing tests. Google Mock works seamlessly with [Google Test](http://code.google.com/p/googletest/), but you can also use it with [any C++ testing framework](googlemock/ForDummies.md#Using_Google_Mock_with_Any_Testing_Framework). ### Requirements for End Users ### Google Mock is implemented on top of [Google Test]( http://github.com/google/googletest/), and depends on it. You must use the bundled version of Google Test when using Google Mock. You can also easily configure Google Mock to work with another testing framework, although it will still need Google Test. Please read ["Using_Google_Mock_with_Any_Testing_Framework"]( docs/ForDummies.md#Using_Google_Mock_with_Any_Testing_Framework) for instructions. Google Mock depends on advanced C++ features and thus requires a more modern compiler. The following are needed to use Google Mock: #### Linux Requirements #### * GNU-compatible Make or "gmake" * POSIX-standard shell * POSIX(-2) Regular Expressions (regex.h) * C++98-standard-compliant compiler (e.g. GCC 3.4 or newer) #### Windows Requirements #### * Microsoft Visual C++ 8.0 SP1 or newer #### Mac OS X Requirements #### * Mac OS X 10.4 Tiger or newer * Developer Tools Installed ### Requirements for Contributors ### We welcome patches. If you plan to contribute a patch, you need to build Google Mock and its tests, which has further requirements: * Automake version 1.9 or newer * Autoconf version 2.59 or newer * Libtool / Libtoolize * Python version 2.3 or newer (for running some of the tests and re-generating certain source files from templates) ### Building Google Mock ### #### Preparing to Build (Unix only) #### If you are using a Unix system and plan to use the GNU Autotools build system to build Google Mock (described below), you'll need to configure it now. To prepare the Autotools build system: cd googlemock autoreconf -fvi To build Google Mock and your tests that use it, you need to tell your build system where to find its headers and source files. The exact way to do it depends on which build system you use, and is usually straightforward. This section shows how you can integrate Google Mock into your existing build system. Suppose you put Google Mock in directory `${GMOCK_DIR}` and Google Test in `${GTEST_DIR}` (the latter is `${GMOCK_DIR}/gtest` by default). To build Google Mock, create a library build target (or a project as called by Visual Studio and Xcode) to compile ${GTEST_DIR}/src/gtest-all.cc and ${GMOCK_DIR}/src/gmock-all.cc with ${GTEST_DIR}/include and ${GMOCK_DIR}/include in the system header search path, and ${GTEST_DIR} and ${GMOCK_DIR} in the normal header search path. Assuming a Linux-like system and gcc, something like the following will do: g++ -isystem ${GTEST_DIR}/include -I${GTEST_DIR} \ -isystem ${GMOCK_DIR}/include -I${GMOCK_DIR} \ -pthread -c ${GTEST_DIR}/src/gtest-all.cc g++ -isystem ${GTEST_DIR}/include -I${GTEST_DIR} \ -isystem ${GMOCK_DIR}/include -I${GMOCK_DIR} \ -pthread -c ${GMOCK_DIR}/src/gmock-all.cc ar -rv libgmock.a gtest-all.o gmock-all.o (We need -pthread as Google Test and Google Mock use threads.) Next, you should compile your test source file with ${GTEST\_DIR}/include and ${GMOCK\_DIR}/include in the header search path, and link it with gmock and any other necessary libraries: g++ -isystem ${GTEST_DIR}/include -isystem ${GMOCK_DIR}/include \ -pthread path/to/your_test.cc libgmock.a -o your_test As an example, the make/ directory contains a Makefile that you can use to build Google Mock on systems where GNU make is available (e.g. Linux, Mac OS X, and Cygwin). It doesn't try to build Google Mock's own tests. Instead, it just builds the Google Mock library and a sample test. You can use it as a starting point for your own build script. If the default settings are correct for your environment, the following commands should succeed: cd ${GMOCK_DIR}/make make ./gmock_test If you see errors, try to tweak the contents of [make/Makefile](make/Makefile) to make them go away. ### Windows ### The msvc/2005 directory contains VC++ 2005 projects and the msvc/2010 directory contains VC++ 2010 projects for building Google Mock and selected tests. Change to the appropriate directory and run "msbuild gmock.sln" to build the library and tests (or open the gmock.sln in the MSVC IDE). If you want to create your own project to use with Google Mock, you'll have to configure it to use the `gmock_config` propety sheet. For that: * Open the Property Manager window (View | Other Windows | Property Manager) * Right-click on your project and select "Add Existing Property Sheet..." * Navigate to `gmock_config.vsprops` or `gmock_config.props` and select it. * In Project Properties | Configuration Properties | General | Additional Include Directories, type /include. ### Tweaking Google Mock ### Google Mock can be used in diverse environments. The default configuration may not work (or may not work well) out of the box in some environments. However, you can easily tweak Google Mock by defining control macros on the compiler command line. Generally, these macros are named like `GTEST_XYZ` and you define them to either 1 or 0 to enable or disable a certain feature. We list the most frequently used macros below. For a complete list, see file [${GTEST\_DIR}/include/gtest/internal/gtest-port.h]( ../googletest/include/gtest/internal/gtest-port.h). ### Choosing a TR1 Tuple Library ### Google Mock uses the C++ Technical Report 1 (TR1) tuple library heavily. Unfortunately TR1 tuple is not yet widely available with all compilers. The good news is that Google Test 1.4.0+ implements a subset of TR1 tuple that's enough for Google Mock's need. Google Mock will automatically use that implementation when the compiler doesn't provide TR1 tuple. Usually you don't need to care about which tuple library Google Test and Google Mock use. However, if your project already uses TR1 tuple, you need to tell Google Test and Google Mock to use the same TR1 tuple library the rest of your project uses, or the two tuple implementations will clash. To do that, add -DGTEST_USE_OWN_TR1_TUPLE=0 to the compiler flags while compiling Google Test, Google Mock, and your tests. If you want to force Google Test and Google Mock to use their own tuple library, just add -DGTEST_USE_OWN_TR1_TUPLE=1 to the compiler flags instead. If you want to use Boost's TR1 tuple library with Google Mock, please refer to the Boost website (http://www.boost.org/) for how to obtain it and set it up. ### As a Shared Library (DLL) ### Google Mock is compact, so most users can build and link it as a static library for the simplicity. Google Mock can be used as a DLL, but the same DLL must contain Google Test as well. See [Google Test's README][gtest_readme] for instructions on how to set up necessary compiler settings. ### Tweaking Google Mock ### Most of Google Test's control macros apply to Google Mock as well. Please see [Google Test's README][gtest_readme] for how to tweak them. ### Upgrading from an Earlier Version ### We strive to keep Google Mock releases backward compatible. Sometimes, though, we have to make some breaking changes for the users' long-term benefits. This section describes what you'll need to do if you are upgrading from an earlier version of Google Mock. #### Upgrading from 1.1.0 or Earlier #### You may need to explicitly enable or disable Google Test's own TR1 tuple library. See the instructions in section "[Choosing a TR1 Tuple Library](../googletest/#choosing-a-tr1-tuple-library)". #### Upgrading from 1.4.0 or Earlier #### On platforms where the pthread library is available, Google Test and Google Mock use it in order to be thread-safe. For this to work, you may need to tweak your compiler and/or linker flags. Please see the "[Multi-threaded Tests](../googletest#multi-threaded-tests )" section in file Google Test's README for what you may need to do. If you have custom matchers defined using `MatcherInterface` or `MakePolymorphicMatcher()`, you'll need to update their definitions to use the new matcher API ( [monomorphic](http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Monomorphic_Matchers), [polymorphic](http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Polymorphic_Matchers)). Matchers defined using `MATCHER()` or `MATCHER_P*()` aren't affected. ### Developing Google Mock ### This section discusses how to make your own changes to Google Mock. #### Testing Google Mock Itself #### To make sure your changes work as intended and don't break existing functionality, you'll want to compile and run Google Test's own tests. For that you'll need Autotools. First, make sure you have followed the instructions above to configure Google Mock. Then, create a build output directory and enter it. Next, ${GMOCK_DIR}/configure # try --help for more info Once you have successfully configured Google Mock, the build steps are standard for GNU-style OSS packages. make # Standard makefile following GNU conventions make check # Builds and runs all tests - all should pass. Note that when building your project against Google Mock, you are building against Google Test as well. There is no need to configure Google Test separately. #### Contributing a Patch #### We welcome patches. Please read the [Developer's Guide](docs/DevGuide.md) for how you can contribute. In particular, make sure you have signed the Contributor License Agreement, or we won't be able to accept the patch. Happy testing! [gtest_readme]: ../googletest/README.md "googletest" vendor/googletest/gtest-1.7.0/googlemock/build-aux/000077500000000000000000000000001300002025200223165ustar00rootroot00000000000000vendor/googletest/gtest-1.7.0/googlemock/build-aux/.keep000066400000000000000000000000001300002025200232310ustar00rootroot00000000000000vendor/googletest/gtest-1.7.0/googlemock/configure.ac000066400000000000000000000142261300002025200227170ustar00rootroot00000000000000m4_include(../googletest/m4/acx_pthread.m4) AC_INIT([Google C++ Mocking Framework], [1.7.0], [googlemock@googlegroups.com], [gmock]) # Provide various options to initialize the Autoconf and configure processes. AC_PREREQ([2.59]) AC_CONFIG_SRCDIR([./LICENSE]) AC_CONFIG_AUX_DIR([build-aux]) AC_CONFIG_HEADERS([build-aux/config.h]) AC_CONFIG_FILES([Makefile]) AC_CONFIG_FILES([scripts/gmock-config], [chmod +x scripts/gmock-config]) # Initialize Automake with various options. We require at least v1.9, prevent # pedantic complaints about package files, and enable various distribution # targets. AM_INIT_AUTOMAKE([1.9 dist-bzip2 dist-zip foreign subdir-objects]) # Check for programs used in building Google Test. AC_PROG_CC AC_PROG_CXX AC_LANG([C++]) AC_PROG_LIBTOOL # TODO(chandlerc@google.com): Currently we aren't running the Python tests # against the interpreter detected by AM_PATH_PYTHON, and so we condition # HAVE_PYTHON by requiring "python" to be in the PATH, and that interpreter's # version to be >= 2.3. This will allow the scripts to use a "/usr/bin/env" # hashbang. PYTHON= # We *do not* allow the user to specify a python interpreter AC_PATH_PROG([PYTHON],[python],[:]) AS_IF([test "$PYTHON" != ":"], [AM_PYTHON_CHECK_VERSION([$PYTHON],[2.3],[:],[PYTHON=":"])]) AM_CONDITIONAL([HAVE_PYTHON],[test "$PYTHON" != ":"]) # TODO(chandlerc@google.com) Check for the necessary system headers. # Configure pthreads. AC_ARG_WITH([pthreads], [AS_HELP_STRING([--with-pthreads], [use pthreads (default is yes)])], [with_pthreads=$withval], [with_pthreads=check]) have_pthreads=no AS_IF([test "x$with_pthreads" != "xno"], [ACX_PTHREAD( [], [AS_IF([test "x$with_pthreads" != "xcheck"], [AC_MSG_FAILURE( [--with-pthreads was specified, but unable to be used])])]) have_pthreads="$acx_pthread_ok"]) AM_CONDITIONAL([HAVE_PTHREADS],[test "x$have_pthreads" == "xyes"]) AC_SUBST(PTHREAD_CFLAGS) AC_SUBST(PTHREAD_LIBS) # GoogleMock currently has hard dependencies upon GoogleTest above and beyond # running its own test suite, so we both provide our own version in # a subdirectory and provide some logic to use a custom version or a system # installed version. AC_ARG_WITH([gtest], [AS_HELP_STRING([--with-gtest], [Specifies how to find the gtest package. If no arguments are given, the default behavior, a system installed gtest will be used if present, and an internal version built otherwise. If a path is provided, the gtest built or installed at that prefix will be used.])], [], [with_gtest=yes]) AC_ARG_ENABLE([external-gtest], [AS_HELP_STRING([--disable-external-gtest], [Disables any detection or use of a system installed or user provided gtest. Any option to '--with-gtest' is ignored. (Default is enabled.)]) ], [], [enable_external_gtest=yes]) AS_IF([test "x$with_gtest" == "xno"], [AC_MSG_ERROR([dnl Support for GoogleTest was explicitly disabled. Currently GoogleMock has a hard dependency upon GoogleTest to build, please provide a version, or allow GoogleMock to use any installed version and fall back upon its internal version.])]) # Setup various GTEST variables. TODO(chandlerc@google.com): When these are # used below, they should be used such that any pre-existing values always # trump values we set them to, so that they can be used to selectively override # details of the detection process. AC_ARG_VAR([GTEST_CONFIG], [The exact path of Google Test's 'gtest-config' script.]) AC_ARG_VAR([GTEST_CPPFLAGS], [C-like preprocessor flags for Google Test.]) AC_ARG_VAR([GTEST_CXXFLAGS], [C++ compile flags for Google Test.]) AC_ARG_VAR([GTEST_LDFLAGS], [Linker path and option flags for Google Test.]) AC_ARG_VAR([GTEST_LIBS], [Library linking flags for Google Test.]) AC_ARG_VAR([GTEST_VERSION], [The version of Google Test available.]) HAVE_BUILT_GTEST="no" GTEST_MIN_VERSION="1.7.0" AS_IF([test "x${enable_external_gtest}" = "xyes"], [# Begin filling in variables as we are able. AS_IF([test "x${with_gtest}" != "xyes"], [AS_IF([test -x "${with_gtest}/scripts/gtest-config"], [GTEST_CONFIG="${with_gtest}/scripts/gtest-config"], [GTEST_CONFIG="${with_gtest}/bin/gtest-config"]) AS_IF([test -x "${GTEST_CONFIG}"], [], [AC_MSG_ERROR([dnl Unable to locate either a built or installed Google Test at '${with_gtest}'.]) ])]) AS_IF([test -x "${GTEST_CONFIG}"], [], [AC_PATH_PROG([GTEST_CONFIG], [gtest-config])]) AS_IF([test -x "${GTEST_CONFIG}"], [AC_MSG_CHECKING([for Google Test version >= ${GTEST_MIN_VERSION}]) AS_IF([${GTEST_CONFIG} --min-version=${GTEST_MIN_VERSION}], [AC_MSG_RESULT([yes]) HAVE_BUILT_GTEST="yes"], [AC_MSG_RESULT([no])])])]) AS_IF([test "x${HAVE_BUILT_GTEST}" = "xyes"], [GTEST_CPPFLAGS=`${GTEST_CONFIG} --cppflags` GTEST_CXXFLAGS=`${GTEST_CONFIG} --cxxflags` GTEST_LDFLAGS=`${GTEST_CONFIG} --ldflags` GTEST_LIBS=`${GTEST_CONFIG} --libs` GTEST_VERSION=`${GTEST_CONFIG} --version`], [AC_CONFIG_SUBDIRS([../googletest]) # GTEST_CONFIG needs to be executable both in a Makefile environmont and # in a shell script environment, so resolve an absolute path for it here. GTEST_CONFIG="`pwd -P`/../googletest/scripts/gtest-config" GTEST_CPPFLAGS='-I$(top_srcdir)/../googletest/include' GTEST_CXXFLAGS='-g' GTEST_LDFLAGS='' GTEST_LIBS='$(top_builddir)/../googletest/lib/libgtest.la' GTEST_VERSION="${GTEST_MIN_VERSION}"]) # TODO(chandlerc@google.com) Check the types, structures, and other compiler # and architecture characteristics. # Output the generated files. No further autoconf macros may be used. AC_OUTPUT vendor/googletest/gtest-1.7.0/googlemock/docs/000077500000000000000000000000001300002025200213545ustar00rootroot00000000000000vendor/googletest/gtest-1.7.0/googlemock/docs/CheatSheet.md000066400000000000000000000670061300002025200237240ustar00rootroot00000000000000 # Defining a Mock Class # ## Mocking a Normal Class ## Given ``` class Foo { ... virtual ~Foo(); virtual int GetSize() const = 0; virtual string Describe(const char* name) = 0; virtual string Describe(int type) = 0; virtual bool Process(Bar elem, int count) = 0; }; ``` (note that `~Foo()` **must** be virtual) we can define its mock as ``` #include "gmock/gmock.h" class MockFoo : public Foo { MOCK_CONST_METHOD0(GetSize, int()); MOCK_METHOD1(Describe, string(const char* name)); MOCK_METHOD1(Describe, string(int type)); MOCK_METHOD2(Process, bool(Bar elem, int count)); }; ``` To create a "nice" mock object which ignores all uninteresting calls, or a "strict" mock object, which treats them as failures: ``` NiceMock nice_foo; // The type is a subclass of MockFoo. StrictMock strict_foo; // The type is a subclass of MockFoo. ``` ## Mocking a Class Template ## To mock ``` template class StackInterface { public: ... virtual ~StackInterface(); virtual int GetSize() const = 0; virtual void Push(const Elem& x) = 0; }; ``` (note that `~StackInterface()` **must** be virtual) just append `_T` to the `MOCK_*` macros: ``` template class MockStack : public StackInterface { public: ... MOCK_CONST_METHOD0_T(GetSize, int()); MOCK_METHOD1_T(Push, void(const Elem& x)); }; ``` ## Specifying Calling Conventions for Mock Functions ## If your mock function doesn't use the default calling convention, you can specify it by appending `_WITH_CALLTYPE` to any of the macros described in the previous two sections and supplying the calling convention as the first argument to the macro. For example, ``` MOCK_METHOD_1_WITH_CALLTYPE(STDMETHODCALLTYPE, Foo, bool(int n)); MOCK_CONST_METHOD2_WITH_CALLTYPE(STDMETHODCALLTYPE, Bar, int(double x, double y)); ``` where `STDMETHODCALLTYPE` is defined by `` on Windows. # Using Mocks in Tests # The typical flow is: 1. Import the Google Mock names you need to use. All Google Mock names are in the `testing` namespace unless they are macros or otherwise noted. 1. Create the mock objects. 1. Optionally, set the default actions of the mock objects. 1. Set your expectations on the mock objects (How will they be called? What wil they do?). 1. Exercise code that uses the mock objects; if necessary, check the result using [Google Test](../../googletest/) assertions. 1. When a mock objects is destructed, Google Mock automatically verifies that all expectations on it have been satisfied. Here is an example: ``` using ::testing::Return; // #1 TEST(BarTest, DoesThis) { MockFoo foo; // #2 ON_CALL(foo, GetSize()) // #3 .WillByDefault(Return(1)); // ... other default actions ... EXPECT_CALL(foo, Describe(5)) // #4 .Times(3) .WillRepeatedly(Return("Category 5")); // ... other expectations ... EXPECT_EQ("good", MyProductionFunction(&foo)); // #5 } // #6 ``` # Setting Default Actions # Google Mock has a **built-in default action** for any function that returns `void`, `bool`, a numeric value, or a pointer. To customize the default action for functions with return type `T` globally: ``` using ::testing::DefaultValue; // Sets the default value to be returned. T must be CopyConstructible. DefaultValue::Set(value); // Sets a factory. Will be invoked on demand. T must be MoveConstructible. // T MakeT(); DefaultValue::SetFactory(&MakeT); // ... use the mocks ... // Resets the default value. DefaultValue::Clear(); ``` To customize the default action for a particular method, use `ON_CALL()`: ``` ON_CALL(mock_object, method(matchers)) .With(multi_argument_matcher) ? .WillByDefault(action); ``` # Setting Expectations # `EXPECT_CALL()` sets **expectations** on a mock method (How will it be called? What will it do?): ``` EXPECT_CALL(mock_object, method(matchers)) .With(multi_argument_matcher) ? .Times(cardinality) ? .InSequence(sequences) * .After(expectations) * .WillOnce(action) * .WillRepeatedly(action) ? .RetiresOnSaturation(); ? ``` If `Times()` is omitted, the cardinality is assumed to be: * `Times(1)` when there is neither `WillOnce()` nor `WillRepeatedly()`; * `Times(n)` when there are `n WillOnce()`s but no `WillRepeatedly()`, where `n` >= 1; or * `Times(AtLeast(n))` when there are `n WillOnce()`s and a `WillRepeatedly()`, where `n` >= 0. A method with no `EXPECT_CALL()` is free to be invoked _any number of times_, and the default action will be taken each time. # Matchers # A **matcher** matches a _single_ argument. You can use it inside `ON_CALL()` or `EXPECT_CALL()`, or use it to validate a value directly: | `EXPECT_THAT(value, matcher)` | Asserts that `value` matches `matcher`. | |:------------------------------|:----------------------------------------| | `ASSERT_THAT(value, matcher)` | The same as `EXPECT_THAT(value, matcher)`, except that it generates a **fatal** failure. | Built-in matchers (where `argument` is the function argument) are divided into several categories: ## Wildcard ## |`_`|`argument` can be any value of the correct type.| |:--|:-----------------------------------------------| |`A()` or `An()`|`argument` can be any value of type `type`. | ## Generic Comparison ## |`Eq(value)` or `value`|`argument == value`| |:---------------------|:------------------| |`Ge(value)` |`argument >= value`| |`Gt(value)` |`argument > value` | |`Le(value)` |`argument <= value`| |`Lt(value)` |`argument < value` | |`Ne(value)` |`argument != value`| |`IsNull()` |`argument` is a `NULL` pointer (raw or smart).| |`NotNull()` |`argument` is a non-null pointer (raw or smart).| |`Ref(variable)` |`argument` is a reference to `variable`.| |`TypedEq(value)`|`argument` has type `type` and is equal to `value`. You may need to use this instead of `Eq(value)` when the mock function is overloaded.| Except `Ref()`, these matchers make a _copy_ of `value` in case it's modified or destructed later. If the compiler complains that `value` doesn't have a public copy constructor, try wrap it in `ByRef()`, e.g. `Eq(ByRef(non_copyable_value))`. If you do that, make sure `non_copyable_value` is not changed afterwards, or the meaning of your matcher will be changed. ## Floating-Point Matchers ## |`DoubleEq(a_double)`|`argument` is a `double` value approximately equal to `a_double`, treating two NaNs as unequal.| |:-------------------|:----------------------------------------------------------------------------------------------| |`FloatEq(a_float)` |`argument` is a `float` value approximately equal to `a_float`, treating two NaNs as unequal. | |`NanSensitiveDoubleEq(a_double)`|`argument` is a `double` value approximately equal to `a_double`, treating two NaNs as equal. | |`NanSensitiveFloatEq(a_float)`|`argument` is a `float` value approximately equal to `a_float`, treating two NaNs as equal. | The above matchers use ULP-based comparison (the same as used in [Google Test](../../googletest/)). They automatically pick a reasonable error bound based on the absolute value of the expected value. `DoubleEq()` and `FloatEq()` conform to the IEEE standard, which requires comparing two NaNs for equality to return false. The `NanSensitive*` version instead treats two NaNs as equal, which is often what a user wants. |`DoubleNear(a_double, max_abs_error)`|`argument` is a `double` value close to `a_double` (absolute error <= `max_abs_error`), treating two NaNs as unequal.| |:------------------------------------|:--------------------------------------------------------------------------------------------------------------------| |`FloatNear(a_float, max_abs_error)` |`argument` is a `float` value close to `a_float` (absolute error <= `max_abs_error`), treating two NaNs as unequal. | |`NanSensitiveDoubleNear(a_double, max_abs_error)`|`argument` is a `double` value close to `a_double` (absolute error <= `max_abs_error`), treating two NaNs as equal. | |`NanSensitiveFloatNear(a_float, max_abs_error)`|`argument` is a `float` value close to `a_float` (absolute error <= `max_abs_error`), treating two NaNs as equal. | ## String Matchers ## The `argument` can be either a C string or a C++ string object: |`ContainsRegex(string)`|`argument` matches the given regular expression.| |:----------------------|:-----------------------------------------------| |`EndsWith(suffix)` |`argument` ends with string `suffix`. | |`HasSubstr(string)` |`argument` contains `string` as a sub-string. | |`MatchesRegex(string)` |`argument` matches the given regular expression with the match starting at the first character and ending at the last character.| |`StartsWith(prefix)` |`argument` starts with string `prefix`. | |`StrCaseEq(string)` |`argument` is equal to `string`, ignoring case. | |`StrCaseNe(string)` |`argument` is not equal to `string`, ignoring case.| |`StrEq(string)` |`argument` is equal to `string`. | |`StrNe(string)` |`argument` is not equal to `string`. | `ContainsRegex()` and `MatchesRegex()` use the regular expression syntax defined [here](../../googletest/docs/AdvancedGuide.md#regular-expression-syntax). `StrCaseEq()`, `StrCaseNe()`, `StrEq()`, and `StrNe()` work for wide strings as well. ## Container Matchers ## Most STL-style containers support `==`, so you can use `Eq(expected_container)` or simply `expected_container` to match a container exactly. If you want to write the elements in-line, match them more flexibly, or get more informative messages, you can use: | `ContainerEq(container)` | The same as `Eq(container)` except that the failure message also includes which elements are in one container but not the other. | |:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------| | `Contains(e)` | `argument` contains an element that matches `e`, which can be either a value or a matcher. | | `Each(e)` | `argument` is a container where _every_ element matches `e`, which can be either a value or a matcher. | | `ElementsAre(e0, e1, ..., en)` | `argument` has `n + 1` elements, where the i-th element matches `ei`, which can be a value or a matcher. 0 to 10 arguments are allowed. | | `ElementsAreArray({ e0, e1, ..., en })`, `ElementsAreArray(array)`, or `ElementsAreArray(array, count)` | The same as `ElementsAre()` except that the expected element values/matchers come from an initializer list, STL-style container, or C-style array. | | `IsEmpty()` | `argument` is an empty container (`container.empty()`). | | `Pointwise(m, container)` | `argument` contains the same number of elements as in `container`, and for all i, (the i-th element in `argument`, the i-th element in `container`) match `m`, which is a matcher on 2-tuples. E.g. `Pointwise(Le(), upper_bounds)` verifies that each element in `argument` doesn't exceed the corresponding element in `upper_bounds`. See more detail below. | | `SizeIs(m)` | `argument` is a container whose size matches `m`. E.g. `SizeIs(2)` or `SizeIs(Lt(2))`. | | `UnorderedElementsAre(e0, e1, ..., en)` | `argument` has `n + 1` elements, and under some permutation each element matches an `ei` (for a different `i`), which can be a value or a matcher. 0 to 10 arguments are allowed. | | `UnorderedElementsAreArray({ e0, e1, ..., en })`, `UnorderedElementsAreArray(array)`, or `UnorderedElementsAreArray(array, count)` | The same as `UnorderedElementsAre()` except that the expected element values/matchers come from an initializer list, STL-style container, or C-style array. | | `WhenSorted(m)` | When `argument` is sorted using the `<` operator, it matches container matcher `m`. E.g. `WhenSorted(UnorderedElementsAre(1, 2, 3))` verifies that `argument` contains elements `1`, `2`, and `3`, ignoring order. | | `WhenSortedBy(comparator, m)` | The same as `WhenSorted(m)`, except that the given comparator instead of `<` is used to sort `argument`. E.g. `WhenSortedBy(std::greater(), ElementsAre(3, 2, 1))`. | Notes: * These matchers can also match: 1. a native array passed by reference (e.g. in `Foo(const int (&a)[5])`), and 1. an array passed as a pointer and a count (e.g. in `Bar(const T* buffer, int len)` -- see [Multi-argument Matchers](#Multiargument_Matchers.md)). * The array being matched may be multi-dimensional (i.e. its elements can be arrays). * `m` in `Pointwise(m, ...)` should be a matcher for `::testing::tuple` where `T` and `U` are the element type of the actual container and the expected container, respectively. For example, to compare two `Foo` containers where `Foo` doesn't support `operator==` but has an `Equals()` method, one might write: ``` using ::testing::get; MATCHER(FooEq, "") { return get<0>(arg).Equals(get<1>(arg)); } ... EXPECT_THAT(actual_foos, Pointwise(FooEq(), expected_foos)); ``` ## Member Matchers ## |`Field(&class::field, m)`|`argument.field` (or `argument->field` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _class_.| |:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------| |`Key(e)` |`argument.first` matches `e`, which can be either a value or a matcher. E.g. `Contains(Key(Le(5)))` can verify that a `map` contains a key `<= 5`.| |`Pair(m1, m2)` |`argument` is an `std::pair` whose `first` field matches `m1` and `second` field matches `m2`. | |`Property(&class::property, m)`|`argument.property()` (or `argument->property()` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _class_.| ## Matching the Result of a Function or Functor ## |`ResultOf(f, m)`|`f(argument)` matches matcher `m`, where `f` is a function or functor.| |:---------------|:---------------------------------------------------------------------| ## Pointer Matchers ## |`Pointee(m)`|`argument` (either a smart pointer or a raw pointer) points to a value that matches matcher `m`.| |:-----------|:-----------------------------------------------------------------------------------------------| |`WhenDynamicCastTo(m)`| when `argument` is passed through `dynamic_cast()`, it matches matcher `m`. | ## Multiargument Matchers ## Technically, all matchers match a _single_ value. A "multi-argument" matcher is just one that matches a _tuple_. The following matchers can be used to match a tuple `(x, y)`: |`Eq()`|`x == y`| |:-----|:-------| |`Ge()`|`x >= y`| |`Gt()`|`x > y` | |`Le()`|`x <= y`| |`Lt()`|`x < y` | |`Ne()`|`x != y`| You can use the following selectors to pick a subset of the arguments (or reorder them) to participate in the matching: |`AllArgs(m)`|Equivalent to `m`. Useful as syntactic sugar in `.With(AllArgs(m))`.| |:-----------|:-------------------------------------------------------------------| |`Args(m)`|The tuple of the `k` selected (using 0-based indices) arguments matches `m`, e.g. `Args<1, 2>(Eq())`.| ## Composite Matchers ## You can make a matcher from one or more other matchers: |`AllOf(m1, m2, ..., mn)`|`argument` matches all of the matchers `m1` to `mn`.| |:-----------------------|:---------------------------------------------------| |`AnyOf(m1, m2, ..., mn)`|`argument` matches at least one of the matchers `m1` to `mn`.| |`Not(m)` |`argument` doesn't match matcher `m`. | ## Adapters for Matchers ## |`MatcherCast(m)`|casts matcher `m` to type `Matcher`.| |:------------------|:--------------------------------------| |`SafeMatcherCast(m)`| [safely casts](CookBook.md#casting-matchers) matcher `m` to type `Matcher`. | |`Truly(predicate)` |`predicate(argument)` returns something considered by C++ to be true, where `predicate` is a function or functor.| ## Matchers as Predicates ## |`Matches(m)(value)`|evaluates to `true` if `value` matches `m`. You can use `Matches(m)` alone as a unary functor.| |:------------------|:---------------------------------------------------------------------------------------------| |`ExplainMatchResult(m, value, result_listener)`|evaluates to `true` if `value` matches `m`, explaining the result to `result_listener`. | |`Value(value, m)` |evaluates to `true` if `value` matches `m`. | ## Defining Matchers ## | `MATCHER(IsEven, "") { return (arg % 2) == 0; }` | Defines a matcher `IsEven()` to match an even number. | |:-------------------------------------------------|:------------------------------------------------------| | `MATCHER_P(IsDivisibleBy, n, "") { *result_listener << "where the remainder is " << (arg % n); return (arg % n) == 0; }` | Defines a macher `IsDivisibleBy(n)` to match a number divisible by `n`. | | `MATCHER_P2(IsBetween, a, b, std::string(negation ? "isn't" : "is") + " between " + PrintToString(a) + " and " + PrintToString(b)) { return a <= arg && arg <= b; }` | Defines a matcher `IsBetween(a, b)` to match a value in the range [`a`, `b`]. | **Notes:** 1. The `MATCHER*` macros cannot be used inside a function or class. 1. The matcher body must be _purely functional_ (i.e. it cannot have any side effect, and the result must not depend on anything other than the value being matched and the matcher parameters). 1. You can use `PrintToString(x)` to convert a value `x` of any type to a string. ## Matchers as Test Assertions ## |`ASSERT_THAT(expression, m)`|Generates a [fatal failure](../../googletest/docs/Primer.md#assertions) if the value of `expression` doesn't match matcher `m`.| |:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------| |`EXPECT_THAT(expression, m)`|Generates a non-fatal failure if the value of `expression` doesn't match matcher `m`. | # Actions # **Actions** specify what a mock function should do when invoked. ## Returning a Value ## |`Return()`|Return from a `void` mock function.| |:---------|:----------------------------------| |`Return(value)`|Return `value`. If the type of `value` is different to the mock function's return type, `value` is converted to the latter type at the time the expectation is set, not when the action is executed.| |`ReturnArg()`|Return the `N`-th (0-based) argument.| |`ReturnNew(a1, ..., ak)`|Return `new T(a1, ..., ak)`; a different object is created each time.| |`ReturnNull()`|Return a null pointer. | |`ReturnPointee(ptr)`|Return the value pointed to by `ptr`.| |`ReturnRef(variable)`|Return a reference to `variable`. | |`ReturnRefOfCopy(value)`|Return a reference to a copy of `value`; the copy lives as long as the action.| ## Side Effects ## |`Assign(&variable, value)`|Assign `value` to variable.| |:-------------------------|:--------------------------| | `DeleteArg()` | Delete the `N`-th (0-based) argument, which must be a pointer. | | `SaveArg(pointer)` | Save the `N`-th (0-based) argument to `*pointer`. | | `SaveArgPointee(pointer)` | Save the value pointed to by the `N`-th (0-based) argument to `*pointer`. | | `SetArgReferee(value)` | Assign value to the variable referenced by the `N`-th (0-based) argument. | |`SetArgPointee(value)` |Assign `value` to the variable pointed by the `N`-th (0-based) argument.| |`SetArgumentPointee(value)`|Same as `SetArgPointee(value)`. Deprecated. Will be removed in v1.7.0.| |`SetArrayArgument(first, last)`|Copies the elements in source range [`first`, `last`) to the array pointed to by the `N`-th (0-based) argument, which can be either a pointer or an iterator. The action does not take ownership of the elements in the source range.| |`SetErrnoAndReturn(error, value)`|Set `errno` to `error` and return `value`.| |`Throw(exception)` |Throws the given exception, which can be any copyable value. Available since v1.1.0.| ## Using a Function or a Functor as an Action ## |`Invoke(f)`|Invoke `f` with the arguments passed to the mock function, where `f` can be a global/static function or a functor.| |:----------|:-----------------------------------------------------------------------------------------------------------------| |`Invoke(object_pointer, &class::method)`|Invoke the {method on the object with the arguments passed to the mock function. | |`InvokeWithoutArgs(f)`|Invoke `f`, which can be a global/static function or a functor. `f` must take no arguments. | |`InvokeWithoutArgs(object_pointer, &class::method)`|Invoke the method on the object, which takes no arguments. | |`InvokeArgument(arg1, arg2, ..., argk)`|Invoke the mock function's `N`-th (0-based) argument, which must be a function or a functor, with the `k` arguments.| The return value of the invoked function is used as the return value of the action. When defining a function or functor to be used with `Invoke*()`, you can declare any unused parameters as `Unused`: ``` double Distance(Unused, double x, double y) { return sqrt(x*x + y*y); } ... EXPECT_CALL(mock, Foo("Hi", _, _)).WillOnce(Invoke(Distance)); ``` In `InvokeArgument(...)`, if an argument needs to be passed by reference, wrap it inside `ByRef()`. For example, ``` InvokeArgument<2>(5, string("Hi"), ByRef(foo)) ``` calls the mock function's #2 argument, passing to it `5` and `string("Hi")` by value, and `foo` by reference. ## Default Action ## |`DoDefault()`|Do the default action (specified by `ON_CALL()` or the built-in one).| |:------------|:--------------------------------------------------------------------| **Note:** due to technical reasons, `DoDefault()` cannot be used inside a composite action - trying to do so will result in a run-time error. ## Composite Actions ## |`DoAll(a1, a2, ..., an)`|Do all actions `a1` to `an` and return the result of `an` in each invocation. The first `n - 1` sub-actions must return void. | |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------| |`IgnoreResult(a)` |Perform action `a` and ignore its result. `a` must not return void. | |`WithArg(a)` |Pass the `N`-th (0-based) argument of the mock function to action `a` and perform it. | |`WithArgs(a)`|Pass the selected (0-based) arguments of the mock function to action `a` and perform it. | |`WithoutArgs(a)` |Perform action `a` without any arguments. | ## Defining Actions ## | `ACTION(Sum) { return arg0 + arg1; }` | Defines an action `Sum()` to return the sum of the mock function's argument #0 and #1. | |:--------------------------------------|:---------------------------------------------------------------------------------------| | `ACTION_P(Plus, n) { return arg0 + n; }` | Defines an action `Plus(n)` to return the sum of the mock function's argument #0 and `n`. | | `ACTION_Pk(Foo, p1, ..., pk) { statements; }` | Defines a parameterized action `Foo(p1, ..., pk)` to execute the given `statements`. | The `ACTION*` macros cannot be used inside a function or class. # Cardinalities # These are used in `Times()` to specify how many times a mock function will be called: |`AnyNumber()`|The function can be called any number of times.| |:------------|:----------------------------------------------| |`AtLeast(n)` |The call is expected at least `n` times. | |`AtMost(n)` |The call is expected at most `n` times. | |`Between(m, n)`|The call is expected between `m` and `n` (inclusive) times.| |`Exactly(n) or n`|The call is expected exactly `n` times. In particular, the call should never happen when `n` is 0.| # Expectation Order # By default, the expectations can be matched in _any_ order. If some or all expectations must be matched in a given order, there are two ways to specify it. They can be used either independently or together. ## The After Clause ## ``` using ::testing::Expectation; ... Expectation init_x = EXPECT_CALL(foo, InitX()); Expectation init_y = EXPECT_CALL(foo, InitY()); EXPECT_CALL(foo, Bar()) .After(init_x, init_y); ``` says that `Bar()` can be called only after both `InitX()` and `InitY()` have been called. If you don't know how many pre-requisites an expectation has when you write it, you can use an `ExpectationSet` to collect them: ``` using ::testing::ExpectationSet; ... ExpectationSet all_inits; for (int i = 0; i < element_count; i++) { all_inits += EXPECT_CALL(foo, InitElement(i)); } EXPECT_CALL(foo, Bar()) .After(all_inits); ``` says that `Bar()` can be called only after all elements have been initialized (but we don't care about which elements get initialized before the others). Modifying an `ExpectationSet` after using it in an `.After()` doesn't affect the meaning of the `.After()`. ## Sequences ## When you have a long chain of sequential expectations, it's easier to specify the order using **sequences**, which don't require you to given each expectation in the chain a different name. All expected
calls in the same sequence must occur in the order they are specified. ``` using ::testing::Sequence; Sequence s1, s2; ... EXPECT_CALL(foo, Reset()) .InSequence(s1, s2) .WillOnce(Return(true)); EXPECT_CALL(foo, GetSize()) .InSequence(s1) .WillOnce(Return(1)); EXPECT_CALL(foo, Describe(A())) .InSequence(s2) .WillOnce(Return("dummy")); ``` says that `Reset()` must be called before _both_ `GetSize()` _and_ `Describe()`, and the latter two can occur in any order. To put many expectations in a sequence conveniently: ``` using ::testing::InSequence; { InSequence dummy; EXPECT_CALL(...)...; EXPECT_CALL(...)...; ... EXPECT_CALL(...)...; } ``` says that all expected calls in the scope of `dummy` must occur in strict order. The name `dummy` is irrelevant.) # Verifying and Resetting a Mock # Google Mock will verify the expectations on a mock object when it is destructed, or you can do it earlier: ``` using ::testing::Mock; ... // Verifies and removes the expectations on mock_obj; // returns true iff successful. Mock::VerifyAndClearExpectations(&mock_obj); ... // Verifies and removes the expectations on mock_obj; // also removes the default actions set by ON_CALL(); // returns true iff successful. Mock::VerifyAndClear(&mock_obj); ``` You can also tell Google Mock that a mock object can be leaked and doesn't need to be verified: ``` Mock::AllowLeak(&mock_obj); ``` # Mock Classes # Google Mock defines a convenient mock class template ``` class MockFunction { public: MOCK_METHODn(Call, R(A1, ..., An)); }; ``` See this [recipe](CookBook.md#using-check-points) for one application of it. # Flags # | `--gmock_catch_leaked_mocks=0` | Don't report leaked mock objects as failures. | |:-------------------------------|:----------------------------------------------| | `--gmock_verbose=LEVEL` | Sets the default verbosity level (`info`, `warning`, or `error`) of Google Mock messages. | vendor/googletest/gtest-1.7.0/googlemock/docs/CookBook.md000066400000000000000000003773601300002025200234240ustar00rootroot00000000000000 You can find recipes for using Google Mock here. If you haven't yet, please read the [ForDummies](ForDummies.md) document first to make sure you understand the basics. **Note:** Google Mock lives in the `testing` name space. For readability, it is recommended to write `using ::testing::Foo;` once in your file before using the name `Foo` defined by Google Mock. We omit such `using` statements in this page for brevity, but you should do it in your own code. # Creating Mock Classes # ## Mocking Private or Protected Methods ## You must always put a mock method definition (`MOCK_METHOD*`) in a `public:` section of the mock class, regardless of the method being mocked being `public`, `protected`, or `private` in the base class. This allows `ON_CALL` and `EXPECT_CALL` to reference the mock function from outside of the mock class. (Yes, C++ allows a subclass to change the access level of a virtual function in the base class.) Example: ``` class Foo { public: ... virtual bool Transform(Gadget* g) = 0; protected: virtual void Resume(); private: virtual int GetTimeOut(); }; class MockFoo : public Foo { public: ... MOCK_METHOD1(Transform, bool(Gadget* g)); // The following must be in the public section, even though the // methods are protected or private in the base class. MOCK_METHOD0(Resume, void()); MOCK_METHOD0(GetTimeOut, int()); }; ``` ## Mocking Overloaded Methods ## You can mock overloaded functions as usual. No special attention is required: ``` class Foo { ... // Must be virtual as we'll inherit from Foo. virtual ~Foo(); // Overloaded on the types and/or numbers of arguments. virtual int Add(Element x); virtual int Add(int times, Element x); // Overloaded on the const-ness of this object. virtual Bar& GetBar(); virtual const Bar& GetBar() const; }; class MockFoo : public Foo { ... MOCK_METHOD1(Add, int(Element x)); MOCK_METHOD2(Add, int(int times, Element x); MOCK_METHOD0(GetBar, Bar&()); MOCK_CONST_METHOD0(GetBar, const Bar&()); }; ``` **Note:** if you don't mock all versions of the overloaded method, the compiler will give you a warning about some methods in the base class being hidden. To fix that, use `using` to bring them in scope: ``` class MockFoo : public Foo { ... using Foo::Add; MOCK_METHOD1(Add, int(Element x)); // We don't want to mock int Add(int times, Element x); ... }; ``` ## Mocking Class Templates ## To mock a class template, append `_T` to the `MOCK_*` macros: ``` template class StackInterface { ... // Must be virtual as we'll inherit from StackInterface. virtual ~StackInterface(); virtual int GetSize() const = 0; virtual void Push(const Elem& x) = 0; }; template class MockStack : public StackInterface { ... MOCK_CONST_METHOD0_T(GetSize, int()); MOCK_METHOD1_T(Push, void(const Elem& x)); }; ``` ## Mocking Nonvirtual Methods ## Google Mock can mock non-virtual functions to be used in what we call _hi-perf dependency injection_. In this case, instead of sharing a common base class with the real class, your mock class will be _unrelated_ to the real class, but contain methods with the same signatures. The syntax for mocking non-virtual methods is the _same_ as mocking virtual methods: ``` // A simple packet stream class. None of its members is virtual. class ConcretePacketStream { public: void AppendPacket(Packet* new_packet); const Packet* GetPacket(size_t packet_number) const; size_t NumberOfPackets() const; ... }; // A mock packet stream class. It inherits from no other, but defines // GetPacket() and NumberOfPackets(). class MockPacketStream { public: MOCK_CONST_METHOD1(GetPacket, const Packet*(size_t packet_number)); MOCK_CONST_METHOD0(NumberOfPackets, size_t()); ... }; ``` Note that the mock class doesn't define `AppendPacket()`, unlike the real class. That's fine as long as the test doesn't need to call it. Next, you need a way to say that you want to use `ConcretePacketStream` in production code, and use `MockPacketStream` in tests. Since the functions are not virtual and the two classes are unrelated, you must specify your choice at _compile time_ (as opposed to run time). One way to do it is to templatize your code that needs to use a packet stream. More specifically, you will give your code a template type argument for the type of the packet stream. In production, you will instantiate your template with `ConcretePacketStream` as the type argument. In tests, you will instantiate the same template with `MockPacketStream`. For example, you may write: ``` template void CreateConnection(PacketStream* stream) { ... } template class PacketReader { public: void ReadPackets(PacketStream* stream, size_t packet_num); }; ``` Then you can use `CreateConnection()` and `PacketReader` in production code, and use `CreateConnection()` and `PacketReader` in tests. ``` MockPacketStream mock_stream; EXPECT_CALL(mock_stream, ...)...; .. set more expectations on mock_stream ... PacketReader reader(&mock_stream); ... exercise reader ... ``` ## Mocking Free Functions ## It's possible to use Google Mock to mock a free function (i.e. a C-style function or a static method). You just need to rewrite your code to use an interface (abstract class). Instead of calling a free function (say, `OpenFile`) directly, introduce an interface for it and have a concrete subclass that calls the free function: ``` class FileInterface { public: ... virtual bool Open(const char* path, const char* mode) = 0; }; class File : public FileInterface { public: ... virtual bool Open(const char* path, const char* mode) { return OpenFile(path, mode); } }; ``` Your code should talk to `FileInterface` to open a file. Now it's easy to mock out the function. This may seem much hassle, but in practice you often have multiple related functions that you can put in the same interface, so the per-function syntactic overhead will be much lower. If you are concerned about the performance overhead incurred by virtual functions, and profiling confirms your concern, you can combine this with the recipe for [mocking non-virtual methods](#Mocking_Nonvirtual_Methods.md). ## The Nice, the Strict, and the Naggy ## If a mock method has no `EXPECT_CALL` spec but is called, Google Mock will print a warning about the "uninteresting call". The rationale is: * New methods may be added to an interface after a test is written. We shouldn't fail a test just because a method it doesn't know about is called. * However, this may also mean there's a bug in the test, so Google Mock shouldn't be silent either. If the user believes these calls are harmless, he can add an `EXPECT_CALL()` to suppress the warning. However, sometimes you may want to suppress all "uninteresting call" warnings, while sometimes you may want the opposite, i.e. to treat all of them as errors. Google Mock lets you make the decision on a per-mock-object basis. Suppose your test uses a mock class `MockFoo`: ``` TEST(...) { MockFoo mock_foo; EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... } ``` If a method of `mock_foo` other than `DoThis()` is called, it will be reported by Google Mock as a warning. However, if you rewrite your test to use `NiceMock` instead, the warning will be gone, resulting in a cleaner test output: ``` using ::testing::NiceMock; TEST(...) { NiceMock mock_foo; EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... } ``` `NiceMock` is a subclass of `MockFoo`, so it can be used wherever `MockFoo` is accepted. It also works if `MockFoo`'s constructor takes some arguments, as `NiceMock` "inherits" `MockFoo`'s constructors: ``` using ::testing::NiceMock; TEST(...) { NiceMock mock_foo(5, "hi"); // Calls MockFoo(5, "hi"). EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... } ``` The usage of `StrictMock` is similar, except that it makes all uninteresting calls failures: ``` using ::testing::StrictMock; TEST(...) { StrictMock mock_foo; EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... // The test will fail if a method of mock_foo other than DoThis() // is called. } ``` There are some caveats though (I don't like them just as much as the next guy, but sadly they are side effects of C++'s limitations): 1. `NiceMock` and `StrictMock` only work for mock methods defined using the `MOCK_METHOD*` family of macros **directly** in the `MockFoo` class. If a mock method is defined in a **base class** of `MockFoo`, the "nice" or "strict" modifier may not affect it, depending on the compiler. In particular, nesting `NiceMock` and `StrictMock` (e.g. `NiceMock >`) is **not** supported. 1. The constructors of the base mock (`MockFoo`) cannot have arguments passed by non-const reference, which happens to be banned by the [Google C++ style guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml). 1. During the constructor or destructor of `MockFoo`, the mock object is _not_ nice or strict. This may cause surprises if the constructor or destructor calls a mock method on `this` object. (This behavior, however, is consistent with C++'s general rule: if a constructor or destructor calls a virtual method of `this` object, that method is treated as non-virtual. In other words, to the base class's constructor or destructor, `this` object behaves like an instance of the base class, not the derived class. This rule is required for safety. Otherwise a base constructor may use members of a derived class before they are initialized, or a base destructor may use members of a derived class after they have been destroyed.) Finally, you should be **very cautious** about when to use naggy or strict mocks, as they tend to make tests more brittle and harder to maintain. When you refactor your code without changing its externally visible behavior, ideally you should't need to update any tests. If your code interacts with a naggy mock, however, you may start to get spammed with warnings as the result of your change. Worse, if your code interacts with a strict mock, your tests may start to fail and you'll be forced to fix them. Our general recommendation is to use nice mocks (not yet the default) most of the time, use naggy mocks (the current default) when developing or debugging tests, and use strict mocks only as the last resort. ## Simplifying the Interface without Breaking Existing Code ## Sometimes a method has a long list of arguments that is mostly uninteresting. For example, ``` class LogSink { public: ... virtual void send(LogSeverity severity, const char* full_filename, const char* base_filename, int line, const struct tm* tm_time, const char* message, size_t message_len) = 0; }; ``` This method's argument list is lengthy and hard to work with (let's say that the `message` argument is not even 0-terminated). If we mock it as is, using the mock will be awkward. If, however, we try to simplify this interface, we'll need to fix all clients depending on it, which is often infeasible. The trick is to re-dispatch the method in the mock class: ``` class ScopedMockLog : public LogSink { public: ... virtual void send(LogSeverity severity, const char* full_filename, const char* base_filename, int line, const tm* tm_time, const char* message, size_t message_len) { // We are only interested in the log severity, full file name, and // log message. Log(severity, full_filename, std::string(message, message_len)); } // Implements the mock method: // // void Log(LogSeverity severity, // const string& file_path, // const string& message); MOCK_METHOD3(Log, void(LogSeverity severity, const string& file_path, const string& message)); }; ``` By defining a new mock method with a trimmed argument list, we make the mock class much more user-friendly. ## Alternative to Mocking Concrete Classes ## Often you may find yourself using classes that don't implement interfaces. In order to test your code that uses such a class (let's call it `Concrete`), you may be tempted to make the methods of `Concrete` virtual and then mock it. Try not to do that. Making a non-virtual function virtual is a big decision. It creates an extension point where subclasses can tweak your class' behavior. This weakens your control on the class because now it's harder to maintain the class' invariants. You should make a function virtual only when there is a valid reason for a subclass to override it. Mocking concrete classes directly is problematic as it creates a tight coupling between the class and the tests - any small change in the class may invalidate your tests and make test maintenance a pain. To avoid such problems, many programmers have been practicing "coding to interfaces": instead of talking to the `Concrete` class, your code would define an interface and talk to it. Then you implement that interface as an adaptor on top of `Concrete`. In tests, you can easily mock that interface to observe how your code is doing. This technique incurs some overhead: * You pay the cost of virtual function calls (usually not a problem). * There is more abstraction for the programmers to learn. However, it can also bring significant benefits in addition to better testability: * `Concrete`'s API may not fit your problem domain very well, as you may not be the only client it tries to serve. By designing your own interface, you have a chance to tailor it to your need - you may add higher-level functionalities, rename stuff, etc instead of just trimming the class. This allows you to write your code (user of the interface) in a more natural way, which means it will be more readable, more maintainable, and you'll be more productive. * If `Concrete`'s implementation ever has to change, you don't have to rewrite everywhere it is used. Instead, you can absorb the change in your implementation of the interface, and your other code and tests will be insulated from this change. Some people worry that if everyone is practicing this technique, they will end up writing lots of redundant code. This concern is totally understandable. However, there are two reasons why it may not be the case: * Different projects may need to use `Concrete` in different ways, so the best interfaces for them will be different. Therefore, each of them will have its own domain-specific interface on top of `Concrete`, and they will not be the same code. * If enough projects want to use the same interface, they can always share it, just like they have been sharing `Concrete`. You can check in the interface and the adaptor somewhere near `Concrete` (perhaps in a `contrib` sub-directory) and let many projects use it. You need to weigh the pros and cons carefully for your particular problem, but I'd like to assure you that the Java community has been practicing this for a long time and it's a proven effective technique applicable in a wide variety of situations. :-) ## Delegating Calls to a Fake ## Some times you have a non-trivial fake implementation of an interface. For example: ``` class Foo { public: virtual ~Foo() {} virtual char DoThis(int n) = 0; virtual void DoThat(const char* s, int* p) = 0; }; class FakeFoo : public Foo { public: virtual char DoThis(int n) { return (n > 0) ? '+' : (n < 0) ? '-' : '0'; } virtual void DoThat(const char* s, int* p) { *p = strlen(s); } }; ``` Now you want to mock this interface such that you can set expectations on it. However, you also want to use `FakeFoo` for the default behavior, as duplicating it in the mock object is, well, a lot of work. When you define the mock class using Google Mock, you can have it delegate its default action to a fake class you already have, using this pattern: ``` using ::testing::_; using ::testing::Invoke; class MockFoo : public Foo { public: // Normal mock method definitions using Google Mock. MOCK_METHOD1(DoThis, char(int n)); MOCK_METHOD2(DoThat, void(const char* s, int* p)); // Delegates the default actions of the methods to a FakeFoo object. // This must be called *before* the custom ON_CALL() statements. void DelegateToFake() { ON_CALL(*this, DoThis(_)) .WillByDefault(Invoke(&fake_, &FakeFoo::DoThis)); ON_CALL(*this, DoThat(_, _)) .WillByDefault(Invoke(&fake_, &FakeFoo::DoThat)); } private: FakeFoo fake_; // Keeps an instance of the fake in the mock. }; ``` With that, you can use `MockFoo` in your tests as usual. Just remember that if you don't explicitly set an action in an `ON_CALL()` or `EXPECT_CALL()`, the fake will be called upon to do it: ``` using ::testing::_; TEST(AbcTest, Xyz) { MockFoo foo; foo.DelegateToFake(); // Enables the fake for delegation. // Put your ON_CALL(foo, ...)s here, if any. // No action specified, meaning to use the default action. EXPECT_CALL(foo, DoThis(5)); EXPECT_CALL(foo, DoThat(_, _)); int n = 0; EXPECT_EQ('+', foo.DoThis(5)); // FakeFoo::DoThis() is invoked. foo.DoThat("Hi", &n); // FakeFoo::DoThat() is invoked. EXPECT_EQ(2, n); } ``` **Some tips:** * If you want, you can still override the default action by providing your own `ON_CALL()` or using `.WillOnce()` / `.WillRepeatedly()` in `EXPECT_CALL()`. * In `DelegateToFake()`, you only need to delegate the methods whose fake implementation you intend to use. * The general technique discussed here works for overloaded methods, but you'll need to tell the compiler which version you mean. To disambiguate a mock function (the one you specify inside the parentheses of `ON_CALL()`), see the "Selecting Between Overloaded Functions" section on this page; to disambiguate a fake function (the one you place inside `Invoke()`), use a `static_cast` to specify the function's type. For instance, if class `Foo` has methods `char DoThis(int n)` and `bool DoThis(double x) const`, and you want to invoke the latter, you need to write `Invoke(&fake_, static_cast(&FakeFoo::DoThis))` instead of `Invoke(&fake_, &FakeFoo::DoThis)` (The strange-looking thing inside the angled brackets of `static_cast` is the type of a function pointer to the second `DoThis()` method.). * Having to mix a mock and a fake is often a sign of something gone wrong. Perhaps you haven't got used to the interaction-based way of testing yet. Or perhaps your interface is taking on too many roles and should be split up. Therefore, **don't abuse this**. We would only recommend to do it as an intermediate step when you are refactoring your code. Regarding the tip on mixing a mock and a fake, here's an example on why it may be a bad sign: Suppose you have a class `System` for low-level system operations. In particular, it does file and I/O operations. And suppose you want to test how your code uses `System` to do I/O, and you just want the file operations to work normally. If you mock out the entire `System` class, you'll have to provide a fake implementation for the file operation part, which suggests that `System` is taking on too many roles. Instead, you can define a `FileOps` interface and an `IOOps` interface and split `System`'s functionalities into the two. Then you can mock `IOOps` without mocking `FileOps`. ## Delegating Calls to a Real Object ## When using testing doubles (mocks, fakes, stubs, and etc), sometimes their behaviors will differ from those of the real objects. This difference could be either intentional (as in simulating an error such that you can test the error handling code) or unintentional. If your mocks have different behaviors than the real objects by mistake, you could end up with code that passes the tests but fails in production. You can use the _delegating-to-real_ technique to ensure that your mock has the same behavior as the real object while retaining the ability to validate calls. This technique is very similar to the delegating-to-fake technique, the difference being that we use a real object instead of a fake. Here's an example: ``` using ::testing::_; using ::testing::AtLeast; using ::testing::Invoke; class MockFoo : public Foo { public: MockFoo() { // By default, all calls are delegated to the real object. ON_CALL(*this, DoThis()) .WillByDefault(Invoke(&real_, &Foo::DoThis)); ON_CALL(*this, DoThat(_)) .WillByDefault(Invoke(&real_, &Foo::DoThat)); ... } MOCK_METHOD0(DoThis, ...); MOCK_METHOD1(DoThat, ...); ... private: Foo real_; }; ... MockFoo mock; EXPECT_CALL(mock, DoThis()) .Times(3); EXPECT_CALL(mock, DoThat("Hi")) .Times(AtLeast(1)); ... use mock in test ... ``` With this, Google Mock will verify that your code made the right calls (with the right arguments, in the right order, called the right number of times, etc), and a real object will answer the calls (so the behavior will be the same as in production). This gives you the best of both worlds. ## Delegating Calls to a Parent Class ## Ideally, you should code to interfaces, whose methods are all pure virtual. In reality, sometimes you do need to mock a virtual method that is not pure (i.e, it already has an implementation). For example: ``` class Foo { public: virtual ~Foo(); virtual void Pure(int n) = 0; virtual int Concrete(const char* str) { ... } }; class MockFoo : public Foo { public: // Mocking a pure method. MOCK_METHOD1(Pure, void(int n)); // Mocking a concrete method. Foo::Concrete() is shadowed. MOCK_METHOD1(Concrete, int(const char* str)); }; ``` Sometimes you may want to call `Foo::Concrete()` instead of `MockFoo::Concrete()`. Perhaps you want to do it as part of a stub action, or perhaps your test doesn't need to mock `Concrete()` at all (but it would be oh-so painful to have to define a new mock class whenever you don't need to mock one of its methods). The trick is to leave a back door in your mock class for accessing the real methods in the base class: ``` class MockFoo : public Foo { public: // Mocking a pure method. MOCK_METHOD1(Pure, void(int n)); // Mocking a concrete method. Foo::Concrete() is shadowed. MOCK_METHOD1(Concrete, int(const char* str)); // Use this to call Concrete() defined in Foo. int FooConcrete(const char* str) { return Foo::Concrete(str); } }; ``` Now, you can call `Foo::Concrete()` inside an action by: ``` using ::testing::_; using ::testing::Invoke; ... EXPECT_CALL(foo, Concrete(_)) .WillOnce(Invoke(&foo, &MockFoo::FooConcrete)); ``` or tell the mock object that you don't want to mock `Concrete()`: ``` using ::testing::Invoke; ... ON_CALL(foo, Concrete(_)) .WillByDefault(Invoke(&foo, &MockFoo::FooConcrete)); ``` (Why don't we just write `Invoke(&foo, &Foo::Concrete)`? If you do that, `MockFoo::Concrete()` will be called (and cause an infinite recursion) since `Foo::Concrete()` is virtual. That's just how C++ works.) # Using Matchers # ## Matching Argument Values Exactly ## You can specify exactly which arguments a mock method is expecting: ``` using ::testing::Return; ... EXPECT_CALL(foo, DoThis(5)) .WillOnce(Return('a')); EXPECT_CALL(foo, DoThat("Hello", bar)); ``` ## Using Simple Matchers ## You can use matchers to match arguments that have a certain property: ``` using ::testing::Ge; using ::testing::NotNull; using ::testing::Return; ... EXPECT_CALL(foo, DoThis(Ge(5))) // The argument must be >= 5. .WillOnce(Return('a')); EXPECT_CALL(foo, DoThat("Hello", NotNull())); // The second argument must not be NULL. ``` A frequently used matcher is `_`, which matches anything: ``` using ::testing::_; using ::testing::NotNull; ... EXPECT_CALL(foo, DoThat(_, NotNull())); ``` ## Combining Matchers ## You can build complex matchers from existing ones using `AllOf()`, `AnyOf()`, and `Not()`: ``` using ::testing::AllOf; using ::testing::Gt; using ::testing::HasSubstr; using ::testing::Ne; using ::testing::Not; ... // The argument must be > 5 and != 10. EXPECT_CALL(foo, DoThis(AllOf(Gt(5), Ne(10)))); // The first argument must not contain sub-string "blah". EXPECT_CALL(foo, DoThat(Not(HasSubstr("blah")), NULL)); ``` ## Casting Matchers ## Google Mock matchers are statically typed, meaning that the compiler can catch your mistake if you use a matcher of the wrong type (for example, if you use `Eq(5)` to match a `string` argument). Good for you! Sometimes, however, you know what you're doing and want the compiler to give you some slack. One example is that you have a matcher for `long` and the argument you want to match is `int`. While the two types aren't exactly the same, there is nothing really wrong with using a `Matcher` to match an `int` - after all, we can first convert the `int` argument to a `long` before giving it to the matcher. To support this need, Google Mock gives you the `SafeMatcherCast(m)` function. It casts a matcher `m` to type `Matcher`. To ensure safety, Google Mock checks that (let `U` be the type `m` accepts): 1. Type `T` can be implicitly cast to type `U`; 1. When both `T` and `U` are built-in arithmetic types (`bool`, integers, and floating-point numbers), the conversion from `T` to `U` is not lossy (in other words, any value representable by `T` can also be represented by `U`); and 1. When `U` is a reference, `T` must also be a reference (as the underlying matcher may be interested in the address of the `U` value). The code won't compile if any of these conditions isn't met. Here's one example: ``` using ::testing::SafeMatcherCast; // A base class and a child class. class Base { ... }; class Derived : public Base { ... }; class MockFoo : public Foo { public: MOCK_METHOD1(DoThis, void(Derived* derived)); }; ... MockFoo foo; // m is a Matcher we got from somewhere. EXPECT_CALL(foo, DoThis(SafeMatcherCast(m))); ``` If you find `SafeMatcherCast(m)` too limiting, you can use a similar function `MatcherCast(m)`. The difference is that `MatcherCast` works as long as you can `static_cast` type `T` to type `U`. `MatcherCast` essentially lets you bypass C++'s type system (`static_cast` isn't always safe as it could throw away information, for example), so be careful not to misuse/abuse it. ## Selecting Between Overloaded Functions ## If you expect an overloaded function to be called, the compiler may need some help on which overloaded version it is. To disambiguate functions overloaded on the const-ness of this object, use the `Const()` argument wrapper. ``` using ::testing::ReturnRef; class MockFoo : public Foo { ... MOCK_METHOD0(GetBar, Bar&()); MOCK_CONST_METHOD0(GetBar, const Bar&()); }; ... MockFoo foo; Bar bar1, bar2; EXPECT_CALL(foo, GetBar()) // The non-const GetBar(). .WillOnce(ReturnRef(bar1)); EXPECT_CALL(Const(foo), GetBar()) // The const GetBar(). .WillOnce(ReturnRef(bar2)); ``` (`Const()` is defined by Google Mock and returns a `const` reference to its argument.) To disambiguate overloaded functions with the same number of arguments but different argument types, you may need to specify the exact type of a matcher, either by wrapping your matcher in `Matcher()`, or using a matcher whose type is fixed (`TypedEq`, `An()`, etc): ``` using ::testing::An; using ::testing::Lt; using ::testing::Matcher; using ::testing::TypedEq; class MockPrinter : public Printer { public: MOCK_METHOD1(Print, void(int n)); MOCK_METHOD1(Print, void(char c)); }; TEST(PrinterTest, Print) { MockPrinter printer; EXPECT_CALL(printer, Print(An())); // void Print(int); EXPECT_CALL(printer, Print(Matcher(Lt(5)))); // void Print(int); EXPECT_CALL(printer, Print(TypedEq('a'))); // void Print(char); printer.Print(3); printer.Print(6); printer.Print('a'); } ``` ## Performing Different Actions Based on the Arguments ## When a mock method is called, the _last_ matching expectation that's still active will be selected (think "newer overrides older"). So, you can make a method do different things depending on its argument values like this: ``` using ::testing::_; using ::testing::Lt; using ::testing::Return; ... // The default case. EXPECT_CALL(foo, DoThis(_)) .WillRepeatedly(Return('b')); // The more specific case. EXPECT_CALL(foo, DoThis(Lt(5))) .WillRepeatedly(Return('a')); ``` Now, if `foo.DoThis()` is called with a value less than 5, `'a'` will be returned; otherwise `'b'` will be returned. ## Matching Multiple Arguments as a Whole ## Sometimes it's not enough to match the arguments individually. For example, we may want to say that the first argument must be less than the second argument. The `With()` clause allows us to match all arguments of a mock function as a whole. For example, ``` using ::testing::_; using ::testing::Lt; using ::testing::Ne; ... EXPECT_CALL(foo, InRange(Ne(0), _)) .With(Lt()); ``` says that the first argument of `InRange()` must not be 0, and must be less than the second argument. The expression inside `With()` must be a matcher of type `Matcher< ::testing::tuple >`, where `A1`, ..., `An` are the types of the function arguments. You can also write `AllArgs(m)` instead of `m` inside `.With()`. The two forms are equivalent, but `.With(AllArgs(Lt()))` is more readable than `.With(Lt())`. You can use `Args(m)` to match the `n` selected arguments (as a tuple) against `m`. For example, ``` using ::testing::_; using ::testing::AllOf; using ::testing::Args; using ::testing::Lt; ... EXPECT_CALL(foo, Blah(_, _, _)) .With(AllOf(Args<0, 1>(Lt()), Args<1, 2>(Lt()))); ``` says that `Blah()` will be called with arguments `x`, `y`, and `z` where `x < y < z`. As a convenience and example, Google Mock provides some matchers for 2-tuples, including the `Lt()` matcher above. See the [CheatSheet](CheatSheet.md) for the complete list. Note that if you want to pass the arguments to a predicate of your own (e.g. `.With(Args<0, 1>(Truly(&MyPredicate)))`), that predicate MUST be written to take a `::testing::tuple` as its argument; Google Mock will pass the `n` selected arguments as _one_ single tuple to the predicate. ## Using Matchers as Predicates ## Have you noticed that a matcher is just a fancy predicate that also knows how to describe itself? Many existing algorithms take predicates as arguments (e.g. those defined in STL's `` header), and it would be a shame if Google Mock matchers are not allowed to participate. Luckily, you can use a matcher where a unary predicate functor is expected by wrapping it inside the `Matches()` function. For example, ``` #include #include std::vector v; ... // How many elements in v are >= 10? const int count = count_if(v.begin(), v.end(), Matches(Ge(10))); ``` Since you can build complex matchers from simpler ones easily using Google Mock, this gives you a way to conveniently construct composite predicates (doing the same using STL's `` header is just painful). For example, here's a predicate that's satisfied by any number that is >= 0, <= 100, and != 50: ``` Matches(AllOf(Ge(0), Le(100), Ne(50))) ``` ## Using Matchers in Google Test Assertions ## Since matchers are basically predicates that also know how to describe themselves, there is a way to take advantage of them in [Google Test](../../googletest/) assertions. It's called `ASSERT_THAT` and `EXPECT_THAT`: ``` ASSERT_THAT(value, matcher); // Asserts that value matches matcher. EXPECT_THAT(value, matcher); // The non-fatal version. ``` For example, in a Google Test test you can write: ``` #include "gmock/gmock.h" using ::testing::AllOf; using ::testing::Ge; using ::testing::Le; using ::testing::MatchesRegex; using ::testing::StartsWith; ... EXPECT_THAT(Foo(), StartsWith("Hello")); EXPECT_THAT(Bar(), MatchesRegex("Line \\d+")); ASSERT_THAT(Baz(), AllOf(Ge(5), Le(10))); ``` which (as you can probably guess) executes `Foo()`, `Bar()`, and `Baz()`, and verifies that: * `Foo()` returns a string that starts with `"Hello"`. * `Bar()` returns a string that matches regular expression `"Line \\d+"`. * `Baz()` returns a number in the range [5, 10]. The nice thing about these macros is that _they read like English_. They generate informative messages too. For example, if the first `EXPECT_THAT()` above fails, the message will be something like: ``` Value of: Foo() Actual: "Hi, world!" Expected: starts with "Hello" ``` **Credit:** The idea of `(ASSERT|EXPECT)_THAT` was stolen from the [Hamcrest](https://github.com/hamcrest/) project, which adds `assertThat()` to JUnit. ## Using Predicates as Matchers ## Google Mock provides a built-in set of matchers. In case you find them lacking, you can use an arbitray unary predicate function or functor as a matcher - as long as the predicate accepts a value of the type you want. You do this by wrapping the predicate inside the `Truly()` function, for example: ``` using ::testing::Truly; int IsEven(int n) { return (n % 2) == 0 ? 1 : 0; } ... // Bar() must be called with an even number. EXPECT_CALL(foo, Bar(Truly(IsEven))); ``` Note that the predicate function / functor doesn't have to return `bool`. It works as long as the return value can be used as the condition in statement `if (condition) ...`. ## Matching Arguments that Are Not Copyable ## When you do an `EXPECT_CALL(mock_obj, Foo(bar))`, Google Mock saves away a copy of `bar`. When `Foo()` is called later, Google Mock compares the argument to `Foo()` with the saved copy of `bar`. This way, you don't need to worry about `bar` being modified or destroyed after the `EXPECT_CALL()` is executed. The same is true when you use matchers like `Eq(bar)`, `Le(bar)`, and so on. But what if `bar` cannot be copied (i.e. has no copy constructor)? You could define your own matcher function and use it with `Truly()`, as the previous couple of recipes have shown. Or, you may be able to get away from it if you can guarantee that `bar` won't be changed after the `EXPECT_CALL()` is executed. Just tell Google Mock that it should save a reference to `bar`, instead of a copy of it. Here's how: ``` using ::testing::Eq; using ::testing::ByRef; using ::testing::Lt; ... // Expects that Foo()'s argument == bar. EXPECT_CALL(mock_obj, Foo(Eq(ByRef(bar)))); // Expects that Foo()'s argument < bar. EXPECT_CALL(mock_obj, Foo(Lt(ByRef(bar)))); ``` Remember: if you do this, don't change `bar` after the `EXPECT_CALL()`, or the result is undefined. ## Validating a Member of an Object ## Often a mock function takes a reference to object as an argument. When matching the argument, you may not want to compare the entire object against a fixed object, as that may be over-specification. Instead, you may need to validate a certain member variable or the result of a certain getter method of the object. You can do this with `Field()` and `Property()`. More specifically, ``` Field(&Foo::bar, m) ``` is a matcher that matches a `Foo` object whose `bar` member variable satisfies matcher `m`. ``` Property(&Foo::baz, m) ``` is a matcher that matches a `Foo` object whose `baz()` method returns a value that satisfies matcher `m`. For example: > | `Field(&Foo::number, Ge(3))` | Matches `x` where `x.number >= 3`. | |:-----------------------------|:-----------------------------------| > | `Property(&Foo::name, StartsWith("John "))` | Matches `x` where `x.name()` starts with `"John "`. | Note that in `Property(&Foo::baz, ...)`, method `baz()` must take no argument and be declared as `const`. BTW, `Field()` and `Property()` can also match plain pointers to objects. For instance, ``` Field(&Foo::number, Ge(3)) ``` matches a plain pointer `p` where `p->number >= 3`. If `p` is `NULL`, the match will always fail regardless of the inner matcher. What if you want to validate more than one members at the same time? Remember that there is `AllOf()`. ## Validating the Value Pointed to by a Pointer Argument ## C++ functions often take pointers as arguments. You can use matchers like `IsNull()`, `NotNull()`, and other comparison matchers to match a pointer, but what if you want to make sure the value _pointed to_ by the pointer, instead of the pointer itself, has a certain property? Well, you can use the `Pointee(m)` matcher. `Pointee(m)` matches a pointer iff `m` matches the value the pointer points to. For example: ``` using ::testing::Ge; using ::testing::Pointee; ... EXPECT_CALL(foo, Bar(Pointee(Ge(3)))); ``` expects `foo.Bar()` to be called with a pointer that points to a value greater than or equal to 3. One nice thing about `Pointee()` is that it treats a `NULL` pointer as a match failure, so you can write `Pointee(m)` instead of ``` AllOf(NotNull(), Pointee(m)) ``` without worrying that a `NULL` pointer will crash your test. Also, did we tell you that `Pointee()` works with both raw pointers **and** smart pointers (`linked_ptr`, `shared_ptr`, `scoped_ptr`, and etc)? What if you have a pointer to pointer? You guessed it - you can use nested `Pointee()` to probe deeper inside the value. For example, `Pointee(Pointee(Lt(3)))` matches a pointer that points to a pointer that points to a number less than 3 (what a mouthful...). ## Testing a Certain Property of an Object ## Sometimes you want to specify that an object argument has a certain property, but there is no existing matcher that does this. If you want good error messages, you should define a matcher. If you want to do it quick and dirty, you could get away with writing an ordinary function. Let's say you have a mock function that takes an object of type `Foo`, which has an `int bar()` method and an `int baz()` method, and you want to constrain that the argument's `bar()` value plus its `baz()` value is a given number. Here's how you can define a matcher to do it: ``` using ::testing::MatcherInterface; using ::testing::MatchResultListener; class BarPlusBazEqMatcher : public MatcherInterface { public: explicit BarPlusBazEqMatcher(int expected_sum) : expected_sum_(expected_sum) {} virtual bool MatchAndExplain(const Foo& foo, MatchResultListener* listener) const { return (foo.bar() + foo.baz()) == expected_sum_; } virtual void DescribeTo(::std::ostream* os) const { *os << "bar() + baz() equals " << expected_sum_; } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "bar() + baz() does not equal " << expected_sum_; } private: const int expected_sum_; }; inline Matcher BarPlusBazEq(int expected_sum) { return MakeMatcher(new BarPlusBazEqMatcher(expected_sum)); } ... EXPECT_CALL(..., DoThis(BarPlusBazEq(5)))...; ``` ## Matching Containers ## Sometimes an STL container (e.g. list, vector, map, ...) is passed to a mock function and you may want to validate it. Since most STL containers support the `==` operator, you can write `Eq(expected_container)` or simply `expected_container` to match a container exactly. Sometimes, though, you may want to be more flexible (for example, the first element must be an exact match, but the second element can be any positive number, and so on). Also, containers used in tests often have a small number of elements, and having to define the expected container out-of-line is a bit of a hassle. You can use the `ElementsAre()` or `UnorderedElementsAre()` matcher in such cases: ``` using ::testing::_; using ::testing::ElementsAre; using ::testing::Gt; ... MOCK_METHOD1(Foo, void(const vector& numbers)); ... EXPECT_CALL(mock, Foo(ElementsAre(1, Gt(0), _, 5))); ``` The above matcher says that the container must have 4 elements, which must be 1, greater than 0, anything, and 5 respectively. If you instead write: ``` using ::testing::_; using ::testing::Gt; using ::testing::UnorderedElementsAre; ... MOCK_METHOD1(Foo, void(const vector& numbers)); ... EXPECT_CALL(mock, Foo(UnorderedElementsAre(1, Gt(0), _, 5))); ``` It means that the container must have 4 elements, which under some permutation must be 1, greater than 0, anything, and 5 respectively. `ElementsAre()` and `UnorderedElementsAre()` are overloaded to take 0 to 10 arguments. If more are needed, you can place them in a C-style array and use `ElementsAreArray()` or `UnorderedElementsAreArray()` instead: ``` using ::testing::ElementsAreArray; ... // ElementsAreArray accepts an array of element values. const int expected_vector1[] = { 1, 5, 2, 4, ... }; EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector1))); // Or, an array of element matchers. Matcher expected_vector2 = { 1, Gt(2), _, 3, ... }; EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector2))); ``` In case the array needs to be dynamically created (and therefore the array size cannot be inferred by the compiler), you can give `ElementsAreArray()` an additional argument to specify the array size: ``` using ::testing::ElementsAreArray; ... int* const expected_vector3 = new int[count]; ... fill expected_vector3 with values ... EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector3, count))); ``` **Tips:** * `ElementsAre*()` can be used to match _any_ container that implements the STL iterator pattern (i.e. it has a `const_iterator` type and supports `begin()/end()`), not just the ones defined in STL. It will even work with container types yet to be written - as long as they follows the above pattern. * You can use nested `ElementsAre*()` to match nested (multi-dimensional) containers. * If the container is passed by pointer instead of by reference, just write `Pointee(ElementsAre*(...))`. * The order of elements _matters_ for `ElementsAre*()`. Therefore don't use it with containers whose element order is undefined (e.g. `hash_map`). ## Sharing Matchers ## Under the hood, a Google Mock matcher object consists of a pointer to a ref-counted implementation object. Copying matchers is allowed and very efficient, as only the pointer is copied. When the last matcher that references the implementation object dies, the implementation object will be deleted. Therefore, if you have some complex matcher that you want to use again and again, there is no need to build it everytime. Just assign it to a matcher variable and use that variable repeatedly! For example, ``` Matcher in_range = AllOf(Gt(5), Le(10)); ... use in_range as a matcher in multiple EXPECT_CALLs ... ``` # Setting Expectations # ## Knowing When to Expect ## `ON_CALL` is likely the single most under-utilized construct in Google Mock. There are basically two constructs for defining the behavior of a mock object: `ON_CALL` and `EXPECT_CALL`. The difference? `ON_CALL` defines what happens when a mock method is called, but _doesn't imply any expectation on the method being called._ `EXPECT_CALL` not only defines the behavior, but also sets an expectation that _the method will be called with the given arguments, for the given number of times_ (and _in the given order_ when you specify the order too). Since `EXPECT_CALL` does more, isn't it better than `ON_CALL`? Not really. Every `EXPECT_CALL` adds a constraint on the behavior of the code under test. Having more constraints than necessary is _baaad_ - even worse than not having enough constraints. This may be counter-intuitive. How could tests that verify more be worse than tests that verify less? Isn't verification the whole point of tests? The answer, lies in _what_ a test should verify. **A good test verifies the contract of the code.** If a test over-specifies, it doesn't leave enough freedom to the implementation. As a result, changing the implementation without breaking the contract (e.g. refactoring and optimization), which should be perfectly fine to do, can break such tests. Then you have to spend time fixing them, only to see them broken again the next time the implementation is changed. Keep in mind that one doesn't have to verify more than one property in one test. In fact, **it's a good style to verify only one thing in one test.** If you do that, a bug will likely break only one or two tests instead of dozens (which case would you rather debug?). If you are also in the habit of giving tests descriptive names that tell what they verify, you can often easily guess what's wrong just from the test log itself. So use `ON_CALL` by default, and only use `EXPECT_CALL` when you actually intend to verify that the call is made. For example, you may have a bunch of `ON_CALL`s in your test fixture to set the common mock behavior shared by all tests in the same group, and write (scarcely) different `EXPECT_CALL`s in different `TEST_F`s to verify different aspects of the code's behavior. Compared with the style where each `TEST` has many `EXPECT_CALL`s, this leads to tests that are more resilient to implementational changes (and thus less likely to require maintenance) and makes the intent of the tests more obvious (so they are easier to maintain when you do need to maintain them). If you are bothered by the "Uninteresting mock function call" message printed when a mock method without an `EXPECT_CALL` is called, you may use a `NiceMock` instead to suppress all such messages for the mock object, or suppress the message for specific methods by adding `EXPECT_CALL(...).Times(AnyNumber())`. DO NOT suppress it by blindly adding an `EXPECT_CALL(...)`, or you'll have a test that's a pain to maintain. ## Ignoring Uninteresting Calls ## If you are not interested in how a mock method is called, just don't say anything about it. In this case, if the method is ever called, Google Mock will perform its default action to allow the test program to continue. If you are not happy with the default action taken by Google Mock, you can override it using `DefaultValue::Set()` (described later in this document) or `ON_CALL()`. Please note that once you expressed interest in a particular mock method (via `EXPECT_CALL()`), all invocations to it must match some expectation. If this function is called but the arguments don't match any `EXPECT_CALL()` statement, it will be an error. ## Disallowing Unexpected Calls ## If a mock method shouldn't be called at all, explicitly say so: ``` using ::testing::_; ... EXPECT_CALL(foo, Bar(_)) .Times(0); ``` If some calls to the method are allowed, but the rest are not, just list all the expected calls: ``` using ::testing::AnyNumber; using ::testing::Gt; ... EXPECT_CALL(foo, Bar(5)); EXPECT_CALL(foo, Bar(Gt(10))) .Times(AnyNumber()); ``` A call to `foo.Bar()` that doesn't match any of the `EXPECT_CALL()` statements will be an error. ## Understanding Uninteresting vs Unexpected Calls ## _Uninteresting_ calls and _unexpected_ calls are different concepts in Google Mock. _Very_ different. A call `x.Y(...)` is **uninteresting** if there's _not even a single_ `EXPECT_CALL(x, Y(...))` set. In other words, the test isn't interested in the `x.Y()` method at all, as evident in that the test doesn't care to say anything about it. A call `x.Y(...)` is **unexpected** if there are some `EXPECT_CALL(x, Y(...))s` set, but none of them matches the call. Put another way, the test is interested in the `x.Y()` method (therefore it _explicitly_ sets some `EXPECT_CALL` to verify how it's called); however, the verification fails as the test doesn't expect this particular call to happen. **An unexpected call is always an error,** as the code under test doesn't behave the way the test expects it to behave. **By default, an uninteresting call is not an error,** as it violates no constraint specified by the test. (Google Mock's philosophy is that saying nothing means there is no constraint.) However, it leads to a warning, as it _might_ indicate a problem (e.g. the test author might have forgotten to specify a constraint). In Google Mock, `NiceMock` and `StrictMock` can be used to make a mock class "nice" or "strict". How does this affect uninteresting calls and unexpected calls? A **nice mock** suppresses uninteresting call warnings. It is less chatty than the default mock, but otherwise is the same. If a test fails with a default mock, it will also fail using a nice mock instead. And vice versa. Don't expect making a mock nice to change the test's result. A **strict mock** turns uninteresting call warnings into errors. So making a mock strict may change the test's result. Let's look at an example: ``` TEST(...) { NiceMock mock_registry; EXPECT_CALL(mock_registry, GetDomainOwner("google.com")) .WillRepeatedly(Return("Larry Page")); // Use mock_registry in code under test. ... &mock_registry ... } ``` The sole `EXPECT_CALL` here says that all calls to `GetDomainOwner()` must have `"google.com"` as the argument. If `GetDomainOwner("yahoo.com")` is called, it will be an unexpected call, and thus an error. Having a nice mock doesn't change the severity of an unexpected call. So how do we tell Google Mock that `GetDomainOwner()` can be called with some other arguments as well? The standard technique is to add a "catch all" `EXPECT_CALL`: ``` EXPECT_CALL(mock_registry, GetDomainOwner(_)) .Times(AnyNumber()); // catches all other calls to this method. EXPECT_CALL(mock_registry, GetDomainOwner("google.com")) .WillRepeatedly(Return("Larry Page")); ``` Remember that `_` is the wildcard matcher that matches anything. With this, if `GetDomainOwner("google.com")` is called, it will do what the second `EXPECT_CALL` says; if it is called with a different argument, it will do what the first `EXPECT_CALL` says. Note that the order of the two `EXPECT_CALLs` is important, as a newer `EXPECT_CALL` takes precedence over an older one. For more on uninteresting calls, nice mocks, and strict mocks, read ["The Nice, the Strict, and the Naggy"](#the-nice-the-strict-and-the-naggy). ## Expecting Ordered Calls ## Although an `EXPECT_CALL()` statement defined earlier takes precedence when Google Mock tries to match a function call with an expectation, by default calls don't have to happen in the order `EXPECT_CALL()` statements are written. For example, if the arguments match the matchers in the third `EXPECT_CALL()`, but not those in the first two, then the third expectation will be used. If you would rather have all calls occur in the order of the expectations, put the `EXPECT_CALL()` statements in a block where you define a variable of type `InSequence`: ``` using ::testing::_; using ::testing::InSequence; { InSequence s; EXPECT_CALL(foo, DoThis(5)); EXPECT_CALL(bar, DoThat(_)) .Times(2); EXPECT_CALL(foo, DoThis(6)); } ``` In this example, we expect a call to `foo.DoThis(5)`, followed by two calls to `bar.DoThat()` where the argument can be anything, which are in turn followed by a call to `foo.DoThis(6)`. If a call occurred out-of-order, Google Mock will report an error. ## Expecting Partially Ordered Calls ## Sometimes requiring everything to occur in a predetermined order can lead to brittle tests. For example, we may care about `A` occurring before both `B` and `C`, but aren't interested in the relative order of `B` and `C`. In this case, the test should reflect our real intent, instead of being overly constraining. Google Mock allows you to impose an arbitrary DAG (directed acyclic graph) on the calls. One way to express the DAG is to use the [After](CheatSheet.md#the-after-clause) clause of `EXPECT_CALL`. Another way is via the `InSequence()` clause (not the same as the `InSequence` class), which we borrowed from jMock 2. It's less flexible than `After()`, but more convenient when you have long chains of sequential calls, as it doesn't require you to come up with different names for the expectations in the chains. Here's how it works: If we view `EXPECT_CALL()` statements as nodes in a graph, and add an edge from node A to node B wherever A must occur before B, we can get a DAG. We use the term "sequence" to mean a directed path in this DAG. Now, if we decompose the DAG into sequences, we just need to know which sequences each `EXPECT_CALL()` belongs to in order to be able to reconstruct the orginal DAG. So, to specify the partial order on the expectations we need to do two things: first to define some `Sequence` objects, and then for each `EXPECT_CALL()` say which `Sequence` objects it is part of. Expectations in the same sequence must occur in the order they are written. For example, ``` using ::testing::Sequence; Sequence s1, s2; EXPECT_CALL(foo, A()) .InSequence(s1, s2); EXPECT_CALL(bar, B()) .InSequence(s1); EXPECT_CALL(bar, C()) .InSequence(s2); EXPECT_CALL(foo, D()) .InSequence(s2); ``` specifies the following DAG (where `s1` is `A -> B`, and `s2` is `A -> C -> D`): ``` +---> B | A ---| | +---> C ---> D ``` This means that A must occur before B and C, and C must occur before D. There's no restriction about the order other than these. ## Controlling When an Expectation Retires ## When a mock method is called, Google Mock only consider expectations that are still active. An expectation is active when created, and becomes inactive (aka _retires_) when a call that has to occur later has occurred. For example, in ``` using ::testing::_; using ::testing::Sequence; Sequence s1, s2; EXPECT_CALL(log, Log(WARNING, _, "File too large.")) // #1 .Times(AnyNumber()) .InSequence(s1, s2); EXPECT_CALL(log, Log(WARNING, _, "Data set is empty.")) // #2 .InSequence(s1); EXPECT_CALL(log, Log(WARNING, _, "User not found.")) // #3 .InSequence(s2); ``` as soon as either #2 or #3 is matched, #1 will retire. If a warning `"File too large."` is logged after this, it will be an error. Note that an expectation doesn't retire automatically when it's saturated. For example, ``` using ::testing::_; ... EXPECT_CALL(log, Log(WARNING, _, _)); // #1 EXPECT_CALL(log, Log(WARNING, _, "File too large.")); // #2 ``` says that there will be exactly one warning with the message `"File too large."`. If the second warning contains this message too, #2 will match again and result in an upper-bound-violated error. If this is not what you want, you can ask an expectation to retire as soon as it becomes saturated: ``` using ::testing::_; ... EXPECT_CALL(log, Log(WARNING, _, _)); // #1 EXPECT_CALL(log, Log(WARNING, _, "File too large.")) // #2 .RetiresOnSaturation(); ``` Here #2 can be used only once, so if you have two warnings with the message `"File too large."`, the first will match #2 and the second will match #1 - there will be no error. # Using Actions # ## Returning References from Mock Methods ## If a mock function's return type is a reference, you need to use `ReturnRef()` instead of `Return()` to return a result: ``` using ::testing::ReturnRef; class MockFoo : public Foo { public: MOCK_METHOD0(GetBar, Bar&()); }; ... MockFoo foo; Bar bar; EXPECT_CALL(foo, GetBar()) .WillOnce(ReturnRef(bar)); ``` ## Returning Live Values from Mock Methods ## The `Return(x)` action saves a copy of `x` when the action is _created_, and always returns the same value whenever it's executed. Sometimes you may want to instead return the _live_ value of `x` (i.e. its value at the time when the action is _executed_.). If the mock function's return type is a reference, you can do it using `ReturnRef(x)`, as shown in the previous recipe ("Returning References from Mock Methods"). However, Google Mock doesn't let you use `ReturnRef()` in a mock function whose return type is not a reference, as doing that usually indicates a user error. So, what shall you do? You may be tempted to try `ByRef()`: ``` using testing::ByRef; using testing::Return; class MockFoo : public Foo { public: MOCK_METHOD0(GetValue, int()); }; ... int x = 0; MockFoo foo; EXPECT_CALL(foo, GetValue()) .WillRepeatedly(Return(ByRef(x))); x = 42; EXPECT_EQ(42, foo.GetValue()); ``` Unfortunately, it doesn't work here. The above code will fail with error: ``` Value of: foo.GetValue() Actual: 0 Expected: 42 ``` The reason is that `Return(value)` converts `value` to the actual return type of the mock function at the time when the action is _created_, not when it is _executed_. (This behavior was chosen for the action to be safe when `value` is a proxy object that references some temporary objects.) As a result, `ByRef(x)` is converted to an `int` value (instead of a `const int&`) when the expectation is set, and `Return(ByRef(x))` will always return 0. `ReturnPointee(pointer)` was provided to solve this problem specifically. It returns the value pointed to by `pointer` at the time the action is _executed_: ``` using testing::ReturnPointee; ... int x = 0; MockFoo foo; EXPECT_CALL(foo, GetValue()) .WillRepeatedly(ReturnPointee(&x)); // Note the & here. x = 42; EXPECT_EQ(42, foo.GetValue()); // This will succeed now. ``` ## Combining Actions ## Want to do more than one thing when a function is called? That's fine. `DoAll()` allow you to do sequence of actions every time. Only the return value of the last action in the sequence will be used. ``` using ::testing::DoAll; class MockFoo : public Foo { public: MOCK_METHOD1(Bar, bool(int n)); }; ... EXPECT_CALL(foo, Bar(_)) .WillOnce(DoAll(action_1, action_2, ... action_n)); ``` ## Mocking Side Effects ## Sometimes a method exhibits its effect not via returning a value but via side effects. For example, it may change some global state or modify an output argument. To mock side effects, in general you can define your own action by implementing `::testing::ActionInterface`. If all you need to do is to change an output argument, the built-in `SetArgPointee()` action is convenient: ``` using ::testing::SetArgPointee; class MockMutator : public Mutator { public: MOCK_METHOD2(Mutate, void(bool mutate, int* value)); ... }; ... MockMutator mutator; EXPECT_CALL(mutator, Mutate(true, _)) .WillOnce(SetArgPointee<1>(5)); ``` In this example, when `mutator.Mutate()` is called, we will assign 5 to the `int` variable pointed to by argument #1 (0-based). `SetArgPointee()` conveniently makes an internal copy of the value you pass to it, removing the need to keep the value in scope and alive. The implication however is that the value must have a copy constructor and assignment operator. If the mock method also needs to return a value as well, you can chain `SetArgPointee()` with `Return()` using `DoAll()`: ``` using ::testing::_; using ::testing::Return; using ::testing::SetArgPointee; class MockMutator : public Mutator { public: ... MOCK_METHOD1(MutateInt, bool(int* value)); }; ... MockMutator mutator; EXPECT_CALL(mutator, MutateInt(_)) .WillOnce(DoAll(SetArgPointee<0>(5), Return(true))); ``` If the output argument is an array, use the `SetArrayArgument(first, last)` action instead. It copies the elements in source range `[first, last)` to the array pointed to by the `N`-th (0-based) argument: ``` using ::testing::NotNull; using ::testing::SetArrayArgument; class MockArrayMutator : public ArrayMutator { public: MOCK_METHOD2(Mutate, void(int* values, int num_values)); ... }; ... MockArrayMutator mutator; int values[5] = { 1, 2, 3, 4, 5 }; EXPECT_CALL(mutator, Mutate(NotNull(), 5)) .WillOnce(SetArrayArgument<0>(values, values + 5)); ``` This also works when the argument is an output iterator: ``` using ::testing::_; using ::testing::SeArrayArgument; class MockRolodex : public Rolodex { public: MOCK_METHOD1(GetNames, void(std::back_insert_iterator >)); ... }; ... MockRolodex rolodex; vector names; names.push_back("George"); names.push_back("John"); names.push_back("Thomas"); EXPECT_CALL(rolodex, GetNames(_)) .WillOnce(SetArrayArgument<0>(names.begin(), names.end())); ``` ## Changing a Mock Object's Behavior Based on the State ## If you expect a call to change the behavior of a mock object, you can use `::testing::InSequence` to specify different behaviors before and after the call: ``` using ::testing::InSequence; using ::testing::Return; ... { InSequence seq; EXPECT_CALL(my_mock, IsDirty()) .WillRepeatedly(Return(true)); EXPECT_CALL(my_mock, Flush()); EXPECT_CALL(my_mock, IsDirty()) .WillRepeatedly(Return(false)); } my_mock.FlushIfDirty(); ``` This makes `my_mock.IsDirty()` return `true` before `my_mock.Flush()` is called and return `false` afterwards. If the behavior change is more complex, you can store the effects in a variable and make a mock method get its return value from that variable: ``` using ::testing::_; using ::testing::SaveArg; using ::testing::Return; ACTION_P(ReturnPointee, p) { return *p; } ... int previous_value = 0; EXPECT_CALL(my_mock, GetPrevValue()) .WillRepeatedly(ReturnPointee(&previous_value)); EXPECT_CALL(my_mock, UpdateValue(_)) .WillRepeatedly(SaveArg<0>(&previous_value)); my_mock.DoSomethingToUpdateValue(); ``` Here `my_mock.GetPrevValue()` will always return the argument of the last `UpdateValue()` call. ## Setting the Default Value for a Return Type ## If a mock method's return type is a built-in C++ type or pointer, by default it will return 0 when invoked. Also, in C++ 11 and above, a mock method whose return type has a default constructor will return a default-constructed value by default. You only need to specify an action if this default value doesn't work for you. Sometimes, you may want to change this default value, or you may want to specify a default value for types Google Mock doesn't know about. You can do this using the `::testing::DefaultValue` class template: ``` class MockFoo : public Foo { public: MOCK_METHOD0(CalculateBar, Bar()); }; ... Bar default_bar; // Sets the default return value for type Bar. DefaultValue::Set(default_bar); MockFoo foo; // We don't need to specify an action here, as the default // return value works for us. EXPECT_CALL(foo, CalculateBar()); foo.CalculateBar(); // This should return default_bar. // Unsets the default return value. DefaultValue::Clear(); ``` Please note that changing the default value for a type can make you tests hard to understand. We recommend you to use this feature judiciously. For example, you may want to make sure the `Set()` and `Clear()` calls are right next to the code that uses your mock. ## Setting the Default Actions for a Mock Method ## You've learned how to change the default value of a given type. However, this may be too coarse for your purpose: perhaps you have two mock methods with the same return type and you want them to have different behaviors. The `ON_CALL()` macro allows you to customize your mock's behavior at the method level: ``` using ::testing::_; using ::testing::AnyNumber; using ::testing::Gt; using ::testing::Return; ... ON_CALL(foo, Sign(_)) .WillByDefault(Return(-1)); ON_CALL(foo, Sign(0)) .WillByDefault(Return(0)); ON_CALL(foo, Sign(Gt(0))) .WillByDefault(Return(1)); EXPECT_CALL(foo, Sign(_)) .Times(AnyNumber()); foo.Sign(5); // This should return 1. foo.Sign(-9); // This should return -1. foo.Sign(0); // This should return 0. ``` As you may have guessed, when there are more than one `ON_CALL()` statements, the news order take precedence over the older ones. In other words, the **last** one that matches the function arguments will be used. This matching order allows you to set up the common behavior in a mock object's constructor or the test fixture's set-up phase and specialize the mock's behavior later. ## Using Functions/Methods/Functors as Actions ## If the built-in actions don't suit you, you can easily use an existing function, method, or functor as an action: ``` using ::testing::_; using ::testing::Invoke; class MockFoo : public Foo { public: MOCK_METHOD2(Sum, int(int x, int y)); MOCK_METHOD1(ComplexJob, bool(int x)); }; int CalculateSum(int x, int y) { return x + y; } class Helper { public: bool ComplexJob(int x); }; ... MockFoo foo; Helper helper; EXPECT_CALL(foo, Sum(_, _)) .WillOnce(Invoke(CalculateSum)); EXPECT_CALL(foo, ComplexJob(_)) .WillOnce(Invoke(&helper, &Helper::ComplexJob)); foo.Sum(5, 6); // Invokes CalculateSum(5, 6). foo.ComplexJob(10); // Invokes helper.ComplexJob(10); ``` The only requirement is that the type of the function, etc must be _compatible_ with the signature of the mock function, meaning that the latter's arguments can be implicitly converted to the corresponding arguments of the former, and the former's return type can be implicitly converted to that of the latter. So, you can invoke something whose type is _not_ exactly the same as the mock function, as long as it's safe to do so - nice, huh? ## Invoking a Function/Method/Functor Without Arguments ## `Invoke()` is very useful for doing actions that are more complex. It passes the mock function's arguments to the function or functor being invoked such that the callee has the full context of the call to work with. If the invoked function is not interested in some or all of the arguments, it can simply ignore them. Yet, a common pattern is that a test author wants to invoke a function without the arguments of the mock function. `Invoke()` allows her to do that using a wrapper function that throws away the arguments before invoking an underlining nullary function. Needless to say, this can be tedious and obscures the intent of the test. `InvokeWithoutArgs()` solves this problem. It's like `Invoke()` except that it doesn't pass the mock function's arguments to the callee. Here's an example: ``` using ::testing::_; using ::testing::InvokeWithoutArgs; class MockFoo : public Foo { public: MOCK_METHOD1(ComplexJob, bool(int n)); }; bool Job1() { ... } ... MockFoo foo; EXPECT_CALL(foo, ComplexJob(_)) .WillOnce(InvokeWithoutArgs(Job1)); foo.ComplexJob(10); // Invokes Job1(). ``` ## Invoking an Argument of the Mock Function ## Sometimes a mock function will receive a function pointer or a functor (in other words, a "callable") as an argument, e.g. ``` class MockFoo : public Foo { public: MOCK_METHOD2(DoThis, bool(int n, bool (*fp)(int))); }; ``` and you may want to invoke this callable argument: ``` using ::testing::_; ... MockFoo foo; EXPECT_CALL(foo, DoThis(_, _)) .WillOnce(...); // Will execute (*fp)(5), where fp is the // second argument DoThis() receives. ``` Arghh, you need to refer to a mock function argument but C++ has no lambda (yet), so you have to define your own action. :-( Or do you really? Well, Google Mock has an action to solve _exactly_ this problem: ``` InvokeArgument(arg_1, arg_2, ..., arg_m) ``` will invoke the `N`-th (0-based) argument the mock function receives, with `arg_1`, `arg_2`, ..., and `arg_m`. No matter if the argument is a function pointer or a functor, Google Mock handles them both. With that, you could write: ``` using ::testing::_; using ::testing::InvokeArgument; ... EXPECT_CALL(foo, DoThis(_, _)) .WillOnce(InvokeArgument<1>(5)); // Will execute (*fp)(5), where fp is the // second argument DoThis() receives. ``` What if the callable takes an argument by reference? No problem - just wrap it inside `ByRef()`: ``` ... MOCK_METHOD1(Bar, bool(bool (*fp)(int, const Helper&))); ... using ::testing::_; using ::testing::ByRef; using ::testing::InvokeArgument; ... MockFoo foo; Helper helper; ... EXPECT_CALL(foo, Bar(_)) .WillOnce(InvokeArgument<0>(5, ByRef(helper))); // ByRef(helper) guarantees that a reference to helper, not a copy of it, // will be passed to the callable. ``` What if the callable takes an argument by reference and we do **not** wrap the argument in `ByRef()`? Then `InvokeArgument()` will _make a copy_ of the argument, and pass a _reference to the copy_, instead of a reference to the original value, to the callable. This is especially handy when the argument is a temporary value: ``` ... MOCK_METHOD1(DoThat, bool(bool (*f)(const double& x, const string& s))); ... using ::testing::_; using ::testing::InvokeArgument; ... MockFoo foo; ... EXPECT_CALL(foo, DoThat(_)) .WillOnce(InvokeArgument<0>(5.0, string("Hi"))); // Will execute (*f)(5.0, string("Hi")), where f is the function pointer // DoThat() receives. Note that the values 5.0 and string("Hi") are // temporary and dead once the EXPECT_CALL() statement finishes. Yet // it's fine to perform this action later, since a copy of the values // are kept inside the InvokeArgument action. ``` ## Ignoring an Action's Result ## Sometimes you have an action that returns _something_, but you need an action that returns `void` (perhaps you want to use it in a mock function that returns `void`, or perhaps it needs to be used in `DoAll()` and it's not the last in the list). `IgnoreResult()` lets you do that. For example: ``` using ::testing::_; using ::testing::Invoke; using ::testing::Return; int Process(const MyData& data); string DoSomething(); class MockFoo : public Foo { public: MOCK_METHOD1(Abc, void(const MyData& data)); MOCK_METHOD0(Xyz, bool()); }; ... MockFoo foo; EXPECT_CALL(foo, Abc(_)) // .WillOnce(Invoke(Process)); // The above line won't compile as Process() returns int but Abc() needs // to return void. .WillOnce(IgnoreResult(Invoke(Process))); EXPECT_CALL(foo, Xyz()) .WillOnce(DoAll(IgnoreResult(Invoke(DoSomething)), // Ignores the string DoSomething() returns. Return(true))); ``` Note that you **cannot** use `IgnoreResult()` on an action that already returns `void`. Doing so will lead to ugly compiler errors. ## Selecting an Action's Arguments ## Say you have a mock function `Foo()` that takes seven arguments, and you have a custom action that you want to invoke when `Foo()` is called. Trouble is, the custom action only wants three arguments: ``` using ::testing::_; using ::testing::Invoke; ... MOCK_METHOD7(Foo, bool(bool visible, const string& name, int x, int y, const map, double>& weight, double min_weight, double max_wight)); ... bool IsVisibleInQuadrant1(bool visible, int x, int y) { return visible && x >= 0 && y >= 0; } ... EXPECT_CALL(mock, Foo(_, _, _, _, _, _, _)) .WillOnce(Invoke(IsVisibleInQuadrant1)); // Uh, won't compile. :-( ``` To please the compiler God, you can to define an "adaptor" that has the same signature as `Foo()` and calls the custom action with the right arguments: ``` using ::testing::_; using ::testing::Invoke; bool MyIsVisibleInQuadrant1(bool visible, const string& name, int x, int y, const map, double>& weight, double min_weight, double max_wight) { return IsVisibleInQuadrant1(visible, x, y); } ... EXPECT_CALL(mock, Foo(_, _, _, _, _, _, _)) .WillOnce(Invoke(MyIsVisibleInQuadrant1)); // Now it works. ``` But isn't this awkward? Google Mock provides a generic _action adaptor_, so you can spend your time minding more important business than writing your own adaptors. Here's the syntax: ``` WithArgs(action) ``` creates an action that passes the arguments of the mock function at the given indices (0-based) to the inner `action` and performs it. Using `WithArgs`, our original example can be written as: ``` using ::testing::_; using ::testing::Invoke; using ::testing::WithArgs; ... EXPECT_CALL(mock, Foo(_, _, _, _, _, _, _)) .WillOnce(WithArgs<0, 2, 3>(Invoke(IsVisibleInQuadrant1))); // No need to define your own adaptor. ``` For better readability, Google Mock also gives you: * `WithoutArgs(action)` when the inner `action` takes _no_ argument, and * `WithArg(action)` (no `s` after `Arg`) when the inner `action` takes _one_ argument. As you may have realized, `InvokeWithoutArgs(...)` is just syntactic sugar for `WithoutArgs(Inovke(...))`. Here are more tips: * The inner action used in `WithArgs` and friends does not have to be `Invoke()` -- it can be anything. * You can repeat an argument in the argument list if necessary, e.g. `WithArgs<2, 3, 3, 5>(...)`. * You can change the order of the arguments, e.g. `WithArgs<3, 2, 1>(...)`. * The types of the selected arguments do _not_ have to match the signature of the inner action exactly. It works as long as they can be implicitly converted to the corresponding arguments of the inner action. For example, if the 4-th argument of the mock function is an `int` and `my_action` takes a `double`, `WithArg<4>(my_action)` will work. ## Ignoring Arguments in Action Functions ## The selecting-an-action's-arguments recipe showed us one way to make a mock function and an action with incompatible argument lists fit together. The downside is that wrapping the action in `WithArgs<...>()` can get tedious for people writing the tests. If you are defining a function, method, or functor to be used with `Invoke*()`, and you are not interested in some of its arguments, an alternative to `WithArgs` is to declare the uninteresting arguments as `Unused`. This makes the definition less cluttered and less fragile in case the types of the uninteresting arguments change. It could also increase the chance the action function can be reused. For example, given ``` MOCK_METHOD3(Foo, double(const string& label, double x, double y)); MOCK_METHOD3(Bar, double(int index, double x, double y)); ``` instead of ``` using ::testing::_; using ::testing::Invoke; double DistanceToOriginWithLabel(const string& label, double x, double y) { return sqrt(x*x + y*y); } double DistanceToOriginWithIndex(int index, double x, double y) { return sqrt(x*x + y*y); } ... EXEPCT_CALL(mock, Foo("abc", _, _)) .WillOnce(Invoke(DistanceToOriginWithLabel)); EXEPCT_CALL(mock, Bar(5, _, _)) .WillOnce(Invoke(DistanceToOriginWithIndex)); ``` you could write ``` using ::testing::_; using ::testing::Invoke; using ::testing::Unused; double DistanceToOrigin(Unused, double x, double y) { return sqrt(x*x + y*y); } ... EXEPCT_CALL(mock, Foo("abc", _, _)) .WillOnce(Invoke(DistanceToOrigin)); EXEPCT_CALL(mock, Bar(5, _, _)) .WillOnce(Invoke(DistanceToOrigin)); ``` ## Sharing Actions ## Just like matchers, a Google Mock action object consists of a pointer to a ref-counted implementation object. Therefore copying actions is also allowed and very efficient. When the last action that references the implementation object dies, the implementation object will be deleted. If you have some complex action that you want to use again and again, you may not have to build it from scratch everytime. If the action doesn't have an internal state (i.e. if it always does the same thing no matter how many times it has been called), you can assign it to an action variable and use that variable repeatedly. For example: ``` Action set_flag = DoAll(SetArgPointee<0>(5), Return(true)); ... use set_flag in .WillOnce() and .WillRepeatedly() ... ``` However, if the action has its own state, you may be surprised if you share the action object. Suppose you have an action factory `IncrementCounter(init)` which creates an action that increments and returns a counter whose initial value is `init`, using two actions created from the same expression and using a shared action will exihibit different behaviors. Example: ``` EXPECT_CALL(foo, DoThis()) .WillRepeatedly(IncrementCounter(0)); EXPECT_CALL(foo, DoThat()) .WillRepeatedly(IncrementCounter(0)); foo.DoThis(); // Returns 1. foo.DoThis(); // Returns 2. foo.DoThat(); // Returns 1 - Blah() uses a different // counter than Bar()'s. ``` versus ``` Action increment = IncrementCounter(0); EXPECT_CALL(foo, DoThis()) .WillRepeatedly(increment); EXPECT_CALL(foo, DoThat()) .WillRepeatedly(increment); foo.DoThis(); // Returns 1. foo.DoThis(); // Returns 2. foo.DoThat(); // Returns 3 - the counter is shared. ``` # Misc Recipes on Using Google Mock # ## Mocking Methods That Use Move-Only Types ## C++11 introduced move-only types. A move-only-typed value can be moved from one object to another, but cannot be copied. `std::unique_ptr` is probably the most commonly used move-only type. Mocking a method that takes and/or returns move-only types presents some challenges, but nothing insurmountable. This recipe shows you how you can do it. Let’s say we are working on a fictional project that lets one post and share snippets called “buzzes”. Your code uses these types: ``` enum class AccessLevel { kInternal, kPublic }; class Buzz { public: explicit Buzz(AccessLevel access) { … } ... }; class Buzzer { public: virtual ~Buzzer() {} virtual std::unique_ptr MakeBuzz(const std::string& text) = 0; virtual bool ShareBuzz(std::unique_ptr buzz, Time timestamp) = 0; ... }; ``` A `Buzz` object represents a snippet being posted. A class that implements the `Buzzer` interface is capable of creating and sharing `Buzz`. Methods in `Buzzer` may return a `unique_ptr` or take a `unique_ptr`. Now we need to mock `Buzzer` in our tests. To mock a method that returns a move-only type, you just use the familiar `MOCK_METHOD` syntax as usual: ``` class MockBuzzer : public Buzzer { public: MOCK_METHOD1(MakeBuzz, std::unique_ptr(const std::string& text)); … }; ``` However, if you attempt to use the same `MOCK_METHOD` pattern to mock a method that takes a move-only parameter, you’ll get a compiler error currently: ``` // Does NOT compile! MOCK_METHOD2(ShareBuzz, bool(std::unique_ptr buzz, Time timestamp)); ``` While it’s highly desirable to make this syntax just work, it’s not trivial and the work hasn’t been done yet. Fortunately, there is a trick you can apply today to get something that works nearly as well as this. The trick, is to delegate the `ShareBuzz()` method to a mock method (let’s call it `DoShareBuzz()`) that does not take move-only parameters: ``` class MockBuzzer : public Buzzer { public: MOCK_METHOD1(MakeBuzz, std::unique_ptr(const std::string& text)); MOCK_METHOD2(DoShareBuzz, bool(Buzz* buzz, Time timestamp)); bool ShareBuzz(std::unique_ptr buzz, Time timestamp) { return DoShareBuzz(buzz.get(), timestamp); } }; ``` Note that there's no need to define or declare `DoShareBuzz()` in a base class. You only need to define it as a `MOCK_METHOD` in the mock class. Now that we have the mock class defined, we can use it in tests. In the following code examples, we assume that we have defined a `MockBuzzer` object named `mock_buzzer_`: ``` MockBuzzer mock_buzzer_; ``` First let’s see how we can set expectations on the `MakeBuzz()` method, which returns a `unique_ptr`. As usual, if you set an expectation without an action (i.e. the `.WillOnce()` or `.WillRepeated()` clause), when that expectation fires, the default action for that method will be taken. Since `unique_ptr<>` has a default constructor that returns a null `unique_ptr`, that’s what you’ll get if you don’t specify an action: ``` // Use the default action. EXPECT_CALL(mock_buzzer_, MakeBuzz("hello")); // Triggers the previous EXPECT_CALL. EXPECT_EQ(nullptr, mock_buzzer_.MakeBuzz("hello")); ``` If you are not happy with the default action, you can tweak it. Depending on what you need, you may either tweak the default action for a specific (mock object, mock method) combination using `ON_CALL()`, or you may tweak the default action for all mock methods that return a specific type. The usage of `ON_CALL()` is similar to `EXPECT_CALL()`, so we’ll skip it and just explain how to do the latter (tweaking the default action for a specific return type). You do this via the `DefaultValue<>::SetFactory()` and `DefaultValue<>::Clear()` API: ``` // Sets the default action for return type std::unique_ptr to // creating a new Buzz every time. DefaultValue>::SetFactory( [] { return MakeUnique(AccessLevel::kInternal); }); // When this fires, the default action of MakeBuzz() will run, which // will return a new Buzz object. EXPECT_CALL(mock_buzzer_, MakeBuzz("hello")).Times(AnyNumber()); auto buzz1 = mock_buzzer_.MakeBuzz("hello"); auto buzz2 = mock_buzzer_.MakeBuzz("hello"); EXPECT_NE(nullptr, buzz1); EXPECT_NE(nullptr, buzz2); EXPECT_NE(buzz1, buzz2); // Resets the default action for return type std::unique_ptr, // to avoid interfere with other tests. DefaultValue>::Clear(); ``` What if you want the method to do something other than the default action? If you just need to return a pre-defined move-only value, you can use the `Return(ByMove(...))` action: ``` // When this fires, the unique_ptr<> specified by ByMove(...) will // be returned. EXPECT_CALL(mock_buzzer_, MakeBuzz("world")) .WillOnce(Return(ByMove(MakeUnique(AccessLevel::kInternal)))); EXPECT_NE(nullptr, mock_buzzer_.MakeBuzz("world")); ``` Note that `ByMove()` is essential here - if you drop it, the code won’t compile. Quiz time! What do you think will happen if a `Return(ByMove(...))` action is performed more than once (e.g. you write `….WillRepeatedly(Return(ByMove(...)));`)? Come think of it, after the first time the action runs, the source value will be consumed (since it’s a move-only value), so the next time around, there’s no value to move from -- you’ll get a run-time error that `Return(ByMove(...))` can only be run once. If you need your mock method to do more than just moving a pre-defined value, remember that you can always use `Invoke()` to call a lambda or a callable object, which can do pretty much anything you want: ``` EXPECT_CALL(mock_buzzer_, MakeBuzz("x")) .WillRepeatedly(Invoke([](const std::string& text) { return std::make_unique(AccessLevel::kInternal); })); EXPECT_NE(nullptr, mock_buzzer_.MakeBuzz("x")); EXPECT_NE(nullptr, mock_buzzer_.MakeBuzz("x")); ``` Every time this `EXPECT_CALL` fires, a new `unique_ptr` will be created and returned. You cannot do this with `Return(ByMove(...))`. Now there’s one topic we haven’t covered: how do you set expectations on `ShareBuzz()`, which takes a move-only-typed parameter? The answer is you don’t. Instead, you set expectations on the `DoShareBuzz()` mock method (remember that we defined a `MOCK_METHOD` for `DoShareBuzz()`, not `ShareBuzz()`): ``` EXPECT_CALL(mock_buzzer_, DoShareBuzz(NotNull(), _)); // When one calls ShareBuzz() on the MockBuzzer like this, the call is // forwarded to DoShareBuzz(), which is mocked. Therefore this statement // will trigger the above EXPECT_CALL. mock_buzzer_.ShareBuzz(MakeUnique<Buzz>(AccessLevel::kInternal), ::base::Now()); ``` Some of you may have spotted one problem with this approach: the `DoShareBuzz()` mock method differs from the real `ShareBuzz()` method in that it cannot take ownership of the buzz parameter - `ShareBuzz()` will always delete buzz after `DoShareBuzz()` returns. What if you need to save the buzz object somewhere for later use when `ShareBuzz()` is called? Indeed, you'd be stuck. Another problem with the `DoShareBuzz()` we had is that it can surprise people reading or maintaining the test, as one would expect that `DoShareBuzz()` has (logically) the same contract as `ShareBuzz()`. Fortunately, these problems can be fixed with a bit more code. Let's try to get it right this time: ``` class MockBuzzer : public Buzzer { public: MockBuzzer() { // Since DoShareBuzz(buzz, time) is supposed to take ownership of // buzz, define a default behavior for DoShareBuzz(buzz, time) to // delete buzz. ON_CALL(*this, DoShareBuzz(_, _)) .WillByDefault(Invoke([](Buzz* buzz, Time timestamp) { delete buzz; return true; })); } MOCK_METHOD1(MakeBuzz, std::unique_ptr(const std::string& text)); // Takes ownership of buzz. MOCK_METHOD2(DoShareBuzz, bool(Buzz* buzz, Time timestamp)); bool ShareBuzz(std::unique_ptr buzz, Time timestamp) { return DoShareBuzz(buzz.release(), timestamp); } }; ``` Now, the mock `DoShareBuzz()` method is free to save the buzz argument for later use if this is what you want: ``` std::unique_ptr intercepted_buzz; EXPECT_CALL(mock_buzzer_, DoShareBuzz(NotNull(), _)) .WillOnce(Invoke([&intercepted_buzz](Buzz* buzz, Time timestamp) { // Save buzz in intercepted_buzz for analysis later. intercepted_buzz.reset(buzz); return false; })); mock_buzzer_.ShareBuzz(std::make_unique(AccessLevel::kInternal), Now()); EXPECT_NE(nullptr, intercepted_buzz); ``` Using the tricks covered in this recipe, you are now able to mock methods that take and/or return move-only types. Put your newly-acquired power to good use - when you design a new API, you can now feel comfortable using `unique_ptrs` as appropriate, without fearing that doing so will compromise your tests. ## Making the Compilation Faster ## Believe it or not, the _vast majority_ of the time spent on compiling a mock class is in generating its constructor and destructor, as they perform non-trivial tasks (e.g. verification of the expectations). What's more, mock methods with different signatures have different types and thus their constructors/destructors need to be generated by the compiler separately. As a result, if you mock many different types of methods, compiling your mock class can get really slow. If you are experiencing slow compilation, you can move the definition of your mock class' constructor and destructor out of the class body and into a `.cpp` file. This way, even if you `#include` your mock class in N files, the compiler only needs to generate its constructor and destructor once, resulting in a much faster compilation. Let's illustrate the idea using an example. Here's the definition of a mock class before applying this recipe: ``` // File mock_foo.h. ... class MockFoo : public Foo { public: // Since we don't declare the constructor or the destructor, // the compiler will generate them in every translation unit // where this mock class is used. MOCK_METHOD0(DoThis, int()); MOCK_METHOD1(DoThat, bool(const char* str)); ... more mock methods ... }; ``` After the change, it would look like: ``` // File mock_foo.h. ... class MockFoo : public Foo { public: // The constructor and destructor are declared, but not defined, here. MockFoo(); virtual ~MockFoo(); MOCK_METHOD0(DoThis, int()); MOCK_METHOD1(DoThat, bool(const char* str)); ... more mock methods ... }; ``` and ``` // File mock_foo.cpp. #include "path/to/mock_foo.h" // The definitions may appear trivial, but the functions actually do a // lot of things through the constructors/destructors of the member // variables used to implement the mock methods. MockFoo::MockFoo() {} MockFoo::~MockFoo() {} ``` ## Forcing a Verification ## When it's being destoyed, your friendly mock object will automatically verify that all expectations on it have been satisfied, and will generate [Google Test](../../googletest/) failures if not. This is convenient as it leaves you with one less thing to worry about. That is, unless you are not sure if your mock object will be destoyed. How could it be that your mock object won't eventually be destroyed? Well, it might be created on the heap and owned by the code you are testing. Suppose there's a bug in that code and it doesn't delete the mock object properly - you could end up with a passing test when there's actually a bug. Using a heap checker is a good idea and can alleviate the concern, but its implementation may not be 100% reliable. So, sometimes you do want to _force_ Google Mock to verify a mock object before it is (hopefully) destructed. You can do this with `Mock::VerifyAndClearExpectations(&mock_object)`: ``` TEST(MyServerTest, ProcessesRequest) { using ::testing::Mock; MockFoo* const foo = new MockFoo; EXPECT_CALL(*foo, ...)...; // ... other expectations ... // server now owns foo. MyServer server(foo); server.ProcessRequest(...); // In case that server's destructor will forget to delete foo, // this will verify the expectations anyway. Mock::VerifyAndClearExpectations(foo); } // server is destroyed when it goes out of scope here. ``` **Tip:** The `Mock::VerifyAndClearExpectations()` function returns a `bool` to indicate whether the verification was successful (`true` for yes), so you can wrap that function call inside a `ASSERT_TRUE()` if there is no point going further when the verification has failed. ## Using Check Points ## Sometimes you may want to "reset" a mock object at various check points in your test: at each check point, you verify that all existing expectations on the mock object have been satisfied, and then you set some new expectations on it as if it's newly created. This allows you to work with a mock object in "phases" whose sizes are each manageable. One such scenario is that in your test's `SetUp()` function, you may want to put the object you are testing into a certain state, with the help from a mock object. Once in the desired state, you want to clear all expectations on the mock, such that in the `TEST_F` body you can set fresh expectations on it. As you may have figured out, the `Mock::VerifyAndClearExpectations()` function we saw in the previous recipe can help you here. Or, if you are using `ON_CALL()` to set default actions on the mock object and want to clear the default actions as well, use `Mock::VerifyAndClear(&mock_object)` instead. This function does what `Mock::VerifyAndClearExpectations(&mock_object)` does and returns the same `bool`, **plus** it clears the `ON_CALL()` statements on `mock_object` too. Another trick you can use to achieve the same effect is to put the expectations in sequences and insert calls to a dummy "check-point" function at specific places. Then you can verify that the mock function calls do happen at the right time. For example, if you are exercising code: ``` Foo(1); Foo(2); Foo(3); ``` and want to verify that `Foo(1)` and `Foo(3)` both invoke `mock.Bar("a")`, but `Foo(2)` doesn't invoke anything. You can write: ``` using ::testing::MockFunction; TEST(FooTest, InvokesBarCorrectly) { MyMock mock; // Class MockFunction has exactly one mock method. It is named // Call() and has type F. MockFunction check; { InSequence s; EXPECT_CALL(mock, Bar("a")); EXPECT_CALL(check, Call("1")); EXPECT_CALL(check, Call("2")); EXPECT_CALL(mock, Bar("a")); } Foo(1); check.Call("1"); Foo(2); check.Call("2"); Foo(3); } ``` The expectation spec says that the first `Bar("a")` must happen before check point "1", the second `Bar("a")` must happen after check point "2", and nothing should happen between the two check points. The explicit check points make it easy to tell which `Bar("a")` is called by which call to `Foo()`. ## Mocking Destructors ## Sometimes you want to make sure a mock object is destructed at the right time, e.g. after `bar->A()` is called but before `bar->B()` is called. We already know that you can specify constraints on the order of mock function calls, so all we need to do is to mock the destructor of the mock function. This sounds simple, except for one problem: a destructor is a special function with special syntax and special semantics, and the `MOCK_METHOD0` macro doesn't work for it: ``` MOCK_METHOD0(~MockFoo, void()); // Won't compile! ``` The good news is that you can use a simple pattern to achieve the same effect. First, add a mock function `Die()` to your mock class and call it in the destructor, like this: ``` class MockFoo : public Foo { ... // Add the following two lines to the mock class. MOCK_METHOD0(Die, void()); virtual ~MockFoo() { Die(); } }; ``` (If the name `Die()` clashes with an existing symbol, choose another name.) Now, we have translated the problem of testing when a `MockFoo` object dies to testing when its `Die()` method is called: ``` MockFoo* foo = new MockFoo; MockBar* bar = new MockBar; ... { InSequence s; // Expects *foo to die after bar->A() and before bar->B(). EXPECT_CALL(*bar, A()); EXPECT_CALL(*foo, Die()); EXPECT_CALL(*bar, B()); } ``` And that's that. ## Using Google Mock and Threads ## **IMPORTANT NOTE:** What we describe in this recipe is **ONLY** true on platforms where Google Mock is thread-safe. Currently these are only platforms that support the pthreads library (this includes Linux and Mac). To make it thread-safe on other platforms we only need to implement some synchronization operations in `"gtest/internal/gtest-port.h"`. In a **unit** test, it's best if you could isolate and test a piece of code in a single-threaded context. That avoids race conditions and dead locks, and makes debugging your test much easier. Yet many programs are multi-threaded, and sometimes to test something we need to pound on it from more than one thread. Google Mock works for this purpose too. Remember the steps for using a mock: 1. Create a mock object `foo`. 1. Set its default actions and expectations using `ON_CALL()` and `EXPECT_CALL()`. 1. The code under test calls methods of `foo`. 1. Optionally, verify and reset the mock. 1. Destroy the mock yourself, or let the code under test destroy it. The destructor will automatically verify it. If you follow the following simple rules, your mocks and threads can live happily together: * Execute your _test code_ (as opposed to the code being tested) in _one_ thread. This makes your test easy to follow. * Obviously, you can do step #1 without locking. * When doing step #2 and #5, make sure no other thread is accessing `foo`. Obvious too, huh? * #3 and #4 can be done either in one thread or in multiple threads - anyway you want. Google Mock takes care of the locking, so you don't have to do any - unless required by your test logic. If you violate the rules (for example, if you set expectations on a mock while another thread is calling its methods), you get undefined behavior. That's not fun, so don't do it. Google Mock guarantees that the action for a mock function is done in the same thread that called the mock function. For example, in ``` EXPECT_CALL(mock, Foo(1)) .WillOnce(action1); EXPECT_CALL(mock, Foo(2)) .WillOnce(action2); ``` if `Foo(1)` is called in thread 1 and `Foo(2)` is called in thread 2, Google Mock will execute `action1` in thread 1 and `action2` in thread 2. Google Mock does _not_ impose a sequence on actions performed in different threads (doing so may create deadlocks as the actions may need to cooperate). This means that the execution of `action1` and `action2` in the above example _may_ interleave. If this is a problem, you should add proper synchronization logic to `action1` and `action2` to make the test thread-safe. Also, remember that `DefaultValue` is a global resource that potentially affects _all_ living mock objects in your program. Naturally, you won't want to mess with it from multiple threads or when there still are mocks in action. ## Controlling How Much Information Google Mock Prints ## When Google Mock sees something that has the potential of being an error (e.g. a mock function with no expectation is called, a.k.a. an uninteresting call, which is allowed but perhaps you forgot to explicitly ban the call), it prints some warning messages, including the arguments of the function and the return value. Hopefully this will remind you to take a look and see if there is indeed a problem. Sometimes you are confident that your tests are correct and may not appreciate such friendly messages. Some other times, you are debugging your tests or learning about the behavior of the code you are testing, and wish you could observe every mock call that happens (including argument values and the return value). Clearly, one size doesn't fit all. You can control how much Google Mock tells you using the `--gmock_verbose=LEVEL` command-line flag, where `LEVEL` is a string with three possible values: * `info`: Google Mock will print all informational messages, warnings, and errors (most verbose). At this setting, Google Mock will also log any calls to the `ON_CALL/EXPECT_CALL` macros. * `warning`: Google Mock will print both warnings and errors (less verbose). This is the default. * `error`: Google Mock will print errors only (least verbose). Alternatively, you can adjust the value of that flag from within your tests like so: ``` ::testing::FLAGS_gmock_verbose = "error"; ``` Now, judiciously use the right flag to enable Google Mock serve you better! ## Gaining Super Vision into Mock Calls ## You have a test using Google Mock. It fails: Google Mock tells you that some expectations aren't satisfied. However, you aren't sure why: Is there a typo somewhere in the matchers? Did you mess up the order of the `EXPECT_CALL`s? Or is the code under test doing something wrong? How can you find out the cause? Won't it be nice if you have X-ray vision and can actually see the trace of all `EXPECT_CALL`s and mock method calls as they are made? For each call, would you like to see its actual argument values and which `EXPECT_CALL` Google Mock thinks it matches? You can unlock this power by running your test with the `--gmock_verbose=info` flag. For example, given the test program: ``` using testing::_; using testing::HasSubstr; using testing::Return; class MockFoo { public: MOCK_METHOD2(F, void(const string& x, const string& y)); }; TEST(Foo, Bar) { MockFoo mock; EXPECT_CALL(mock, F(_, _)).WillRepeatedly(Return()); EXPECT_CALL(mock, F("a", "b")); EXPECT_CALL(mock, F("c", HasSubstr("d"))); mock.F("a", "good"); mock.F("a", "b"); } ``` if you run it with `--gmock_verbose=info`, you will see this output: ``` [ RUN ] Foo.Bar foo_test.cc:14: EXPECT_CALL(mock, F(_, _)) invoked foo_test.cc:15: EXPECT_CALL(mock, F("a", "b")) invoked foo_test.cc:16: EXPECT_CALL(mock, F("c", HasSubstr("d"))) invoked foo_test.cc:14: Mock function call matches EXPECT_CALL(mock, F(_, _))... Function call: F(@0x7fff7c8dad40"a", @0x7fff7c8dad10"good") foo_test.cc:15: Mock function call matches EXPECT_CALL(mock, F("a", "b"))... Function call: F(@0x7fff7c8dada0"a", @0x7fff7c8dad70"b") foo_test.cc:16: Failure Actual function call count doesn't match EXPECT_CALL(mock, F("c", HasSubstr("d")))... Expected: to be called once Actual: never called - unsatisfied and active [ FAILED ] Foo.Bar ``` Suppose the bug is that the `"c"` in the third `EXPECT_CALL` is a typo and should actually be `"a"`. With the above message, you should see that the actual `F("a", "good")` call is matched by the first `EXPECT_CALL`, not the third as you thought. From that it should be obvious that the third `EXPECT_CALL` is written wrong. Case solved. ## Running Tests in Emacs ## If you build and run your tests in Emacs, the source file locations of Google Mock and [Google Test](../../googletest/) errors will be highlighted. Just press `` on one of them and you'll be taken to the offending line. Or, you can just type `C-x `` to jump to the next error. To make it even easier, you can add the following lines to your `~/.emacs` file: ``` (global-set-key "\M-m" 'compile) ; m is for make (global-set-key [M-down] 'next-error) (global-set-key [M-up] '(lambda () (interactive) (next-error -1))) ``` Then you can type `M-m` to start a build, or `M-up`/`M-down` to move back and forth between errors. ## Fusing Google Mock Source Files ## Google Mock's implementation consists of dozens of files (excluding its own tests). Sometimes you may want them to be packaged up in fewer files instead, such that you can easily copy them to a new machine and start hacking there. For this we provide an experimental Python script `fuse_gmock_files.py` in the `scripts/` directory (starting with release 1.2.0). Assuming you have Python 2.4 or above installed on your machine, just go to that directory and run ``` python fuse_gmock_files.py OUTPUT_DIR ``` and you should see an `OUTPUT_DIR` directory being created with files `gtest/gtest.h`, `gmock/gmock.h`, and `gmock-gtest-all.cc` in it. These three files contain everything you need to use Google Mock (and Google Test). Just copy them to anywhere you want and you are ready to write tests and use mocks. You can use the [scrpts/test/Makefile](../scripts/test/Makefile) file as an example on how to compile your tests against them. # Extending Google Mock # ## Writing New Matchers Quickly ## The `MATCHER*` family of macros can be used to define custom matchers easily. The syntax: ``` MATCHER(name, description_string_expression) { statements; } ``` will define a matcher with the given name that executes the statements, which must return a `bool` to indicate if the match succeeds. Inside the statements, you can refer to the value being matched by `arg`, and refer to its type by `arg_type`. The description string is a `string`-typed expression that documents what the matcher does, and is used to generate the failure message when the match fails. It can (and should) reference the special `bool` variable `negation`, and should evaluate to the description of the matcher when `negation` is `false`, or that of the matcher's negation when `negation` is `true`. For convenience, we allow the description string to be empty (`""`), in which case Google Mock will use the sequence of words in the matcher name as the description. For example: ``` MATCHER(IsDivisibleBy7, "") { return (arg % 7) == 0; } ``` allows you to write ``` // Expects mock_foo.Bar(n) to be called where n is divisible by 7. EXPECT_CALL(mock_foo, Bar(IsDivisibleBy7())); ``` or, ``` using ::testing::Not; ... EXPECT_THAT(some_expression, IsDivisibleBy7()); EXPECT_THAT(some_other_expression, Not(IsDivisibleBy7())); ``` If the above assertions fail, they will print something like: ``` Value of: some_expression Expected: is divisible by 7 Actual: 27 ... Value of: some_other_expression Expected: not (is divisible by 7) Actual: 21 ``` where the descriptions `"is divisible by 7"` and `"not (is divisible by 7)"` are automatically calculated from the matcher name `IsDivisibleBy7`. As you may have noticed, the auto-generated descriptions (especially those for the negation) may not be so great. You can always override them with a string expression of your own: ``` MATCHER(IsDivisibleBy7, std::string(negation ? "isn't" : "is") + " divisible by 7") { return (arg % 7) == 0; } ``` Optionally, you can stream additional information to a hidden argument named `result_listener` to explain the match result. For example, a better definition of `IsDivisibleBy7` is: ``` MATCHER(IsDivisibleBy7, "") { if ((arg % 7) == 0) return true; *result_listener << "the remainder is " << (arg % 7); return false; } ``` With this definition, the above assertion will give a better message: ``` Value of: some_expression Expected: is divisible by 7 Actual: 27 (the remainder is 6) ``` You should let `MatchAndExplain()` print _any additional information_ that can help a user understand the match result. Note that it should explain why the match succeeds in case of a success (unless it's obvious) - this is useful when the matcher is used inside `Not()`. There is no need to print the argument value itself, as Google Mock already prints it for you. **Notes:** 1. The type of the value being matched (`arg_type`) is determined by the context in which you use the matcher and is supplied to you by the compiler, so you don't need to worry about declaring it (nor can you). This allows the matcher to be polymorphic. For example, `IsDivisibleBy7()` can be used to match any type where the value of `(arg % 7) == 0` can be implicitly converted to a `bool`. In the `Bar(IsDivisibleBy7())` example above, if method `Bar()` takes an `int`, `arg_type` will be `int`; if it takes an `unsigned long`, `arg_type` will be `unsigned long`; and so on. 1. Google Mock doesn't guarantee when or how many times a matcher will be invoked. Therefore the matcher logic must be _purely functional_ (i.e. it cannot have any side effect, and the result must not depend on anything other than the value being matched and the matcher parameters). This requirement must be satisfied no matter how you define the matcher (e.g. using one of the methods described in the following recipes). In particular, a matcher can never call a mock function, as that will affect the state of the mock object and Google Mock. ## Writing New Parameterized Matchers Quickly ## Sometimes you'll want to define a matcher that has parameters. For that you can use the macro: ``` MATCHER_P(name, param_name, description_string) { statements; } ``` where the description string can be either `""` or a string expression that references `negation` and `param_name`. For example: ``` MATCHER_P(HasAbsoluteValue, value, "") { return abs(arg) == value; } ``` will allow you to write: ``` EXPECT_THAT(Blah("a"), HasAbsoluteValue(n)); ``` which may lead to this message (assuming `n` is 10): ``` Value of: Blah("a") Expected: has absolute value 10 Actual: -9 ``` Note that both the matcher description and its parameter are printed, making the message human-friendly. In the matcher definition body, you can write `foo_type` to reference the type of a parameter named `foo`. For example, in the body of `MATCHER_P(HasAbsoluteValue, value)` above, you can write `value_type` to refer to the type of `value`. Google Mock also provides `MATCHER_P2`, `MATCHER_P3`, ..., up to `MATCHER_P10` to support multi-parameter matchers: ``` MATCHER_Pk(name, param_1, ..., param_k, description_string) { statements; } ``` Please note that the custom description string is for a particular **instance** of the matcher, where the parameters have been bound to actual values. Therefore usually you'll want the parameter values to be part of the description. Google Mock lets you do that by referencing the matcher parameters in the description string expression. For example, ``` using ::testing::PrintToString; MATCHER_P2(InClosedRange, low, hi, std::string(negation ? "isn't" : "is") + " in range [" + PrintToString(low) + ", " + PrintToString(hi) + "]") { return low <= arg && arg <= hi; } ... EXPECT_THAT(3, InClosedRange(4, 6)); ``` would generate a failure that contains the message: ``` Expected: is in range [4, 6] ``` If you specify `""` as the description, the failure message will contain the sequence of words in the matcher name followed by the parameter values printed as a tuple. For example, ``` MATCHER_P2(InClosedRange, low, hi, "") { ... } ... EXPECT_THAT(3, InClosedRange(4, 6)); ``` would generate a failure that contains the text: ``` Expected: in closed range (4, 6) ``` For the purpose of typing, you can view ``` MATCHER_Pk(Foo, p1, ..., pk, description_string) { ... } ``` as shorthand for ``` template FooMatcherPk Foo(p1_type p1, ..., pk_type pk) { ... } ``` When you write `Foo(v1, ..., vk)`, the compiler infers the types of the parameters `v1`, ..., and `vk` for you. If you are not happy with the result of the type inference, you can specify the types by explicitly instantiating the template, as in `Foo(5, false)`. As said earlier, you don't get to (or need to) specify `arg_type` as that's determined by the context in which the matcher is used. You can assign the result of expression `Foo(p1, ..., pk)` to a variable of type `FooMatcherPk`. This can be useful when composing matchers. Matchers that don't have a parameter or have only one parameter have special types: you can assign `Foo()` to a `FooMatcher`-typed variable, and assign `Foo(p)` to a `FooMatcherP`-typed variable. While you can instantiate a matcher template with reference types, passing the parameters by pointer usually makes your code more readable. If, however, you still want to pass a parameter by reference, be aware that in the failure message generated by the matcher you will see the value of the referenced object but not its address. You can overload matchers with different numbers of parameters: ``` MATCHER_P(Blah, a, description_string_1) { ... } MATCHER_P2(Blah, a, b, description_string_2) { ... } ``` While it's tempting to always use the `MATCHER*` macros when defining a new matcher, you should also consider implementing `MatcherInterface` or using `MakePolymorphicMatcher()` instead (see the recipes that follow), especially if you need to use the matcher a lot. While these approaches require more work, they give you more control on the types of the value being matched and the matcher parameters, which in general leads to better compiler error messages that pay off in the long run. They also allow overloading matchers based on parameter types (as opposed to just based on the number of parameters). ## Writing New Monomorphic Matchers ## A matcher of argument type `T` implements `::testing::MatcherInterface` and does two things: it tests whether a value of type `T` matches the matcher, and can describe what kind of values it matches. The latter ability is used for generating readable error messages when expectations are violated. The interface looks like this: ``` class MatchResultListener { public: ... // Streams x to the underlying ostream; does nothing if the ostream // is NULL. template MatchResultListener& operator<<(const T& x); // Returns the underlying ostream. ::std::ostream* stream(); }; template class MatcherInterface { public: virtual ~MatcherInterface(); // Returns true iff the matcher matches x; also explains the match // result to 'listener'. virtual bool MatchAndExplain(T x, MatchResultListener* listener) const = 0; // Describes this matcher to an ostream. virtual void DescribeTo(::std::ostream* os) const = 0; // Describes the negation of this matcher to an ostream. virtual void DescribeNegationTo(::std::ostream* os) const; }; ``` If you need a custom matcher but `Truly()` is not a good option (for example, you may not be happy with the way `Truly(predicate)` describes itself, or you may want your matcher to be polymorphic as `Eq(value)` is), you can define a matcher to do whatever you want in two steps: first implement the matcher interface, and then define a factory function to create a matcher instance. The second step is not strictly needed but it makes the syntax of using the matcher nicer. For example, you can define a matcher to test whether an `int` is divisible by 7 and then use it like this: ``` using ::testing::MakeMatcher; using ::testing::Matcher; using ::testing::MatcherInterface; using ::testing::MatchResultListener; class DivisibleBy7Matcher : public MatcherInterface { public: virtual bool MatchAndExplain(int n, MatchResultListener* listener) const { return (n % 7) == 0; } virtual void DescribeTo(::std::ostream* os) const { *os << "is divisible by 7"; } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "is not divisible by 7"; } }; inline Matcher DivisibleBy7() { return MakeMatcher(new DivisibleBy7Matcher); } ... EXPECT_CALL(foo, Bar(DivisibleBy7())); ``` You may improve the matcher message by streaming additional information to the `listener` argument in `MatchAndExplain()`: ``` class DivisibleBy7Matcher : public MatcherInterface { public: virtual bool MatchAndExplain(int n, MatchResultListener* listener) const { const int remainder = n % 7; if (remainder != 0) { *listener << "the remainder is " << remainder; } return remainder == 0; } ... }; ``` Then, `EXPECT_THAT(x, DivisibleBy7());` may general a message like this: ``` Value of: x Expected: is divisible by 7 Actual: 23 (the remainder is 2) ``` ## Writing New Polymorphic Matchers ## You've learned how to write your own matchers in the previous recipe. Just one problem: a matcher created using `MakeMatcher()` only works for one particular type of arguments. If you want a _polymorphic_ matcher that works with arguments of several types (for instance, `Eq(x)` can be used to match a `value` as long as `value` == `x` compiles -- `value` and `x` don't have to share the same type), you can learn the trick from `"gmock/gmock-matchers.h"` but it's a bit involved. Fortunately, most of the time you can define a polymorphic matcher easily with the help of `MakePolymorphicMatcher()`. Here's how you can define `NotNull()` as an example: ``` using ::testing::MakePolymorphicMatcher; using ::testing::MatchResultListener; using ::testing::NotNull; using ::testing::PolymorphicMatcher; class NotNullMatcher { public: // To implement a polymorphic matcher, first define a COPYABLE class // that has three members MatchAndExplain(), DescribeTo(), and // DescribeNegationTo(), like the following. // In this example, we want to use NotNull() with any pointer, so // MatchAndExplain() accepts a pointer of any type as its first argument. // In general, you can define MatchAndExplain() as an ordinary method or // a method template, or even overload it. template bool MatchAndExplain(T* p, MatchResultListener* /* listener */) const { return p != NULL; } // Describes the property of a value matching this matcher. void DescribeTo(::std::ostream* os) const { *os << "is not NULL"; } // Describes the property of a value NOT matching this matcher. void DescribeNegationTo(::std::ostream* os) const { *os << "is NULL"; } }; // To construct a polymorphic matcher, pass an instance of the class // to MakePolymorphicMatcher(). Note the return type. inline PolymorphicMatcher NotNull() { return MakePolymorphicMatcher(NotNullMatcher()); } ... EXPECT_CALL(foo, Bar(NotNull())); // The argument must be a non-NULL pointer. ``` **Note:** Your polymorphic matcher class does **not** need to inherit from `MatcherInterface` or any other class, and its methods do **not** need to be virtual. Like in a monomorphic matcher, you may explain the match result by streaming additional information to the `listener` argument in `MatchAndExplain()`. ## Writing New Cardinalities ## A cardinality is used in `Times()` to tell Google Mock how many times you expect a call to occur. It doesn't have to be exact. For example, you can say `AtLeast(5)` or `Between(2, 4)`. If the built-in set of cardinalities doesn't suit you, you are free to define your own by implementing the following interface (in namespace `testing`): ``` class CardinalityInterface { public: virtual ~CardinalityInterface(); // Returns true iff call_count calls will satisfy this cardinality. virtual bool IsSatisfiedByCallCount(int call_count) const = 0; // Returns true iff call_count calls will saturate this cardinality. virtual bool IsSaturatedByCallCount(int call_count) const = 0; // Describes self to an ostream. virtual void DescribeTo(::std::ostream* os) const = 0; }; ``` For example, to specify that a call must occur even number of times, you can write ``` using ::testing::Cardinality; using ::testing::CardinalityInterface; using ::testing::MakeCardinality; class EvenNumberCardinality : public CardinalityInterface { public: virtual bool IsSatisfiedByCallCount(int call_count) const { return (call_count % 2) == 0; } virtual bool IsSaturatedByCallCount(int call_count) const { return false; } virtual void DescribeTo(::std::ostream* os) const { *os << "called even number of times"; } }; Cardinality EvenNumber() { return MakeCardinality(new EvenNumberCardinality); } ... EXPECT_CALL(foo, Bar(3)) .Times(EvenNumber()); ``` ## Writing New Actions Quickly ## If the built-in actions don't work for you, and you find it inconvenient to use `Invoke()`, you can use a macro from the `ACTION*` family to quickly define a new action that can be used in your code as if it's a built-in action. By writing ``` ACTION(name) { statements; } ``` in a namespace scope (i.e. not inside a class or function), you will define an action with the given name that executes the statements. The value returned by `statements` will be used as the return value of the action. Inside the statements, you can refer to the K-th (0-based) argument of the mock function as `argK`. For example: ``` ACTION(IncrementArg1) { return ++(*arg1); } ``` allows you to write ``` ... WillOnce(IncrementArg1()); ``` Note that you don't need to specify the types of the mock function arguments. Rest assured that your code is type-safe though: you'll get a compiler error if `*arg1` doesn't support the `++` operator, or if the type of `++(*arg1)` isn't compatible with the mock function's return type. Another example: ``` ACTION(Foo) { (*arg2)(5); Blah(); *arg1 = 0; return arg0; } ``` defines an action `Foo()` that invokes argument #2 (a function pointer) with 5, calls function `Blah()`, sets the value pointed to by argument #1 to 0, and returns argument #0. For more convenience and flexibility, you can also use the following pre-defined symbols in the body of `ACTION`: | `argK_type` | The type of the K-th (0-based) argument of the mock function | |:------------|:-------------------------------------------------------------| | `args` | All arguments of the mock function as a tuple | | `args_type` | The type of all arguments of the mock function as a tuple | | `return_type` | The return type of the mock function | | `function_type` | The type of the mock function | For example, when using an `ACTION` as a stub action for mock function: ``` int DoSomething(bool flag, int* ptr); ``` we have: | **Pre-defined Symbol** | **Is Bound To** | |:-----------------------|:----------------| | `arg0` | the value of `flag` | | `arg0_type` | the type `bool` | | `arg1` | the value of `ptr` | | `arg1_type` | the type `int*` | | `args` | the tuple `(flag, ptr)` | | `args_type` | the type `::testing::tuple` | | `return_type` | the type `int` | | `function_type` | the type `int(bool, int*)` | ## Writing New Parameterized Actions Quickly ## Sometimes you'll want to parameterize an action you define. For that we have another macro ``` ACTION_P(name, param) { statements; } ``` For example, ``` ACTION_P(Add, n) { return arg0 + n; } ``` will allow you to write ``` // Returns argument #0 + 5. ... WillOnce(Add(5)); ``` For convenience, we use the term _arguments_ for the values used to invoke the mock function, and the term _parameters_ for the values used to instantiate an action. Note that you don't need to provide the type of the parameter either. Suppose the parameter is named `param`, you can also use the Google-Mock-defined symbol `param_type` to refer to the type of the parameter as inferred by the compiler. For example, in the body of `ACTION_P(Add, n)` above, you can write `n_type` for the type of `n`. Google Mock also provides `ACTION_P2`, `ACTION_P3`, and etc to support multi-parameter actions. For example, ``` ACTION_P2(ReturnDistanceTo, x, y) { double dx = arg0 - x; double dy = arg1 - y; return sqrt(dx*dx + dy*dy); } ``` lets you write ``` ... WillOnce(ReturnDistanceTo(5.0, 26.5)); ``` You can view `ACTION` as a degenerated parameterized action where the number of parameters is 0. You can also easily define actions overloaded on the number of parameters: ``` ACTION_P(Plus, a) { ... } ACTION_P2(Plus, a, b) { ... } ``` ## Restricting the Type of an Argument or Parameter in an ACTION ## For maximum brevity and reusability, the `ACTION*` macros don't ask you to provide the types of the mock function arguments and the action parameters. Instead, we let the compiler infer the types for us. Sometimes, however, we may want to be more explicit about the types. There are several tricks to do that. For example: ``` ACTION(Foo) { // Makes sure arg0 can be converted to int. int n = arg0; ... use n instead of arg0 here ... } ACTION_P(Bar, param) { // Makes sure the type of arg1 is const char*. ::testing::StaticAssertTypeEq(); // Makes sure param can be converted to bool. bool flag = param; } ``` where `StaticAssertTypeEq` is a compile-time assertion in Google Test that verifies two types are the same. ## Writing New Action Templates Quickly ## Sometimes you want to give an action explicit template parameters that cannot be inferred from its value parameters. `ACTION_TEMPLATE()` supports that and can be viewed as an extension to `ACTION()` and `ACTION_P*()`. The syntax: ``` ACTION_TEMPLATE(ActionName, HAS_m_TEMPLATE_PARAMS(kind1, name1, ..., kind_m, name_m), AND_n_VALUE_PARAMS(p1, ..., p_n)) { statements; } ``` defines an action template that takes _m_ explicit template parameters and _n_ value parameters, where _m_ is between 1 and 10, and _n_ is between 0 and 10. `name_i` is the name of the i-th template parameter, and `kind_i` specifies whether it's a `typename`, an integral constant, or a template. `p_i` is the name of the i-th value parameter. Example: ``` // DuplicateArg(output) converts the k-th argument of the mock // function to type T and copies it to *output. ACTION_TEMPLATE(DuplicateArg, // Note the comma between int and k: HAS_2_TEMPLATE_PARAMS(int, k, typename, T), AND_1_VALUE_PARAMS(output)) { *output = T(::testing::get(args)); } ``` To create an instance of an action template, write: ``` ActionName(v1, ..., v_n) ``` where the `t`s are the template arguments and the `v`s are the value arguments. The value argument types are inferred by the compiler. For example: ``` using ::testing::_; ... int n; EXPECT_CALL(mock, Foo(_, _)) .WillOnce(DuplicateArg<1, unsigned char>(&n)); ``` If you want to explicitly specify the value argument types, you can provide additional template arguments: ``` ActionName(v1, ..., v_n) ``` where `u_i` is the desired type of `v_i`. `ACTION_TEMPLATE` and `ACTION`/`ACTION_P*` can be overloaded on the number of value parameters, but not on the number of template parameters. Without the restriction, the meaning of the following is unclear: ``` OverloadedAction(x); ``` Are we using a single-template-parameter action where `bool` refers to the type of `x`, or a two-template-parameter action where the compiler is asked to infer the type of `x`? ## Using the ACTION Object's Type ## If you are writing a function that returns an `ACTION` object, you'll need to know its type. The type depends on the macro used to define the action and the parameter types. The rule is relatively simple: | **Given Definition** | **Expression** | **Has Type** | |:---------------------|:---------------|:-------------| | `ACTION(Foo)` | `Foo()` | `FooAction` | | `ACTION_TEMPLATE(Foo, HAS_m_TEMPLATE_PARAMS(...), AND_0_VALUE_PARAMS())` | `Foo()` | `FooAction` | | `ACTION_P(Bar, param)` | `Bar(int_value)` | `BarActionP` | | `ACTION_TEMPLATE(Bar, HAS_m_TEMPLATE_PARAMS(...), AND_1_VALUE_PARAMS(p1))` | `Bar(int_value)` | `FooActionP` | | `ACTION_P2(Baz, p1, p2)` | `Baz(bool_value, int_value)` | `BazActionP2` | | `ACTION_TEMPLATE(Baz, HAS_m_TEMPLATE_PARAMS(...), AND_2_VALUE_PARAMS(p1, p2))` | `Baz(bool_value, int_value)` | `FooActionP2` | | ... | ... | ... | Note that we have to pick different suffixes (`Action`, `ActionP`, `ActionP2`, and etc) for actions with different numbers of value parameters, or the action definitions cannot be overloaded on the number of them. ## Writing New Monomorphic Actions ## While the `ACTION*` macros are very convenient, sometimes they are inappropriate. For example, despite the tricks shown in the previous recipes, they don't let you directly specify the types of the mock function arguments and the action parameters, which in general leads to unoptimized compiler error messages that can baffle unfamiliar users. They also don't allow overloading actions based on parameter types without jumping through some hoops. An alternative to the `ACTION*` macros is to implement `::testing::ActionInterface`, where `F` is the type of the mock function in which the action will be used. For example: ``` template class ActionInterface { public: virtual ~ActionInterface(); // Performs the action. Result is the return type of function type // F, and ArgumentTuple is the tuple of arguments of F. // // For example, if F is int(bool, const string&), then Result would // be int, and ArgumentTuple would be ::testing::tuple. virtual Result Perform(const ArgumentTuple& args) = 0; }; using ::testing::_; using ::testing::Action; using ::testing::ActionInterface; using ::testing::MakeAction; typedef int IncrementMethod(int*); class IncrementArgumentAction : public ActionInterface { public: virtual int Perform(const ::testing::tuple& args) { int* p = ::testing::get<0>(args); // Grabs the first argument. return *p++; } }; Action IncrementArgument() { return MakeAction(new IncrementArgumentAction); } ... EXPECT_CALL(foo, Baz(_)) .WillOnce(IncrementArgument()); int n = 5; foo.Baz(&n); // Should return 5 and change n to 6. ``` ## Writing New Polymorphic Actions ## The previous recipe showed you how to define your own action. This is all good, except that you need to know the type of the function in which the action will be used. Sometimes that can be a problem. For example, if you want to use the action in functions with _different_ types (e.g. like `Return()` and `SetArgPointee()`). If an action can be used in several types of mock functions, we say it's _polymorphic_. The `MakePolymorphicAction()` function template makes it easy to define such an action: ``` namespace testing { template PolymorphicAction MakePolymorphicAction(const Impl& impl); } // namespace testing ``` As an example, let's define an action that returns the second argument in the mock function's argument list. The first step is to define an implementation class: ``` class ReturnSecondArgumentAction { public: template Result Perform(const ArgumentTuple& args) const { // To get the i-th (0-based) argument, use ::testing::get(args). return ::testing::get<1>(args); } }; ``` This implementation class does _not_ need to inherit from any particular class. What matters is that it must have a `Perform()` method template. This method template takes the mock function's arguments as a tuple in a **single** argument, and returns the result of the action. It can be either `const` or not, but must be invokable with exactly one template argument, which is the result type. In other words, you must be able to call `Perform(args)` where `R` is the mock function's return type and `args` is its arguments in a tuple. Next, we use `MakePolymorphicAction()` to turn an instance of the implementation class into the polymorphic action we need. It will be convenient to have a wrapper for this: ``` using ::testing::MakePolymorphicAction; using ::testing::PolymorphicAction; PolymorphicAction ReturnSecondArgument() { return MakePolymorphicAction(ReturnSecondArgumentAction()); } ``` Now, you can use this polymorphic action the same way you use the built-in ones: ``` using ::testing::_; class MockFoo : public Foo { public: MOCK_METHOD2(DoThis, int(bool flag, int n)); MOCK_METHOD3(DoThat, string(int x, const char* str1, const char* str2)); }; ... MockFoo foo; EXPECT_CALL(foo, DoThis(_, _)) .WillOnce(ReturnSecondArgument()); EXPECT_CALL(foo, DoThat(_, _, _)) .WillOnce(ReturnSecondArgument()); ... foo.DoThis(true, 5); // Will return 5. foo.DoThat(1, "Hi", "Bye"); // Will return "Hi". ``` ## Teaching Google Mock How to Print Your Values ## When an uninteresting or unexpected call occurs, Google Mock prints the argument values and the stack trace to help you debug. Assertion macros like `EXPECT_THAT` and `EXPECT_EQ` also print the values in question when the assertion fails. Google Mock and Google Test do this using Google Test's user-extensible value printer. This printer knows how to print built-in C++ types, native arrays, STL containers, and any type that supports the `<<` operator. For other types, it prints the raw bytes in the value and hopes that you the user can figure it out. [Google Test's advanced guide](../../googletest/docs/AdvancedGuide.md#teaching-google-test-how-to-print-your-values) explains how to extend the printer to do a better job at printing your particular type than to dump the bytes. vendor/googletest/gtest-1.7.0/googlemock/docs/DesignDoc.md000066400000000000000000000233041300002025200235370ustar00rootroot00000000000000This page discusses the design of new Google Mock features. # Macros for Defining Actions # ## Problem ## Due to the lack of closures in C++, it currently requires some non-trivial effort to define a custom action in Google Mock. For example, suppose you want to "increment the value pointed to by the second argument of the mock function and return it", you could write: ``` int IncrementArg1(Unused, int* p, Unused) { return ++(*p); } ... WillOnce(Invoke(IncrementArg1)); ``` There are several things unsatisfactory about this approach: * Even though the action only cares about the second argument of the mock function, its definition needs to list other arguments as dummies. This is tedious. * The defined action is usable only in mock functions that takes exactly 3 arguments - an unnecessary restriction. * To use the action, one has to say `Invoke(IncrementArg1)`, which isn't as nice as `IncrementArg1()`. The latter two problems can be overcome using `MakePolymorphicAction()`, but it requires much more boilerplate code: ``` class IncrementArg1Action { public: template Result Perform(const ArgumentTuple& args) const { return ++(*tr1::get<1>(args)); } }; PolymorphicAction IncrementArg1() { return MakePolymorphicAction(IncrementArg1Action()); } ... WillOnce(IncrementArg1()); ``` Our goal is to allow defining custom actions with the least amount of boiler-plate C++ requires. ## Solution ## We propose to introduce a new macro: ``` ACTION(name) { statements; } ``` Using this in a namespace scope will define an action with the given name that executes the statements. Inside the statements, you can refer to the K-th (0-based) argument of the mock function as `argK`. For example: ``` ACTION(IncrementArg1) { return ++(*arg1); } ``` allows you to write ``` ... WillOnce(IncrementArg1()); ``` Note that you don't need to specify the types of the mock function arguments, as brevity is a top design goal here. Rest assured that your code is still type-safe though: you'll get a compiler error if `*arg1` doesn't support the `++` operator, or if the type of `++(*arg1)` isn't compatible with the mock function's return type. Another example: ``` ACTION(Foo) { (*arg2)(5); Blah(); *arg1 = 0; return arg0; } ``` defines an action `Foo()` that invokes argument #2 (a function pointer) with 5, calls function `Blah()`, sets the value pointed to by argument #1 to 0, and returns argument #0. For more convenience and flexibility, you can also use the following pre-defined symbols in the body of `ACTION`: | `argK_type` | The type of the K-th (0-based) argument of the mock function | |:------------|:-------------------------------------------------------------| | `args` | All arguments of the mock function as a tuple | | `args_type` | The type of all arguments of the mock function as a tuple | | `return_type` | The return type of the mock function | | `function_type` | The type of the mock function | For example, when using an `ACTION` as a stub action for mock function: ``` int DoSomething(bool flag, int* ptr); ``` we have: | **Pre-defined Symbol** | **Is Bound To** | |:-----------------------|:----------------| | `arg0` | the value of `flag` | | `arg0_type` | the type `bool` | | `arg1` | the value of `ptr` | | `arg1_type` | the type `int*` | | `args` | the tuple `(flag, ptr)` | | `args_type` | the type `std::tr1::tuple` | | `return_type` | the type `int` | | `function_type` | the type `int(bool, int*)` | ## Parameterized actions ## Sometimes you'll want to parameterize the action. For that we propose another macro ``` ACTION_P(name, param) { statements; } ``` For example, ``` ACTION_P(Add, n) { return arg0 + n; } ``` will allow you to write ``` // Returns argument #0 + 5. ... WillOnce(Add(5)); ``` For convenience, we use the term _arguments_ for the values used to invoke the mock function, and the term _parameters_ for the values used to instantiate an action. Note that you don't need to provide the type of the parameter either. Suppose the parameter is named `param`, you can also use the Google-Mock-defined symbol `param_type` to refer to the type of the parameter as inferred by the compiler. We will also provide `ACTION_P2`, `ACTION_P3`, and etc to support multi-parameter actions. For example, ``` ACTION_P2(ReturnDistanceTo, x, y) { double dx = arg0 - x; double dy = arg1 - y; return sqrt(dx*dx + dy*dy); } ``` lets you write ``` ... WillOnce(ReturnDistanceTo(5.0, 26.5)); ``` You can view `ACTION` as a degenerated parameterized action where the number of parameters is 0. ## Advanced Usages ## ### Overloading Actions ### You can easily define actions overloaded on the number of parameters: ``` ACTION_P(Plus, a) { ... } ACTION_P2(Plus, a, b) { ... } ``` ### Restricting the Type of an Argument or Parameter ### For maximum brevity and reusability, the `ACTION*` macros don't let you specify the types of the mock function arguments and the action parameters. Instead, we let the compiler infer the types for us. Sometimes, however, we may want to be more explicit about the types. There are several tricks to do that. For example: ``` ACTION(Foo) { // Makes sure arg0 can be converted to int. int n = arg0; ... use n instead of arg0 here ... } ACTION_P(Bar, param) { // Makes sure the type of arg1 is const char*. ::testing::StaticAssertTypeEq(); // Makes sure param can be converted to bool. bool flag = param; } ``` where `StaticAssertTypeEq` is a compile-time assertion we plan to add to Google Test (the name is chosen to match `static_assert` in C++0x). ### Using the ACTION Object's Type ### If you are writing a function that returns an `ACTION` object, you'll need to know its type. The type depends on the macro used to define the action and the parameter types. The rule is relatively simple: | **Given Definition** | **Expression** | **Has Type** | |:---------------------|:---------------|:-------------| | `ACTION(Foo)` | `Foo()` | `FooAction` | | `ACTION_P(Bar, param)` | `Bar(int_value)` | `BarActionP` | | `ACTION_P2(Baz, p1, p2)` | `Baz(bool_value, int_value)` | `BazActionP2` | | ... | ... | ... | Note that we have to pick different suffixes (`Action`, `ActionP`, `ActionP2`, and etc) for actions with different numbers of parameters, or the action definitions cannot be overloaded on the number of parameters. ## When to Use ## While the new macros are very convenient, please also consider other means of implementing actions (e.g. via `ActionInterface` or `MakePolymorphicAction()`), especially if you need to use the defined action a lot. While the other approaches require more work, they give you more control on the types of the mock function arguments and the action parameters, which in general leads to better compiler error messages that pay off in the long run. They also allow overloading actions based on parameter types, as opposed to just the number of parameters. ## Related Work ## As you may have realized, the `ACTION*` macros resemble closures (also known as lambda expressions or anonymous functions). Indeed, both of them seek to lower the syntactic overhead for defining a function. C++0x will support lambdas, but they are not part of C++ right now. Some non-standard libraries (most notably BLL or Boost Lambda Library) try to alleviate this problem. However, they are not a good choice for defining actions as: * They are non-standard and not widely installed. Google Mock only depends on standard libraries and `tr1::tuple`, which is part of the new C++ standard and comes with gcc 4+. We want to keep it that way. * They are not trivial to learn. * They will become obsolete when C++0x's lambda feature is widely supported. We don't want to make our users use a dying library. * Since they are based on operators, they are rather ad hoc: you cannot use statements, and you cannot pass the lambda arguments to a function, for example. * They have subtle semantics that easily confuses new users. For example, in expression `_1++ + foo++`, `foo` will be incremented only once where the expression is evaluated, while `_1` will be incremented every time the unnamed function is invoked. This is far from intuitive. `ACTION*` avoid all these problems. ## Future Improvements ## There may be a need for composing `ACTION*` definitions (i.e. invoking another `ACTION` inside the definition of one `ACTION*`). We are not sure we want it yet, as one can get a similar effect by putting `ACTION` definitions in function templates and composing the function templates. We'll revisit this based on user feedback. The reason we don't allow `ACTION*()` inside a function body is that the current C++ standard doesn't allow function-local types to be used to instantiate templates. The upcoming C++0x standard will lift this restriction. Once this feature is widely supported by compilers, we can revisit the implementation and add support for using `ACTION*()` inside a function. C++0x will also support lambda expressions. When they become available, we may want to support using lambdas as actions. # Macros for Defining Matchers # Once the macros for defining actions are implemented, we plan to do the same for matchers: ``` MATCHER(name) { statements; } ``` where you can refer to the value being matched as `arg`. For example, given: ``` MATCHER(IsPositive) { return arg > 0; } ``` you can use `IsPositive()` as a matcher that matches a value iff it is greater than 0. We will also add `MATCHER_P`, `MATCHER_P2`, and etc for parameterized matchers.vendor/googletest/gtest-1.7.0/googlemock/docs/DevGuide.md000066400000000000000000000162341300002025200234000ustar00rootroot00000000000000 If you are interested in understanding the internals of Google Mock, building from source, or contributing ideas or modifications to the project, then this document is for you. # Introduction # First, let's give you some background of the project. ## Licensing ## All Google Mock source and pre-built packages are provided under the [New BSD License](http://www.opensource.org/licenses/bsd-license.php). ## The Google Mock Community ## The Google Mock community exists primarily through the [discussion group](http://groups.google.com/group/googlemock), the [issue tracker](https://github.com/google/googletest/issues) and, to a lesser extent, the [source control repository](../). You are definitely encouraged to contribute to the discussion and you can also help us to keep the effectiveness of the group high by following and promoting the guidelines listed here. ### Please Be Friendly ### Showing courtesy and respect to others is a vital part of the Google culture, and we strongly encourage everyone participating in Google Mock development to join us in accepting nothing less. Of course, being courteous is not the same as failing to constructively disagree with each other, but it does mean that we should be respectful of each other when enumerating the 42 technical reasons that a particular proposal may not be the best choice. There's never a reason to be antagonistic or dismissive toward anyone who is sincerely trying to contribute to a discussion. Sure, C++ testing is serious business and all that, but it's also a lot of fun. Let's keep it that way. Let's strive to be one of the friendliest communities in all of open source. ### Where to Discuss Google Mock ### As always, discuss Google Mock in the official [Google C++ Mocking Framework discussion group](http://groups.google.com/group/googlemock). You don't have to actually submit code in order to sign up. Your participation itself is a valuable contribution. # Working with the Code # If you want to get your hands dirty with the code inside Google Mock, this is the section for you. ## Checking Out the Source from Subversion ## Checking out the Google Mock source is most useful if you plan to tweak it yourself. You check out the source for Google Mock using a [Subversion](http://subversion.tigris.org/) client as you would for any other project hosted on Google Code. Please see the instruction on the [source code access page](../) for how to do it. ## Compiling from Source ## Once you check out the code, you can find instructions on how to compile it in the [README](../README.md) file. ## Testing ## A mocking framework is of no good if itself is not thoroughly tested. Tests should be written for any new code, and changes should be verified to not break existing tests before they are submitted for review. To perform the tests, follow the instructions in [README](http://code.google.com/p/googlemock/source/browse/trunk/README) and verify that there are no failures. # Contributing Code # We are excited that Google Mock is now open source, and hope to get great patches from the community. Before you fire up your favorite IDE and begin hammering away at that new feature, though, please take the time to read this section and understand the process. While it seems rigorous, we want to keep a high standard of quality in the code base. ## Contributor License Agreements ## You must sign a Contributor License Agreement (CLA) before we can accept any code. The CLA protects you and us. * If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html). * If you work for a company that wants to allow you to contribute your work to Google Mock, then you'll need to sign a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html). Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. ## Coding Style ## To keep the source consistent, readable, diffable and easy to merge, we use a fairly rigid coding style, as defined by the [google-styleguide](https://github.com/google/styleguide) project. All patches will be expected to conform to the style outlined [here](https://github.com/google/styleguide/blob/gh-pages/cppguide.xml). ## Submitting Patches ## Please do submit code. Here's what you need to do: 1. Normally you should make your change against the SVN trunk instead of a branch or a tag, as the latter two are for release control and should be treated mostly as read-only. 1. Decide which code you want to submit. A submission should be a set of changes that addresses one issue in the [Google Mock issue tracker](http://code.google.com/p/googlemock/issues/list). Please don't mix more than one logical change per submittal, because it makes the history hard to follow. If you want to make a change that doesn't have a corresponding issue in the issue tracker, please create one. 1. Also, coordinate with team members that are listed on the issue in question. This ensures that work isn't being duplicated and communicating your plan early also generally leads to better patches. 1. Ensure that your code adheres to the [Google Mock source code style](#Coding_Style.md). 1. Ensure that there are unit tests for your code. 1. Sign a Contributor License Agreement. 1. Create a patch file using `svn diff`. 1. We use [Rietveld](http://codereview.appspot.com/) to do web-based code reviews. You can read about the tool [here](https://github.com/rietveld-codereview/rietveld/wiki). When you are ready, upload your patch via Rietveld and notify `googlemock@googlegroups.com` to review it. There are several ways to upload the patch. We recommend using the [upload\_gmock.py](../scripts/upload_gmock.py) script, which you can find in the `scripts/` folder in the SVN trunk. ## Google Mock Committers ## The current members of the Google Mock engineering team are the only committers at present. In the great tradition of eating one's own dogfood, we will be requiring each new Google Mock engineering team member to earn the right to become a committer by following the procedures in this document, writing consistently great code, and demonstrating repeatedly that he or she truly gets the zen of Google Mock. # Release Process # We follow the typical release process for Subversion-based projects: 1. A release branch named `release-X.Y` is created. 1. Bugs are fixed and features are added in trunk; those individual patches are merged into the release branch until it's stable. 1. An individual point release (the `Z` in `X.Y.Z`) is made by creating a tag from the branch. 1. Repeat steps 2 and 3 throughout one release cycle (as determined by features or time). 1. Go back to step 1 to create another release branch and so on. --- This page is based on the [Making GWT Better](http://code.google.com/webtoolkit/makinggwtbetter.html) guide from the [Google Web Toolkit](http://code.google.com/webtoolkit/) project. Except as otherwise [noted](http://code.google.com/policies.html#restrictions), the content of this page is licensed under the [Creative Commons Attribution 2.5 License](http://creativecommons.org/licenses/by/2.5/). vendor/googletest/gtest-1.7.0/googlemock/docs/Documentation.md000066400000000000000000000013761300002025200245160ustar00rootroot00000000000000This page lists all documentation wiki pages for Google Mock **(the SVN trunk version)** - **if you use a released version of Google Mock, please read the documentation for that specific version instead.** * [ForDummies](ForDummies.md) -- start here if you are new to Google Mock. * [CheatSheet](CheatSheet.md) -- a quick reference. * [CookBook](CookBook.md) -- recipes for doing various tasks using Google Mock. * [FrequentlyAskedQuestions](FrequentlyAskedQuestions.md) -- check here before asking a question on the mailing list. To contribute code to Google Mock, read: * [DevGuide](DevGuide.md) -- read this _before_ writing your first patch. * [Pump Manual](../googletest/docs/PumpManual.md) -- how we generate some of Google Mock's source files. vendor/googletest/gtest-1.7.0/googlemock/docs/ForDummies.md000066400000000000000000000725711300002025200237640ustar00rootroot00000000000000 (**Note:** If you get compiler errors that you don't understand, be sure to consult [Google Mock Doctor](FrequentlyAskedQuestions.md#how-am-i-supposed-to-make-sense-of-these-horrible-template-errors).) # What Is Google C++ Mocking Framework? # When you write a prototype or test, often it's not feasible or wise to rely on real objects entirely. A **mock object** implements the same interface as a real object (so it can be used as one), but lets you specify at run time how it will be used and what it should do (which methods will be called? in which order? how many times? with what arguments? what will they return? etc). **Note:** It is easy to confuse the term _fake objects_ with mock objects. Fakes and mocks actually mean very different things in the Test-Driven Development (TDD) community: * **Fake** objects have working implementations, but usually take some shortcut (perhaps to make the operations less expensive), which makes them not suitable for production. An in-memory file system would be an example of a fake. * **Mocks** are objects pre-programmed with _expectations_, which form a specification of the calls they are expected to receive. If all this seems too abstract for you, don't worry - the most important thing to remember is that a mock allows you to check the _interaction_ between itself and code that uses it. The difference between fakes and mocks will become much clearer once you start to use mocks. **Google C++ Mocking Framework** (or **Google Mock** for short) is a library (sometimes we also call it a "framework" to make it sound cool) for creating mock classes and using them. It does to C++ what [jMock](http://www.jmock.org/) and [EasyMock](http://www.easymock.org/) do to Java. Using Google Mock involves three basic steps: 1. Use some simple macros to describe the interface you want to mock, and they will expand to the implementation of your mock class; 1. Create some mock objects and specify its expectations and behavior using an intuitive syntax; 1. Exercise code that uses the mock objects. Google Mock will catch any violation of the expectations as soon as it arises. # Why Google Mock? # While mock objects help you remove unnecessary dependencies in tests and make them fast and reliable, using mocks manually in C++ is _hard_: * Someone has to implement the mocks. The job is usually tedious and error-prone. No wonder people go great distance to avoid it. * The quality of those manually written mocks is a bit, uh, unpredictable. You may see some really polished ones, but you may also see some that were hacked up in a hurry and have all sorts of ad hoc restrictions. * The knowledge you gained from using one mock doesn't transfer to the next. In contrast, Java and Python programmers have some fine mock frameworks, which automate the creation of mocks. As a result, mocking is a proven effective technique and widely adopted practice in those communities. Having the right tool absolutely makes the difference. Google Mock was built to help C++ programmers. It was inspired by [jMock](http://www.jmock.org/) and [EasyMock](http://www.easymock.org/), but designed with C++'s specifics in mind. It is your friend if any of the following problems is bothering you: * You are stuck with a sub-optimal design and wish you had done more prototyping before it was too late, but prototyping in C++ is by no means "rapid". * Your tests are slow as they depend on too many libraries or use expensive resources (e.g. a database). * Your tests are brittle as some resources they use are unreliable (e.g. the network). * You want to test how your code handles a failure (e.g. a file checksum error), but it's not easy to cause one. * You need to make sure that your module interacts with other modules in the right way, but it's hard to observe the interaction; therefore you resort to observing the side effects at the end of the action, which is awkward at best. * You want to "mock out" your dependencies, except that they don't have mock implementations yet; and, frankly, you aren't thrilled by some of those hand-written mocks. We encourage you to use Google Mock as: * a _design_ tool, for it lets you experiment with your interface design early and often. More iterations lead to better designs! * a _testing_ tool to cut your tests' outbound dependencies and probe the interaction between your module and its collaborators. # Getting Started # Using Google Mock is easy! Inside your C++ source file, just #include `"gtest/gtest.h"` and `"gmock/gmock.h"`, and you are ready to go. # A Case for Mock Turtles # Let's look at an example. Suppose you are developing a graphics program that relies on a LOGO-like API for drawing. How would you test that it does the right thing? Well, you can run it and compare the screen with a golden screen snapshot, but let's admit it: tests like this are expensive to run and fragile (What if you just upgraded to a shiny new graphics card that has better anti-aliasing? Suddenly you have to update all your golden images.). It would be too painful if all your tests are like this. Fortunately, you learned about Dependency Injection and know the right thing to do: instead of having your application talk to the drawing API directly, wrap the API in an interface (say, `Turtle`) and code to that interface: ``` class Turtle { ... virtual ~Turtle() {} virtual void PenUp() = 0; virtual void PenDown() = 0; virtual void Forward(int distance) = 0; virtual void Turn(int degrees) = 0; virtual void GoTo(int x, int y) = 0; virtual int GetX() const = 0; virtual int GetY() const = 0; }; ``` (Note that the destructor of `Turtle` **must** be virtual, as is the case for **all** classes you intend to inherit from - otherwise the destructor of the derived class will not be called when you delete an object through a base pointer, and you'll get corrupted program states like memory leaks.) You can control whether the turtle's movement will leave a trace using `PenUp()` and `PenDown()`, and control its movement using `Forward()`, `Turn()`, and `GoTo()`. Finally, `GetX()` and `GetY()` tell you the current position of the turtle. Your program will normally use a real implementation of this interface. In tests, you can use a mock implementation instead. This allows you to easily check what drawing primitives your program is calling, with what arguments, and in which order. Tests written this way are much more robust (they won't break because your new machine does anti-aliasing differently), easier to read and maintain (the intent of a test is expressed in the code, not in some binary images), and run _much, much faster_. # Writing the Mock Class # If you are lucky, the mocks you need to use have already been implemented by some nice people. If, however, you find yourself in the position to write a mock class, relax - Google Mock turns this task into a fun game! (Well, almost.) ## How to Define It ## Using the `Turtle` interface as example, here are the simple steps you need to follow: 1. Derive a class `MockTurtle` from `Turtle`. 1. Take a _virtual_ function of `Turtle` (while it's possible to [mock non-virtual methods using templates](CookBook.md#mocking-nonvirtual-methods), it's much more involved). Count how many arguments it has. 1. In the `public:` section of the child class, write `MOCK_METHODn();` (or `MOCK_CONST_METHODn();` if you are mocking a `const` method), where `n` is the number of the arguments; if you counted wrong, shame on you, and a compiler error will tell you so. 1. Now comes the fun part: you take the function signature, cut-and-paste the _function name_ as the _first_ argument to the macro, and leave what's left as the _second_ argument (in case you're curious, this is the _type of the function_). 1. Repeat until all virtual functions you want to mock are done. After the process, you should have something like: ``` #include "gmock/gmock.h" // Brings in Google Mock. class MockTurtle : public Turtle { public: ... MOCK_METHOD0(PenUp, void()); MOCK_METHOD0(PenDown, void()); MOCK_METHOD1(Forward, void(int distance)); MOCK_METHOD1(Turn, void(int degrees)); MOCK_METHOD2(GoTo, void(int x, int y)); MOCK_CONST_METHOD0(GetX, int()); MOCK_CONST_METHOD0(GetY, int()); }; ``` You don't need to define these mock methods somewhere else - the `MOCK_METHOD*` macros will generate the definitions for you. It's that simple! Once you get the hang of it, you can pump out mock classes faster than your source-control system can handle your check-ins. **Tip:** If even this is too much work for you, you'll find the `gmock_gen.py` tool in Google Mock's `scripts/generator/` directory (courtesy of the [cppclean](http://code.google.com/p/cppclean/) project) useful. This command-line tool requires that you have Python 2.4 installed. You give it a C++ file and the name of an abstract class defined in it, and it will print the definition of the mock class for you. Due to the complexity of the C++ language, this script may not always work, but it can be quite handy when it does. For more details, read the [user documentation](../scripts/generator/README). ## Where to Put It ## When you define a mock class, you need to decide where to put its definition. Some people put it in a `*_test.cc`. This is fine when the interface being mocked (say, `Foo`) is owned by the same person or team. Otherwise, when the owner of `Foo` changes it, your test could break. (You can't really expect `Foo`'s maintainer to fix every test that uses `Foo`, can you?) So, the rule of thumb is: if you need to mock `Foo` and it's owned by others, define the mock class in `Foo`'s package (better, in a `testing` sub-package such that you can clearly separate production code and testing utilities), and put it in a `mock_foo.h`. Then everyone can reference `mock_foo.h` from their tests. If `Foo` ever changes, there is only one copy of `MockFoo` to change, and only tests that depend on the changed methods need to be fixed. Another way to do it: you can introduce a thin layer `FooAdaptor` on top of `Foo` and code to this new interface. Since you own `FooAdaptor`, you can absorb changes in `Foo` much more easily. While this is more work initially, carefully choosing the adaptor interface can make your code easier to write and more readable (a net win in the long run), as you can choose `FooAdaptor` to fit your specific domain much better than `Foo` does. # Using Mocks in Tests # Once you have a mock class, using it is easy. The typical work flow is: 1. Import the Google Mock names from the `testing` namespace such that you can use them unqualified (You only have to do it once per file. Remember that namespaces are a good idea and good for your health.). 1. Create some mock objects. 1. Specify your expectations on them (How many times will a method be called? With what arguments? What should it do? etc.). 1. Exercise some code that uses the mocks; optionally, check the result using Google Test assertions. If a mock method is called more than expected or with wrong arguments, you'll get an error immediately. 1. When a mock is destructed, Google Mock will automatically check whether all expectations on it have been satisfied. Here's an example: ``` #include "path/to/mock-turtle.h" #include "gmock/gmock.h" #include "gtest/gtest.h" using ::testing::AtLeast; // #1 TEST(PainterTest, CanDrawSomething) { MockTurtle turtle; // #2 EXPECT_CALL(turtle, PenDown()) // #3 .Times(AtLeast(1)); Painter painter(&turtle); // #4 EXPECT_TRUE(painter.DrawCircle(0, 0, 10)); } // #5 int main(int argc, char** argv) { // The following line must be executed to initialize Google Mock // (and Google Test) before running the tests. ::testing::InitGoogleMock(&argc, argv); return RUN_ALL_TESTS(); } ``` As you might have guessed, this test checks that `PenDown()` is called at least once. If the `painter` object didn't call this method, your test will fail with a message like this: ``` path/to/my_test.cc:119: Failure Actual function call count doesn't match this expectation: Actually: never called; Expected: called at least once. ``` **Tip 1:** If you run the test from an Emacs buffer, you can hit `` on the line number displayed in the error message to jump right to the failed expectation. **Tip 2:** If your mock objects are never deleted, the final verification won't happen. Therefore it's a good idea to use a heap leak checker in your tests when you allocate mocks on the heap. **Important note:** Google Mock requires expectations to be set **before** the mock functions are called, otherwise the behavior is **undefined**. In particular, you mustn't interleave `EXPECT_CALL()`s and calls to the mock functions. This means `EXPECT_CALL()` should be read as expecting that a call will occur _in the future_, not that a call has occurred. Why does Google Mock work like that? Well, specifying the expectation beforehand allows Google Mock to report a violation as soon as it arises, when the context (stack trace, etc) is still available. This makes debugging much easier. Admittedly, this test is contrived and doesn't do much. You can easily achieve the same effect without using Google Mock. However, as we shall reveal soon, Google Mock allows you to do _much more_ with the mocks. ## Using Google Mock with Any Testing Framework ## If you want to use something other than Google Test (e.g. [CppUnit](http://sourceforge.net/projects/cppunit/) or [CxxTest](http://cxxtest.tigris.org/)) as your testing framework, just change the `main()` function in the previous section to: ``` int main(int argc, char** argv) { // The following line causes Google Mock to throw an exception on failure, // which will be interpreted by your testing framework as a test failure. ::testing::GTEST_FLAG(throw_on_failure) = true; ::testing::InitGoogleMock(&argc, argv); ... whatever your testing framework requires ... } ``` This approach has a catch: it makes Google Mock throw an exception from a mock object's destructor sometimes. With some compilers, this sometimes causes the test program to crash. You'll still be able to notice that the test has failed, but it's not a graceful failure. A better solution is to use Google Test's [event listener API](../../googletest/docs/AdvancedGuide.md#extending-google-test-by-handling-test-events) to report a test failure to your testing framework properly. You'll need to implement the `OnTestPartResult()` method of the event listener interface, but it should be straightforward. If this turns out to be too much work, we suggest that you stick with Google Test, which works with Google Mock seamlessly (in fact, it is technically part of Google Mock.). If there is a reason that you cannot use Google Test, please let us know. # Setting Expectations # The key to using a mock object successfully is to set the _right expectations_ on it. If you set the expectations too strict, your test will fail as the result of unrelated changes. If you set them too loose, bugs can slip through. You want to do it just right such that your test can catch exactly the kind of bugs you intend it to catch. Google Mock provides the necessary means for you to do it "just right." ## General Syntax ## In Google Mock we use the `EXPECT_CALL()` macro to set an expectation on a mock method. The general syntax is: ``` EXPECT_CALL(mock_object, method(matchers)) .Times(cardinality) .WillOnce(action) .WillRepeatedly(action); ``` The macro has two arguments: first the mock object, and then the method and its arguments. Note that the two are separated by a comma (`,`), not a period (`.`). (Why using a comma? The answer is that it was necessary for technical reasons.) The macro can be followed by some optional _clauses_ that provide more information about the expectation. We'll discuss how each clause works in the coming sections. This syntax is designed to make an expectation read like English. For example, you can probably guess that ``` using ::testing::Return;... EXPECT_CALL(turtle, GetX()) .Times(5) .WillOnce(Return(100)) .WillOnce(Return(150)) .WillRepeatedly(Return(200)); ``` says that the `turtle` object's `GetX()` method will be called five times, it will return 100 the first time, 150 the second time, and then 200 every time. Some people like to call this style of syntax a Domain-Specific Language (DSL). **Note:** Why do we use a macro to do this? It serves two purposes: first it makes expectations easily identifiable (either by `grep` or by a human reader), and second it allows Google Mock to include the source file location of a failed expectation in messages, making debugging easier. ## Matchers: What Arguments Do We Expect? ## When a mock function takes arguments, we must specify what arguments we are expecting; for example: ``` // Expects the turtle to move forward by 100 units. EXPECT_CALL(turtle, Forward(100)); ``` Sometimes you may not want to be too specific (Remember that talk about tests being too rigid? Over specification leads to brittle tests and obscures the intent of tests. Therefore we encourage you to specify only what's necessary - no more, no less.). If you care to check that `Forward()` will be called but aren't interested in its actual argument, write `_` as the argument, which means "anything goes": ``` using ::testing::_; ... // Expects the turtle to move forward. EXPECT_CALL(turtle, Forward(_)); ``` `_` is an instance of what we call **matchers**. A matcher is like a predicate and can test whether an argument is what we'd expect. You can use a matcher inside `EXPECT_CALL()` wherever a function argument is expected. A list of built-in matchers can be found in the [CheatSheet](CheatSheet.md). For example, here's the `Ge` (greater than or equal) matcher: ``` using ::testing::Ge;... EXPECT_CALL(turtle, Forward(Ge(100))); ``` This checks that the turtle will be told to go forward by at least 100 units. ## Cardinalities: How Many Times Will It Be Called? ## The first clause we can specify following an `EXPECT_CALL()` is `Times()`. We call its argument a **cardinality** as it tells _how many times_ the call should occur. It allows us to repeat an expectation many times without actually writing it as many times. More importantly, a cardinality can be "fuzzy", just like a matcher can be. This allows a user to express the intent of a test exactly. An interesting special case is when we say `Times(0)`. You may have guessed - it means that the function shouldn't be called with the given arguments at all, and Google Mock will report a Google Test failure whenever the function is (wrongfully) called. We've seen `AtLeast(n)` as an example of fuzzy cardinalities earlier. For the list of built-in cardinalities you can use, see the [CheatSheet](CheatSheet.md). The `Times()` clause can be omitted. **If you omit `Times()`, Google Mock will infer the cardinality for you.** The rules are easy to remember: * If **neither** `WillOnce()` **nor** `WillRepeatedly()` is in the `EXPECT_CALL()`, the inferred cardinality is `Times(1)`. * If there are `n WillOnce()`'s but **no** `WillRepeatedly()`, where `n` >= 1, the cardinality is `Times(n)`. * If there are `n WillOnce()`'s and **one** `WillRepeatedly()`, where `n` >= 0, the cardinality is `Times(AtLeast(n))`. **Quick quiz:** what do you think will happen if a function is expected to be called twice but actually called four times? ## Actions: What Should It Do? ## Remember that a mock object doesn't really have a working implementation? We as users have to tell it what to do when a method is invoked. This is easy in Google Mock. First, if the return type of a mock function is a built-in type or a pointer, the function has a **default action** (a `void` function will just return, a `bool` function will return `false`, and other functions will return 0). In addition, in C++ 11 and above, a mock function whose return type is default-constructible (i.e. has a default constructor) has a default action of returning a default-constructed value. If you don't say anything, this behavior will be used. Second, if a mock function doesn't have a default action, or the default action doesn't suit you, you can specify the action to be taken each time the expectation matches using a series of `WillOnce()` clauses followed by an optional `WillRepeatedly()`. For example, ``` using ::testing::Return;... EXPECT_CALL(turtle, GetX()) .WillOnce(Return(100)) .WillOnce(Return(200)) .WillOnce(Return(300)); ``` This says that `turtle.GetX()` will be called _exactly three times_ (Google Mock inferred this from how many `WillOnce()` clauses we've written, since we didn't explicitly write `Times()`), and will return 100, 200, and 300 respectively. ``` using ::testing::Return;... EXPECT_CALL(turtle, GetY()) .WillOnce(Return(100)) .WillOnce(Return(200)) .WillRepeatedly(Return(300)); ``` says that `turtle.GetY()` will be called _at least twice_ (Google Mock knows this as we've written two `WillOnce()` clauses and a `WillRepeatedly()` while having no explicit `Times()`), will return 100 the first time, 200 the second time, and 300 from the third time on. Of course, if you explicitly write a `Times()`, Google Mock will not try to infer the cardinality itself. What if the number you specified is larger than there are `WillOnce()` clauses? Well, after all `WillOnce()`s are used up, Google Mock will do the _default_ action for the function every time (unless, of course, you have a `WillRepeatedly()`.). What can we do inside `WillOnce()` besides `Return()`? You can return a reference using `ReturnRef(variable)`, or invoke a pre-defined function, among [others](CheatSheet.md#actions). **Important note:** The `EXPECT_CALL()` statement evaluates the action clause only once, even though the action may be performed many times. Therefore you must be careful about side effects. The following may not do what you want: ``` int n = 100; EXPECT_CALL(turtle, GetX()) .Times(4) .WillRepeatedly(Return(n++)); ``` Instead of returning 100, 101, 102, ..., consecutively, this mock function will always return 100 as `n++` is only evaluated once. Similarly, `Return(new Foo)` will create a new `Foo` object when the `EXPECT_CALL()` is executed, and will return the same pointer every time. If you want the side effect to happen every time, you need to define a custom action, which we'll teach in the [CookBook](CookBook.md). Time for another quiz! What do you think the following means? ``` using ::testing::Return;... EXPECT_CALL(turtle, GetY()) .Times(4) .WillOnce(Return(100)); ``` Obviously `turtle.GetY()` is expected to be called four times. But if you think it will return 100 every time, think twice! Remember that one `WillOnce()` clause will be consumed each time the function is invoked and the default action will be taken afterwards. So the right answer is that `turtle.GetY()` will return 100 the first time, but **return 0 from the second time on**, as returning 0 is the default action for `int` functions. ## Using Multiple Expectations ## So far we've only shown examples where you have a single expectation. More realistically, you're going to specify expectations on multiple mock methods, which may be from multiple mock objects. By default, when a mock method is invoked, Google Mock will search the expectations in the **reverse order** they are defined, and stop when an active expectation that matches the arguments is found (you can think of it as "newer rules override older ones."). If the matching expectation cannot take any more calls, you will get an upper-bound-violated failure. Here's an example: ``` using ::testing::_;... EXPECT_CALL(turtle, Forward(_)); // #1 EXPECT_CALL(turtle, Forward(10)) // #2 .Times(2); ``` If `Forward(10)` is called three times in a row, the third time it will be an error, as the last matching expectation (#2) has been saturated. If, however, the third `Forward(10)` call is replaced by `Forward(20)`, then it would be OK, as now #1 will be the matching expectation. **Side note:** Why does Google Mock search for a match in the _reverse_ order of the expectations? The reason is that this allows a user to set up the default expectations in a mock object's constructor or the test fixture's set-up phase and then customize the mock by writing more specific expectations in the test body. So, if you have two expectations on the same method, you want to put the one with more specific matchers **after** the other, or the more specific rule would be shadowed by the more general one that comes after it. ## Ordered vs Unordered Calls ## By default, an expectation can match a call even though an earlier expectation hasn't been satisfied. In other words, the calls don't have to occur in the order the expectations are specified. Sometimes, you may want all the expected calls to occur in a strict order. To say this in Google Mock is easy: ``` using ::testing::InSequence;... TEST(FooTest, DrawsLineSegment) { ... { InSequence dummy; EXPECT_CALL(turtle, PenDown()); EXPECT_CALL(turtle, Forward(100)); EXPECT_CALL(turtle, PenUp()); } Foo(); } ``` By creating an object of type `InSequence`, all expectations in its scope are put into a _sequence_ and have to occur _sequentially_. Since we are just relying on the constructor and destructor of this object to do the actual work, its name is really irrelevant. In this example, we test that `Foo()` calls the three expected functions in the order as written. If a call is made out-of-order, it will be an error. (What if you care about the relative order of some of the calls, but not all of them? Can you specify an arbitrary partial order? The answer is ... yes! If you are impatient, the details can be found in the [CookBook](CookBook#Expecting_Partially_Ordered_Calls.md).) ## All Expectations Are Sticky (Unless Said Otherwise) ## Now let's do a quick quiz to see how well you can use this mock stuff already. How would you test that the turtle is asked to go to the origin _exactly twice_ (you want to ignore any other instructions it receives)? After you've come up with your answer, take a look at ours and compare notes (solve it yourself first - don't cheat!): ``` using ::testing::_;... EXPECT_CALL(turtle, GoTo(_, _)) // #1 .Times(AnyNumber()); EXPECT_CALL(turtle, GoTo(0, 0)) // #2 .Times(2); ``` Suppose `turtle.GoTo(0, 0)` is called three times. In the third time, Google Mock will see that the arguments match expectation #2 (remember that we always pick the last matching expectation). Now, since we said that there should be only two such calls, Google Mock will report an error immediately. This is basically what we've told you in the "Using Multiple Expectations" section above. This example shows that **expectations in Google Mock are "sticky" by default**, in the sense that they remain active even after we have reached their invocation upper bounds. This is an important rule to remember, as it affects the meaning of the spec, and is **different** to how it's done in many other mocking frameworks (Why'd we do that? Because we think our rule makes the common cases easier to express and understand.). Simple? Let's see if you've really understood it: what does the following code say? ``` using ::testing::Return; ... for (int i = n; i > 0; i--) { EXPECT_CALL(turtle, GetX()) .WillOnce(Return(10*i)); } ``` If you think it says that `turtle.GetX()` will be called `n` times and will return 10, 20, 30, ..., consecutively, think twice! The problem is that, as we said, expectations are sticky. So, the second time `turtle.GetX()` is called, the last (latest) `EXPECT_CALL()` statement will match, and will immediately lead to an "upper bound exceeded" error - this piece of code is not very useful! One correct way of saying that `turtle.GetX()` will return 10, 20, 30, ..., is to explicitly say that the expectations are _not_ sticky. In other words, they should _retire_ as soon as they are saturated: ``` using ::testing::Return; ... for (int i = n; i > 0; i--) { EXPECT_CALL(turtle, GetX()) .WillOnce(Return(10*i)) .RetiresOnSaturation(); } ``` And, there's a better way to do it: in this case, we expect the calls to occur in a specific order, and we line up the actions to match the order. Since the order is important here, we should make it explicit using a sequence: ``` using ::testing::InSequence; using ::testing::Return; ... { InSequence s; for (int i = 1; i <= n; i++) { EXPECT_CALL(turtle, GetX()) .WillOnce(Return(10*i)) .RetiresOnSaturation(); } } ``` By the way, the other situation where an expectation may _not_ be sticky is when it's in a sequence - as soon as another expectation that comes after it in the sequence has been used, it automatically retires (and will never be used to match any call). ## Uninteresting Calls ## A mock object may have many methods, and not all of them are that interesting. For example, in some tests we may not care about how many times `GetX()` and `GetY()` get called. In Google Mock, if you are not interested in a method, just don't say anything about it. If a call to this method occurs, you'll see a warning in the test output, but it won't be a failure. # What Now? # Congratulations! You've learned enough about Google Mock to start using it. Now, you might want to join the [googlemock](http://groups.google.com/group/googlemock) discussion group and actually write some tests using Google Mock - it will be fun. Hey, it may even be addictive - you've been warned. Then, if you feel like increasing your mock quotient, you should move on to the [CookBook](CookBook.md). You can learn many advanced features of Google Mock there -- and advance your level of enjoyment and testing bliss. vendor/googletest/gtest-1.7.0/googlemock/docs/FrequentlyAskedQuestions.md000066400000000000000000000555221300002025200267300ustar00rootroot00000000000000 Please send your questions to the [googlemock](http://groups.google.com/group/googlemock) discussion group. If you need help with compiler errors, make sure you have tried [Google Mock Doctor](#How_am_I_supposed_to_make_sense_of_these_horrible_template_error.md) first. ## When I call a method on my mock object, the method for the real object is invoked instead. What's the problem? ## In order for a method to be mocked, it must be _virtual_, unless you use the [high-perf dependency injection technique](CookBook.md#mocking-nonvirtual-methods). ## I wrote some matchers. After I upgraded to a new version of Google Mock, they no longer compile. What's going on? ## After version 1.4.0 of Google Mock was released, we had an idea on how to make it easier to write matchers that can generate informative messages efficiently. We experimented with this idea and liked what we saw. Therefore we decided to implement it. Unfortunately, this means that if you have defined your own matchers by implementing `MatcherInterface` or using `MakePolymorphicMatcher()`, your definitions will no longer compile. Matchers defined using the `MATCHER*` family of macros are not affected. Sorry for the hassle if your matchers are affected. We believe it's in everyone's long-term interest to make this change sooner than later. Fortunately, it's usually not hard to migrate an existing matcher to the new API. Here's what you need to do: If you wrote your matcher like this: ``` // Old matcher definition that doesn't work with the latest // Google Mock. using ::testing::MatcherInterface; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool Matches(MyType value) const { // Returns true if value matches. return value.GetFoo() > 5; } ... }; ``` you'll need to change it to: ``` // New matcher definition that works with the latest Google Mock. using ::testing::MatcherInterface; using ::testing::MatchResultListener; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. return value.GetFoo() > 5; } ... }; ``` (i.e. rename `Matches()` to `MatchAndExplain()` and give it a second argument of type `MatchResultListener*`.) If you were also using `ExplainMatchResultTo()` to improve the matcher message: ``` // Old matcher definition that doesn't work with the lastest // Google Mock. using ::testing::MatcherInterface; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool Matches(MyType value) const { // Returns true if value matches. return value.GetFoo() > 5; } virtual void ExplainMatchResultTo(MyType value, ::std::ostream* os) const { // Prints some helpful information to os to help // a user understand why value matches (or doesn't match). *os << "the Foo property is " << value.GetFoo(); } ... }; ``` you should move the logic of `ExplainMatchResultTo()` into `MatchAndExplain()`, using the `MatchResultListener` argument where the `::std::ostream` was used: ``` // New matcher definition that works with the latest Google Mock. using ::testing::MatcherInterface; using ::testing::MatchResultListener; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. *listener << "the Foo property is " << value.GetFoo(); return value.GetFoo() > 5; } ... }; ``` If your matcher is defined using `MakePolymorphicMatcher()`: ``` // Old matcher definition that doesn't work with the latest // Google Mock. using ::testing::MakePolymorphicMatcher; ... class MyGreatMatcher { public: ... bool Matches(MyType value) const { // Returns true if value matches. return value.GetBar() < 42; } ... }; ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` you should rename the `Matches()` method to `MatchAndExplain()` and add a `MatchResultListener*` argument (the same as what you need to do for matchers defined by implementing `MatcherInterface`): ``` // New matcher definition that works with the latest Google Mock. using ::testing::MakePolymorphicMatcher; using ::testing::MatchResultListener; ... class MyGreatMatcher { public: ... bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. return value.GetBar() < 42; } ... }; ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` If your polymorphic matcher uses `ExplainMatchResultTo()` for better failure messages: ``` // Old matcher definition that doesn't work with the latest // Google Mock. using ::testing::MakePolymorphicMatcher; ... class MyGreatMatcher { public: ... bool Matches(MyType value) const { // Returns true if value matches. return value.GetBar() < 42; } ... }; void ExplainMatchResultTo(const MyGreatMatcher& matcher, MyType value, ::std::ostream* os) { // Prints some helpful information to os to help // a user understand why value matches (or doesn't match). *os << "the Bar property is " << value.GetBar(); } ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` you'll need to move the logic inside `ExplainMatchResultTo()` to `MatchAndExplain()`: ``` // New matcher definition that works with the latest Google Mock. using ::testing::MakePolymorphicMatcher; using ::testing::MatchResultListener; ... class MyGreatMatcher { public: ... bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. *listener << "the Bar property is " << value.GetBar(); return value.GetBar() < 42; } ... }; ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` For more information, you can read these [two](CookBook.md#writing-new-monomorphic-matchers) [recipes](CookBook.md#writing-new-polymorphic-matchers) from the cookbook. As always, you are welcome to post questions on `googlemock@googlegroups.com` if you need any help. ## When using Google Mock, do I have to use Google Test as the testing framework? I have my favorite testing framework and don't want to switch. ## Google Mock works out of the box with Google Test. However, it's easy to configure it to work with any testing framework of your choice. [Here](ForDummies.md#using-google-mock-with-any-testing-framework) is how. ## How am I supposed to make sense of these horrible template errors? ## If you are confused by the compiler errors gcc threw at you, try consulting the _Google Mock Doctor_ tool first. What it does is to scan stdin for gcc error messages, and spit out diagnoses on the problems (we call them diseases) your code has. To "install", run command: ``` alias gmd='/scripts/gmock_doctor.py' ``` To use it, do: ``` 2>&1 | gmd ``` For example: ``` make my_test 2>&1 | gmd ``` Or you can run `gmd` and copy-n-paste gcc's error messages to it. ## Can I mock a variadic function? ## You cannot mock a variadic function (i.e. a function taking ellipsis (`...`) arguments) directly in Google Mock. The problem is that in general, there is _no way_ for a mock object to know how many arguments are passed to the variadic method, and what the arguments' types are. Only the _author of the base class_ knows the protocol, and we cannot look into his head. Therefore, to mock such a function, the _user_ must teach the mock object how to figure out the number of arguments and their types. One way to do it is to provide overloaded versions of the function. Ellipsis arguments are inherited from C and not really a C++ feature. They are unsafe to use and don't work with arguments that have constructors or destructors. Therefore we recommend to avoid them in C++ as much as possible. ## MSVC gives me warning C4301 or C4373 when I define a mock method with a const parameter. Why? ## If you compile this using Microsoft Visual C++ 2005 SP1: ``` class Foo { ... virtual void Bar(const int i) = 0; }; class MockFoo : public Foo { ... MOCK_METHOD1(Bar, void(const int i)); }; ``` You may get the following warning: ``` warning C4301: 'MockFoo::Bar': overriding virtual function only differs from 'Foo::Bar' by const/volatile qualifier ``` This is a MSVC bug. The same code compiles fine with gcc ,for example. If you use Visual C++ 2008 SP1, you would get the warning: ``` warning C4373: 'MockFoo::Bar': virtual function overrides 'Foo::Bar', previous versions of the compiler did not override when parameters only differed by const/volatile qualifiers ``` In C++, if you _declare_ a function with a `const` parameter, the `const` modifier is _ignored_. Therefore, the `Foo` base class above is equivalent to: ``` class Foo { ... virtual void Bar(int i) = 0; // int or const int? Makes no difference. }; ``` In fact, you can _declare_ Bar() with an `int` parameter, and _define_ it with a `const int` parameter. The compiler will still match them up. Since making a parameter `const` is meaningless in the method _declaration_, we recommend to remove it in both `Foo` and `MockFoo`. That should workaround the VC bug. Note that we are talking about the _top-level_ `const` modifier here. If the function parameter is passed by pointer or reference, declaring the _pointee_ or _referee_ as `const` is still meaningful. For example, the following two declarations are _not_ equivalent: ``` void Bar(int* p); // Neither p nor *p is const. void Bar(const int* p); // p is not const, but *p is. ``` ## I have a huge mock class, and Microsoft Visual C++ runs out of memory when compiling it. What can I do? ## We've noticed that when the `/clr` compiler flag is used, Visual C++ uses 5~6 times as much memory when compiling a mock class. We suggest to avoid `/clr` when compiling native C++ mocks. ## I can't figure out why Google Mock thinks my expectations are not satisfied. What should I do? ## You might want to run your test with `--gmock_verbose=info`. This flag lets Google Mock print a trace of every mock function call it receives. By studying the trace, you'll gain insights on why the expectations you set are not met. ## How can I assert that a function is NEVER called? ## ``` EXPECT_CALL(foo, Bar(_)) .Times(0); ``` ## I have a failed test where Google Mock tells me TWICE that a particular expectation is not satisfied. Isn't this redundant? ## When Google Mock detects a failure, it prints relevant information (the mock function arguments, the state of relevant expectations, and etc) to help the user debug. If another failure is detected, Google Mock will do the same, including printing the state of relevant expectations. Sometimes an expectation's state didn't change between two failures, and you'll see the same description of the state twice. They are however _not_ redundant, as they refer to _different points in time_. The fact they are the same _is_ interesting information. ## I get a heap check failure when using a mock object, but using a real object is fine. What can be wrong? ## Does the class (hopefully a pure interface) you are mocking have a virtual destructor? Whenever you derive from a base class, make sure its destructor is virtual. Otherwise Bad Things will happen. Consider the following code: ``` class Base { public: // Not virtual, but should be. ~Base() { ... } ... }; class Derived : public Base { public: ... private: std::string value_; }; ... Base* p = new Derived; ... delete p; // Surprise! ~Base() will be called, but ~Derived() will not // - value_ is leaked. ``` By changing `~Base()` to virtual, `~Derived()` will be correctly called when `delete p` is executed, and the heap checker will be happy. ## The "newer expectations override older ones" rule makes writing expectations awkward. Why does Google Mock do that? ## When people complain about this, often they are referring to code like: ``` // foo.Bar() should be called twice, return 1 the first time, and return // 2 the second time. However, I have to write the expectations in the // reverse order. This sucks big time!!! EXPECT_CALL(foo, Bar()) .WillOnce(Return(2)) .RetiresOnSaturation(); EXPECT_CALL(foo, Bar()) .WillOnce(Return(1)) .RetiresOnSaturation(); ``` The problem is that they didn't pick the **best** way to express the test's intent. By default, expectations don't have to be matched in _any_ particular order. If you want them to match in a certain order, you need to be explicit. This is Google Mock's (and jMock's) fundamental philosophy: it's easy to accidentally over-specify your tests, and we want to make it harder to do so. There are two better ways to write the test spec. You could either put the expectations in sequence: ``` // foo.Bar() should be called twice, return 1 the first time, and return // 2 the second time. Using a sequence, we can write the expectations // in their natural order. { InSequence s; EXPECT_CALL(foo, Bar()) .WillOnce(Return(1)) .RetiresOnSaturation(); EXPECT_CALL(foo, Bar()) .WillOnce(Return(2)) .RetiresOnSaturation(); } ``` or you can put the sequence of actions in the same expectation: ``` // foo.Bar() should be called twice, return 1 the first time, and return // 2 the second time. EXPECT_CALL(foo, Bar()) .WillOnce(Return(1)) .WillOnce(Return(2)) .RetiresOnSaturation(); ``` Back to the original questions: why does Google Mock search the expectations (and `ON_CALL`s) from back to front? Because this allows a user to set up a mock's behavior for the common case early (e.g. in the mock's constructor or the test fixture's set-up phase) and customize it with more specific rules later. If Google Mock searches from front to back, this very useful pattern won't be possible. ## Google Mock prints a warning when a function without EXPECT\_CALL is called, even if I have set its behavior using ON\_CALL. Would it be reasonable not to show the warning in this case? ## When choosing between being neat and being safe, we lean toward the latter. So the answer is that we think it's better to show the warning. Often people write `ON_CALL`s in the mock object's constructor or `SetUp()`, as the default behavior rarely changes from test to test. Then in the test body they set the expectations, which are often different for each test. Having an `ON_CALL` in the set-up part of a test doesn't mean that the calls are expected. If there's no `EXPECT_CALL` and the method is called, it's possibly an error. If we quietly let the call go through without notifying the user, bugs may creep in unnoticed. If, however, you are sure that the calls are OK, you can write ``` EXPECT_CALL(foo, Bar(_)) .WillRepeatedly(...); ``` instead of ``` ON_CALL(foo, Bar(_)) .WillByDefault(...); ``` This tells Google Mock that you do expect the calls and no warning should be printed. Also, you can control the verbosity using the `--gmock_verbose` flag. If you find the output too noisy when debugging, just choose a less verbose level. ## How can I delete the mock function's argument in an action? ## If you find yourself needing to perform some action that's not supported by Google Mock directly, remember that you can define your own actions using [MakeAction()](CookBook.md#writing-new-actions) or [MakePolymorphicAction()](CookBook.md#writing_new_polymorphic_actions), or you can write a stub function and invoke it using [Invoke()](CookBook.md#using-functions_methods_functors). ## MOCK\_METHODn()'s second argument looks funny. Why don't you use the MOCK\_METHODn(Method, return\_type, arg\_1, ..., arg\_n) syntax? ## What?! I think it's beautiful. :-) While which syntax looks more natural is a subjective matter to some extent, Google Mock's syntax was chosen for several practical advantages it has. Try to mock a function that takes a map as an argument: ``` virtual int GetSize(const map& m); ``` Using the proposed syntax, it would be: ``` MOCK_METHOD1(GetSize, int, const map& m); ``` Guess what? You'll get a compiler error as the compiler thinks that `const map& m` are **two**, not one, arguments. To work around this you can use `typedef` to give the map type a name, but that gets in the way of your work. Google Mock's syntax avoids this problem as the function's argument types are protected inside a pair of parentheses: ``` // This compiles fine. MOCK_METHOD1(GetSize, int(const map& m)); ``` You still need a `typedef` if the return type contains an unprotected comma, but that's much rarer. Other advantages include: 1. `MOCK_METHOD1(Foo, int, bool)` can leave a reader wonder whether the method returns `int` or `bool`, while there won't be such confusion using Google Mock's syntax. 1. The way Google Mock describes a function type is nothing new, although many people may not be familiar with it. The same syntax was used in C, and the `function` library in `tr1` uses this syntax extensively. Since `tr1` will become a part of the new version of STL, we feel very comfortable to be consistent with it. 1. The function type syntax is also used in other parts of Google Mock's API (e.g. the action interface) in order to make the implementation tractable. A user needs to learn it anyway in order to utilize Google Mock's more advanced features. We'd as well stick to the same syntax in `MOCK_METHOD*`! ## My code calls a static/global function. Can I mock it? ## You can, but you need to make some changes. In general, if you find yourself needing to mock a static function, it's a sign that your modules are too tightly coupled (and less flexible, less reusable, less testable, etc). You are probably better off defining a small interface and call the function through that interface, which then can be easily mocked. It's a bit of work initially, but usually pays for itself quickly. This Google Testing Blog [post](http://googletesting.blogspot.com/2008/06/defeat-static-cling.html) says it excellently. Check it out. ## My mock object needs to do complex stuff. It's a lot of pain to specify the actions. Google Mock sucks! ## I know it's not a question, but you get an answer for free any way. :-) With Google Mock, you can create mocks in C++ easily. And people might be tempted to use them everywhere. Sometimes they work great, and sometimes you may find them, well, a pain to use. So, what's wrong in the latter case? When you write a test without using mocks, you exercise the code and assert that it returns the correct value or that the system is in an expected state. This is sometimes called "state-based testing". Mocks are great for what some call "interaction-based" testing: instead of checking the system state at the very end, mock objects verify that they are invoked the right way and report an error as soon as it arises, giving you a handle on the precise context in which the error was triggered. This is often more effective and economical to do than state-based testing. If you are doing state-based testing and using a test double just to simulate the real object, you are probably better off using a fake. Using a mock in this case causes pain, as it's not a strong point for mocks to perform complex actions. If you experience this and think that mocks suck, you are just not using the right tool for your problem. Or, you might be trying to solve the wrong problem. :-) ## I got a warning "Uninteresting function call encountered - default action taken.." Should I panic? ## By all means, NO! It's just an FYI. What it means is that you have a mock function, you haven't set any expectations on it (by Google Mock's rule this means that you are not interested in calls to this function and therefore it can be called any number of times), and it is called. That's OK - you didn't say it's not OK to call the function! What if you actually meant to disallow this function to be called, but forgot to write `EXPECT_CALL(foo, Bar()).Times(0)`? While one can argue that it's the user's fault, Google Mock tries to be nice and prints you a note. So, when you see the message and believe that there shouldn't be any uninteresting calls, you should investigate what's going on. To make your life easier, Google Mock prints the function name and arguments when an uninteresting call is encountered. ## I want to define a custom action. Should I use Invoke() or implement the action interface? ## Either way is fine - you want to choose the one that's more convenient for your circumstance. Usually, if your action is for a particular function type, defining it using `Invoke()` should be easier; if your action can be used in functions of different types (e.g. if you are defining `Return(value)`), `MakePolymorphicAction()` is easiest. Sometimes you want precise control on what types of functions the action can be used in, and implementing `ActionInterface` is the way to go here. See the implementation of `Return()` in `include/gmock/gmock-actions.h` for an example. ## I'm using the set-argument-pointee action, and the compiler complains about "conflicting return type specified". What does it mean? ## You got this error as Google Mock has no idea what value it should return when the mock method is called. `SetArgPointee()` says what the side effect is, but doesn't say what the return value should be. You need `DoAll()` to chain a `SetArgPointee()` with a `Return()`. See this [recipe](CookBook.md#mocking_side_effects) for more details and an example. ## My question is not in your FAQ! ## If you cannot find the answer to your question in this FAQ, there are some other resources you can use: 1. read other [documentation](Documentation.md), 1. search the mailing list [archive](http://groups.google.com/group/googlemock/topics), 1. ask it on [googlemock@googlegroups.com](mailto:googlemock@googlegroups.com) and someone will answer it (to prevent spam, we require you to join the [discussion group](http://groups.google.com/group/googlemock) before you can post.). Please note that creating an issue in the [issue tracker](https://github.com/google/googletest/issues) is _not_ a good way to get your answer, as it is monitored infrequently by a very small number of people. When asking a question, it's helpful to provide as much of the following information as possible (people cannot help you if there's not enough information in your question): * the version (or the revision number if you check out from SVN directly) of Google Mock you use (Google Mock is under active development, so it's possible that your problem has been solved in a later version), * your operating system, * the name and version of your compiler, * the complete command line flags you give to your compiler, * the complete compiler error messages (if the question is about compilation), * the _actual_ code (ideally, a minimal but complete program) that has the problem you encounter. vendor/googletest/gtest-1.7.0/googlemock/docs/KnownIssues.md000066400000000000000000000027701300002025200241740ustar00rootroot00000000000000As any non-trivial software system, Google Mock has some known limitations and problems. We are working on improving it, and welcome your help! The follow is a list of issues we know about. ## README contains outdated information on Google Mock's compatibility with other testing frameworks ## The `README` file in release 1.1.0 still says that Google Mock only works with Google Test. Actually, you can configure Google Mock to work with any testing framework you choose. ## Tests failing on machines using Power PC CPUs (e.g. some Macs) ## `gmock_output_test` and `gmock-printers_test` are known to fail with Power PC CPUs. This is due to portability issues with these tests, and is not an indication of problems in Google Mock itself. You can safely ignore them. ## Failed to resolve libgtest.so.0 in tests when built against installed Google Test ## This only applies if you manually built and installed Google Test, and then built a Google Mock against it (either explicitly, or because gtest-config was in your path post-install). In this situation, Libtool has a known issue with certain systems' ldconfig setup: http://article.gmane.org/gmane.comp.sysutils.automake.general/9025 This requires a manual run of "sudo ldconfig" after the "sudo make install" for Google Test before any binaries which link against it can be executed. This isn't a bug in our install, but we should at least have documented it or hacked a work-around into our install. We should have one of these solutions in our next release.vendor/googletest/gtest-1.7.0/googlemock/docs/v1_5/000077500000000000000000000000001300002025200221265ustar00rootroot00000000000000vendor/googletest/gtest-1.7.0/googlemock/docs/v1_5/CheatSheet.md000066400000000000000000000562421300002025200244760ustar00rootroot00000000000000 # Defining a Mock Class # ## Mocking a Normal Class ## Given ``` class Foo { ... virtual ~Foo(); virtual int GetSize() const = 0; virtual string Describe(const char* name) = 0; virtual string Describe(int type) = 0; virtual bool Process(Bar elem, int count) = 0; }; ``` (note that `~Foo()` **must** be virtual) we can define its mock as ``` #include class MockFoo : public Foo { MOCK_CONST_METHOD0(GetSize, int()); MOCK_METHOD1(Describe, string(const char* name)); MOCK_METHOD1(Describe, string(int type)); MOCK_METHOD2(Process, bool(Bar elem, int count)); }; ``` To create a "nice" mock object which ignores all uninteresting calls, or a "strict" mock object, which treats them as failures: ``` NiceMock nice_foo; // The type is a subclass of MockFoo. StrictMock strict_foo; // The type is a subclass of MockFoo. ``` ## Mocking a Class Template ## To mock ``` template class StackInterface { public: ... virtual ~StackInterface(); virtual int GetSize() const = 0; virtual void Push(const Elem& x) = 0; }; ``` (note that `~StackInterface()` **must** be virtual) just append `_T` to the `MOCK_*` macros: ``` template class MockStack : public StackInterface { public: ... MOCK_CONST_METHOD0_T(GetSize, int()); MOCK_METHOD1_T(Push, void(const Elem& x)); }; ``` ## Specifying Calling Conventions for Mock Functions ## If your mock function doesn't use the default calling convention, you can specify it by appending `_WITH_CALLTYPE` to any of the macros described in the previous two sections and supplying the calling convention as the first argument to the macro. For example, ``` MOCK_METHOD_1_WITH_CALLTYPE(STDMETHODCALLTYPE, Foo, bool(int n)); MOCK_CONST_METHOD2_WITH_CALLTYPE(STDMETHODCALLTYPE, Bar, int(double x, double y)); ``` where `STDMETHODCALLTYPE` is defined by `` on Windows. # Using Mocks in Tests # The typical flow is: 1. Import the Google Mock names you need to use. All Google Mock names are in the `testing` namespace unless they are macros or otherwise noted. 1. Create the mock objects. 1. Optionally, set the default actions of the mock objects. 1. Set your expectations on the mock objects (How will they be called? What wil they do?). 1. Exercise code that uses the mock objects; if necessary, check the result using [Google Test](http://code.google.com/p/googletest/) assertions. 1. When a mock objects is destructed, Google Mock automatically verifies that all expectations on it have been satisfied. Here is an example: ``` using ::testing::Return; // #1 TEST(BarTest, DoesThis) { MockFoo foo; // #2 ON_CALL(foo, GetSize()) // #3 .WillByDefault(Return(1)); // ... other default actions ... EXPECT_CALL(foo, Describe(5)) // #4 .Times(3) .WillRepeatedly(Return("Category 5")); // ... other expectations ... EXPECT_EQ("good", MyProductionFunction(&foo)); // #5 } // #6 ``` # Setting Default Actions # Google Mock has a **built-in default action** for any function that returns `void`, `bool`, a numeric value, or a pointer. To customize the default action for functions with return type `T` globally: ``` using ::testing::DefaultValue; DefaultValue::Set(value); // Sets the default value to be returned. // ... use the mocks ... DefaultValue::Clear(); // Resets the default value. ``` To customize the default action for a particular method, use `ON_CALL()`: ``` ON_CALL(mock_object, method(matchers)) .With(multi_argument_matcher) ? .WillByDefault(action); ``` # Setting Expectations # `EXPECT_CALL()` sets **expectations** on a mock method (How will it be called? What will it do?): ``` EXPECT_CALL(mock_object, method(matchers)) .With(multi_argument_matcher) ? .Times(cardinality) ? .InSequence(sequences) * .After(expectations) * .WillOnce(action) * .WillRepeatedly(action) ? .RetiresOnSaturation(); ? ``` If `Times()` is omitted, the cardinality is assumed to be: * `Times(1)` when there is neither `WillOnce()` nor `WillRepeatedly()`; * `Times(n)` when there are `n WillOnce()`s but no `WillRepeatedly()`, where `n` >= 1; or * `Times(AtLeast(n))` when there are `n WillOnce()`s and a `WillRepeatedly()`, where `n` >= 0. A method with no `EXPECT_CALL()` is free to be invoked _any number of times_, and the default action will be taken each time. # Matchers # A **matcher** matches a _single_ argument. You can use it inside `ON_CALL()` or `EXPECT_CALL()`, or use it to validate a value directly: | `EXPECT_THAT(value, matcher)` | Asserts that `value` matches `matcher`. | |:------------------------------|:----------------------------------------| | `ASSERT_THAT(value, matcher)` | The same as `EXPECT_THAT(value, matcher)`, except that it generates a **fatal** failure. | Built-in matchers (where `argument` is the function argument) are divided into several categories: ## Wildcard ## |`_`|`argument` can be any value of the correct type.| |:--|:-----------------------------------------------| |`A()` or `An()`|`argument` can be any value of type `type`. | ## Generic Comparison ## |`Eq(value)` or `value`|`argument == value`| |:---------------------|:------------------| |`Ge(value)` |`argument >= value`| |`Gt(value)` |`argument > value` | |`Le(value)` |`argument <= value`| |`Lt(value)` |`argument < value` | |`Ne(value)` |`argument != value`| |`IsNull()` |`argument` is a `NULL` pointer (raw or smart).| |`NotNull()` |`argument` is a non-null pointer (raw or smart).| |`Ref(variable)` |`argument` is a reference to `variable`.| |`TypedEq(value)`|`argument` has type `type` and is equal to `value`. You may need to use this instead of `Eq(value)` when the mock function is overloaded.| Except `Ref()`, these matchers make a _copy_ of `value` in case it's modified or destructed later. If the compiler complains that `value` doesn't have a public copy constructor, try wrap it in `ByRef()`, e.g. `Eq(ByRef(non_copyable_value))`. If you do that, make sure `non_copyable_value` is not changed afterwards, or the meaning of your matcher will be changed. ## Floating-Point Matchers ## |`DoubleEq(a_double)`|`argument` is a `double` value approximately equal to `a_double`, treating two NaNs as unequal.| |:-------------------|:----------------------------------------------------------------------------------------------| |`FloatEq(a_float)` |`argument` is a `float` value approximately equal to `a_float`, treating two NaNs as unequal. | |`NanSensitiveDoubleEq(a_double)`|`argument` is a `double` value approximately equal to `a_double`, treating two NaNs as equal. | |`NanSensitiveFloatEq(a_float)`|`argument` is a `float` value approximately equal to `a_float`, treating two NaNs as equal. | The above matchers use ULP-based comparison (the same as used in [Google Test](http://code.google.com/p/googletest/)). They automatically pick a reasonable error bound based on the absolute value of the expected value. `DoubleEq()` and `FloatEq()` conform to the IEEE standard, which requires comparing two NaNs for equality to return false. The `NanSensitive*` version instead treats two NaNs as equal, which is often what a user wants. ## String Matchers ## The `argument` can be either a C string or a C++ string object: |`ContainsRegex(string)`|`argument` matches the given regular expression.| |:----------------------|:-----------------------------------------------| |`EndsWith(suffix)` |`argument` ends with string `suffix`. | |`HasSubstr(string)` |`argument` contains `string` as a sub-string. | |`MatchesRegex(string)` |`argument` matches the given regular expression with the match starting at the first character and ending at the last character.| |`StartsWith(prefix)` |`argument` starts with string `prefix`. | |`StrCaseEq(string)` |`argument` is equal to `string`, ignoring case. | |`StrCaseNe(string)` |`argument` is not equal to `string`, ignoring case.| |`StrEq(string)` |`argument` is equal to `string`. | |`StrNe(string)` |`argument` is not equal to `string`. | `StrCaseEq()`, `StrCaseNe()`, `StrEq()`, and `StrNe()` work for wide strings as well. ## Container Matchers ## Most STL-style containers support `==`, so you can use `Eq(expected_container)` or simply `expected_container` to match a container exactly. If you want to write the elements in-line, match them more flexibly, or get more informative messages, you can use: | `Contains(e)` | `argument` contains an element that matches `e`, which can be either a value or a matcher. | |:--------------|:-------------------------------------------------------------------------------------------| |`ElementsAre(e0, e1, ..., en)`|`argument` has `n + 1` elements, where the i-th element matches `ei`, which can be a value or a matcher. 0 to 10 arguments are allowed.| |`ElementsAreArray(array)` or `ElementsAreArray(array, count)`|The same as `ElementsAre()` except that the expected element values/matchers come from a C-style array.| | `ContainerEq(container)` | The same as `Eq(container)` except that the failure message also includes which elements are in one container but not the other. | These matchers can also match: 1. a native array passed by reference (e.g. in `Foo(const int (&a)[5])`), and 1. an array passed as a pointer and a count (e.g. in `Bar(const T* buffer, int len)` -- see [Multi-argument Matchers](#Multiargument_Matchers.md)). where the array may be multi-dimensional (i.e. its elements can be arrays). ## Member Matchers ## |`Field(&class::field, m)`|`argument.field` (or `argument->field` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _class_.| |:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------| |`Key(e)` |`argument.first` matches `e`, which can be either a value or a matcher. E.g. `Contains(Key(Le(5)))` can verify that a `map` contains a key `<= 5`.| |`Pair(m1, m2)` |`argument` is an `std::pair` whose `first` field matches `m1` and `second` field matches `m2`. | |`Property(&class::property, m)`|`argument.property()` (or `argument->property()` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _class_.| ## Matching the Result of a Function or Functor ## |`ResultOf(f, m)`|`f(argument)` matches matcher `m`, where `f` is a function or functor.| |:---------------|:---------------------------------------------------------------------| ## Pointer Matchers ## |`Pointee(m)`|`argument` (either a smart pointer or a raw pointer) points to a value that matches matcher `m`.| |:-----------|:-----------------------------------------------------------------------------------------------| ## Multiargument Matchers ## These are matchers on tuple types. They can be used in `.With()`. The following can be used on functions with two
arguments `x` and `y`: |`Eq()`|`x == y`| |:-----|:-------| |`Ge()`|`x >= y`| |`Gt()`|`x > y` | |`Le()`|`x <= y`| |`Lt()`|`x < y` | |`Ne()`|`x != y`| You can use the following selectors to pick a subset of the arguments (or reorder them) to participate in the matching: |`AllArgs(m)`|Equivalent to `m`. Useful as syntactic sugar in `.With(AllArgs(m))`.| |:-----------|:-------------------------------------------------------------------| |`Args(m)`|The `k` selected (using 0-based indices) arguments match `m`, e.g. `Args<1, 2>(Contains(5))`.| ## Composite Matchers ## You can make a matcher from one or more other matchers: |`AllOf(m1, m2, ..., mn)`|`argument` matches all of the matchers `m1` to `mn`.| |:-----------------------|:---------------------------------------------------| |`AnyOf(m1, m2, ..., mn)`|`argument` matches at least one of the matchers `m1` to `mn`.| |`Not(m)` |`argument` doesn't match matcher `m`. | ## Adapters for Matchers ## |`MatcherCast(m)`|casts matcher `m` to type `Matcher`.| |:------------------|:--------------------------------------| |`SafeMatcherCast(m)`| [safely casts](V1_5_CookBook#Casting_Matchers.md) matcher `m` to type `Matcher`. | |`Truly(predicate)` |`predicate(argument)` returns something considered by C++ to be true, where `predicate` is a function or functor.| ## Matchers as Predicates ## |`Matches(m)`|a unary functor that returns `true` if the argument matches `m`.| |:-----------|:---------------------------------------------------------------| |`ExplainMatchResult(m, value, result_listener)`|returns `true` if `value` matches `m`, explaining the result to `result_listener`.| |`Value(x, m)`|returns `true` if the value of `x` matches `m`. | ## Defining Matchers ## | `MATCHER(IsEven, "") { return (arg % 2) == 0; }` | Defines a matcher `IsEven()` to match an even number. | |:-------------------------------------------------|:------------------------------------------------------| | `MATCHER_P(IsDivisibleBy, n, "") { *result_listener << "where the remainder is " << (arg % n); return (arg % n) == 0; }` | Defines a macher `IsDivisibleBy(n)` to match a number divisible by `n`. | | `MATCHER_P2(IsBetween, a, b, "is between %(a)s and %(b)s") { return a <= arg && arg <= b; }` | Defines a matcher `IsBetween(a, b)` to match a value in the range [`a`, `b`]. | **Notes:** 1. The `MATCHER*` macros cannot be used inside a function or class. 1. The matcher body must be _purely functional_ (i.e. it cannot have any side effect, and the result must not depend on anything other than the value being matched and the matcher parameters). 1. You can use `PrintToString(x)` to convert a value `x` of any type to a string. ## Matchers as Test Assertions ## |`ASSERT_THAT(expression, m)`|Generates a [fatal failure](http://code.google.com/p/googletest/wiki/GoogleTestPrimer#Assertions) if the value of `expression` doesn't match matcher `m`.| |:---------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------| |`EXPECT_THAT(expression, m)`|Generates a non-fatal failure if the value of `expression` doesn't match matcher `m`. | # Actions # **Actions** specify what a mock function should do when invoked. ## Returning a Value ## |`Return()`|Return from a `void` mock function.| |:---------|:----------------------------------| |`Return(value)`|Return `value`. | |`ReturnArg()`|Return the `N`-th (0-based) argument.| |`ReturnNew(a1, ..., ak)`|Return `new T(a1, ..., ak)`; a different object is created each time.| |`ReturnNull()`|Return a null pointer. | |`ReturnRef(variable)`|Return a reference to `variable`. | ## Side Effects ## |`Assign(&variable, value)`|Assign `value` to variable.| |:-------------------------|:--------------------------| | `DeleteArg()` | Delete the `N`-th (0-based) argument, which must be a pointer. | | `SaveArg(pointer)` | Save the `N`-th (0-based) argument to `*pointer`. | | `SetArgReferee(value)` | Assign value to the variable referenced by the `N`-th (0-based) argument. | |`SetArgumentPointee(value)`|Assign `value` to the variable pointed by the `N`-th (0-based) argument.| |`SetArrayArgument(first, last)`|Copies the elements in source range [`first`, `last`) to the array pointed to by the `N`-th (0-based) argument, which can be either a pointer or an iterator. The action does not take ownership of the elements in the source range.| |`SetErrnoAndReturn(error, value)`|Set `errno` to `error` and return `value`.| |`Throw(exception)` |Throws the given exception, which can be any copyable value. Available since v1.1.0.| ## Using a Function or a Functor as an Action ## |`Invoke(f)`|Invoke `f` with the arguments passed to the mock function, where `f` can be a global/static function or a functor.| |:----------|:-----------------------------------------------------------------------------------------------------------------| |`Invoke(object_pointer, &class::method)`|Invoke the {method on the object with the arguments passed to the mock function. | |`InvokeWithoutArgs(f)`|Invoke `f`, which can be a global/static function or a functor. `f` must take no arguments. | |`InvokeWithoutArgs(object_pointer, &class::method)`|Invoke the method on the object, which takes no arguments. | |`InvokeArgument(arg1, arg2, ..., argk)`|Invoke the mock function's `N`-th (0-based) argument, which must be a function or a functor, with the `k` arguments.| The return value of the invoked function is used as the return value of the action. When defining a function or functor to be used with `Invoke*()`, you can declare any unused parameters as `Unused`: ``` double Distance(Unused, double x, double y) { return sqrt(x*x + y*y); } ... EXPECT_CALL(mock, Foo("Hi", _, _)).WillOnce(Invoke(Distance)); ``` In `InvokeArgument(...)`, if an argument needs to be passed by reference, wrap it inside `ByRef()`. For example, ``` InvokeArgument<2>(5, string("Hi"), ByRef(foo)) ``` calls the mock function's #2 argument, passing to it `5` and `string("Hi")` by value, and `foo` by reference. ## Default Action ## |`DoDefault()`|Do the default action (specified by `ON_CALL()` or the built-in one).| |:------------|:--------------------------------------------------------------------| **Note:** due to technical reasons, `DoDefault()` cannot be used inside a composite action - trying to do so will result in a run-time error. ## Composite Actions ## |`DoAll(a1, a2, ..., an)`|Do all actions `a1` to `an` and return the result of `an` in each invocation. The first `n - 1` sub-actions must return void. | |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------| |`IgnoreResult(a)` |Perform action `a` and ignore its result. `a` must not return void. | |`WithArg(a)` |Pass the `N`-th (0-based) argument of the mock function to action `a` and perform it. | |`WithArgs(a)`|Pass the selected (0-based) arguments of the mock function to action `a` and perform it. | |`WithoutArgs(a)` |Perform action `a` without any arguments. | ## Defining Actions ## | `ACTION(Sum) { return arg0 + arg1; }` | Defines an action `Sum()` to return the sum of the mock function's argument #0 and #1. | |:--------------------------------------|:---------------------------------------------------------------------------------------| | `ACTION_P(Plus, n) { return arg0 + n; }` | Defines an action `Plus(n)` to return the sum of the mock function's argument #0 and `n`. | | `ACTION_Pk(Foo, p1, ..., pk) { statements; }` | Defines a parameterized action `Foo(p1, ..., pk)` to execute the given `statements`. | The `ACTION*` macros cannot be used inside a function or class. # Cardinalities # These are used in `Times()` to specify how many times a mock function will be called: |`AnyNumber()`|The function can be called any number of times.| |:------------|:----------------------------------------------| |`AtLeast(n)` |The call is expected at least `n` times. | |`AtMost(n)` |The call is expected at most `n` times. | |`Between(m, n)`|The call is expected between `m` and `n` (inclusive) times.| |`Exactly(n) or n`|The call is expected exactly `n` times. In particular, the call should never happen when `n` is 0.| # Expectation Order # By default, the expectations can be matched in _any_ order. If some or all expectations must be matched in a given order, there are two ways to specify it. They can be used either independently or together. ## The After Clause ## ``` using ::testing::Expectation; ... Expectation init_x = EXPECT_CALL(foo, InitX()); Expectation init_y = EXPECT_CALL(foo, InitY()); EXPECT_CALL(foo, Bar()) .After(init_x, init_y); ``` says that `Bar()` can be called only after both `InitX()` and `InitY()` have been called. If you don't know how many pre-requisites an expectation has when you write it, you can use an `ExpectationSet` to collect them: ``` using ::testing::ExpectationSet; ... ExpectationSet all_inits; for (int i = 0; i < element_count; i++) { all_inits += EXPECT_CALL(foo, InitElement(i)); } EXPECT_CALL(foo, Bar()) .After(all_inits); ``` says that `Bar()` can be called only after all elements have been initialized (but we don't care about which elements get initialized before the others). Modifying an `ExpectationSet` after using it in an `.After()` doesn't affect the meaning of the `.After()`. ## Sequences ## When you have a long chain of sequential expectations, it's easier to specify the order using **sequences**, which don't require you to given each expectation in the chain a different name. All expected
calls in the same sequence must occur in the order they are specified. ``` using ::testing::Sequence; Sequence s1, s2; ... EXPECT_CALL(foo, Reset()) .InSequence(s1, s2) .WillOnce(Return(true)); EXPECT_CALL(foo, GetSize()) .InSequence(s1) .WillOnce(Return(1)); EXPECT_CALL(foo, Describe(A())) .InSequence(s2) .WillOnce(Return("dummy")); ``` says that `Reset()` must be called before _both_ `GetSize()` _and_ `Describe()`, and the latter two can occur in any order. To put many expectations in a sequence conveniently: ``` using ::testing::InSequence; { InSequence dummy; EXPECT_CALL(...)...; EXPECT_CALL(...)...; ... EXPECT_CALL(...)...; } ``` says that all expected calls in the scope of `dummy` must occur in strict order. The name `dummy` is irrelevant.) # Verifying and Resetting a Mock # Google Mock will verify the expectations on a mock object when it is destructed, or you can do it earlier: ``` using ::testing::Mock; ... // Verifies and removes the expectations on mock_obj; // returns true iff successful. Mock::VerifyAndClearExpectations(&mock_obj); ... // Verifies and removes the expectations on mock_obj; // also removes the default actions set by ON_CALL(); // returns true iff successful. Mock::VerifyAndClear(&mock_obj); ``` You can also tell Google Mock that a mock object can be leaked and doesn't need to be verified: ``` Mock::AllowLeak(&mock_obj); ``` # Mock Classes # Google Mock defines a convenient mock class template ``` class MockFunction { public: MOCK_METHODn(Call, R(A1, ..., An)); }; ``` See this [recipe](V1_5_CookBook#Using_Check_Points.md) for one application of it. # Flags # | `--gmock_catch_leaked_mocks=0` | Don't report leaked mock objects as failures. | |:-------------------------------|:----------------------------------------------| | `--gmock_verbose=LEVEL` | Sets the default verbosity level (`info`, `warning`, or `error`) of Google Mock messages. |vendor/googletest/gtest-1.7.0/googlemock/docs/v1_5/CookBook.md000066400000000000000000003257021300002025200241670ustar00rootroot00000000000000 You can find recipes for using Google Mock here. If you haven't yet, please read the [ForDummies](V1_5_ForDummies.md) document first to make sure you understand the basics. **Note:** Google Mock lives in the `testing` name space. For readability, it is recommended to write `using ::testing::Foo;` once in your file before using the name `Foo` defined by Google Mock. We omit such `using` statements in this page for brevity, but you should do it in your own code. # Creating Mock Classes # ## Mocking Private or Protected Methods ## You must always put a mock method definition (`MOCK_METHOD*`) in a `public:` section of the mock class, regardless of the method being mocked being `public`, `protected`, or `private` in the base class. This allows `ON_CALL` and `EXPECT_CALL` to reference the mock function from outside of the mock class. (Yes, C++ allows a subclass to change the access level of a virtual function in the base class.) Example: ``` class Foo { public: ... virtual bool Transform(Gadget* g) = 0; protected: virtual void Resume(); private: virtual int GetTimeOut(); }; class MockFoo : public Foo { public: ... MOCK_METHOD1(Transform, bool(Gadget* g)); // The following must be in the public section, even though the // methods are protected or private in the base class. MOCK_METHOD0(Resume, void()); MOCK_METHOD0(GetTimeOut, int()); }; ``` ## Mocking Overloaded Methods ## You can mock overloaded functions as usual. No special attention is required: ``` class Foo { ... // Must be virtual as we'll inherit from Foo. virtual ~Foo(); // Overloaded on the types and/or numbers of arguments. virtual int Add(Element x); virtual int Add(int times, Element x); // Overloaded on the const-ness of this object. virtual Bar& GetBar(); virtual const Bar& GetBar() const; }; class MockFoo : public Foo { ... MOCK_METHOD1(Add, int(Element x)); MOCK_METHOD2(Add, int(int times, Element x); MOCK_METHOD0(GetBar, Bar&()); MOCK_CONST_METHOD0(GetBar, const Bar&()); }; ``` **Note:** if you don't mock all versions of the overloaded method, the compiler will give you a warning about some methods in the base class being hidden. To fix that, use `using` to bring them in scope: ``` class MockFoo : public Foo { ... using Foo::Add; MOCK_METHOD1(Add, int(Element x)); // We don't want to mock int Add(int times, Element x); ... }; ``` ## Mocking Class Templates ## To mock a class template, append `_T` to the `MOCK_*` macros: ``` template class StackInterface { ... // Must be virtual as we'll inherit from StackInterface. virtual ~StackInterface(); virtual int GetSize() const = 0; virtual void Push(const Elem& x) = 0; }; template class MockStack : public StackInterface { ... MOCK_CONST_METHOD0_T(GetSize, int()); MOCK_METHOD1_T(Push, void(const Elem& x)); }; ``` ## Mocking Nonvirtual Methods ## Google Mock can mock non-virtual functions to be used in what we call _hi-perf dependency injection_. In this case, instead of sharing a common base class with the real class, your mock class will be _unrelated_ to the real class, but contain methods with the same signatures. The syntax for mocking non-virtual methods is the _same_ as mocking virtual methods: ``` // A simple packet stream class. None of its members is virtual. class ConcretePacketStream { public: void AppendPacket(Packet* new_packet); const Packet* GetPacket(size_t packet_number) const; size_t NumberOfPackets() const; ... }; // A mock packet stream class. It inherits from no other, but defines // GetPacket() and NumberOfPackets(). class MockPacketStream { public: MOCK_CONST_METHOD1(GetPacket, const Packet*(size_t packet_number)); MOCK_CONST_METHOD0(NumberOfPackets, size_t()); ... }; ``` Note that the mock class doesn't define `AppendPacket()`, unlike the real class. That's fine as long as the test doesn't need to call it. Next, you need a way to say that you want to use `ConcretePacketStream` in production code, and use `MockPacketStream` in tests. Since the functions are not virtual and the two classes are unrelated, you must specify your choice at _compile time_ (as opposed to run time). One way to do it is to templatize your code that needs to use a packet stream. More specifically, you will give your code a template type argument for the type of the packet stream. In production, you will instantiate your template with `ConcretePacketStream` as the type argument. In tests, you will instantiate the same template with `MockPacketStream`. For example, you may write: ``` template void CreateConnection(PacketStream* stream) { ... } template class PacketReader { public: void ReadPackets(PacketStream* stream, size_t packet_num); }; ``` Then you can use `CreateConnection()` and `PacketReader` in production code, and use `CreateConnection()` and `PacketReader` in tests. ``` MockPacketStream mock_stream; EXPECT_CALL(mock_stream, ...)...; .. set more expectations on mock_stream ... PacketReader reader(&mock_stream); ... exercise reader ... ``` ## Mocking Free Functions ## It's possible to use Google Mock to mock a free function (i.e. a C-style function or a static method). You just need to rewrite your code to use an interface (abstract class). Instead of calling a free function (say, `OpenFile`) directly, introduce an interface for it and have a concrete subclass that calls the free function: ``` class FileInterface { public: ... virtual bool Open(const char* path, const char* mode) = 0; }; class File : public FileInterface { public: ... virtual bool Open(const char* path, const char* mode) { return OpenFile(path, mode); } }; ``` Your code should talk to `FileInterface` to open a file. Now it's easy to mock out the function. This may seem much hassle, but in practice you often have multiple related functions that you can put in the same interface, so the per-function syntactic overhead will be much lower. If you are concerned about the performance overhead incurred by virtual functions, and profiling confirms your concern, you can combine this with the recipe for [mocking non-virtual methods](#Mocking_Nonvirtual_Methods.md). ## Nice Mocks and Strict Mocks ## If a mock method has no `EXPECT_CALL` spec but is called, Google Mock will print a warning about the "uninteresting call". The rationale is: * New methods may be added to an interface after a test is written. We shouldn't fail a test just because a method it doesn't know about is called. * However, this may also mean there's a bug in the test, so Google Mock shouldn't be silent either. If the user believes these calls are harmless, he can add an `EXPECT_CALL()` to suppress the warning. However, sometimes you may want to suppress all "uninteresting call" warnings, while sometimes you may want the opposite, i.e. to treat all of them as errors. Google Mock lets you make the decision on a per-mock-object basis. Suppose your test uses a mock class `MockFoo`: ``` TEST(...) { MockFoo mock_foo; EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... } ``` If a method of `mock_foo` other than `DoThis()` is called, it will be reported by Google Mock as a warning. However, if you rewrite your test to use `NiceMock` instead, the warning will be gone, resulting in a cleaner test output: ``` using ::testing::NiceMock; TEST(...) { NiceMock mock_foo; EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... } ``` `NiceMock` is a subclass of `MockFoo`, so it can be used wherever `MockFoo` is accepted. It also works if `MockFoo`'s constructor takes some arguments, as `NiceMock` "inherits" `MockFoo`'s constructors: ``` using ::testing::NiceMock; TEST(...) { NiceMock mock_foo(5, "hi"); // Calls MockFoo(5, "hi"). EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... } ``` The usage of `StrictMock` is similar, except that it makes all uninteresting calls failures: ``` using ::testing::StrictMock; TEST(...) { StrictMock mock_foo; EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... // The test will fail if a method of mock_foo other than DoThis() // is called. } ``` There are some caveats though (I don't like them just as much as the next guy, but sadly they are side effects of C++'s limitations): 1. `NiceMock` and `StrictMock` only work for mock methods defined using the `MOCK_METHOD*` family of macros **directly** in the `MockFoo` class. If a mock method is defined in a **base class** of `MockFoo`, the "nice" or "strict" modifier may not affect it, depending on the compiler. In particular, nesting `NiceMock` and `StrictMock` (e.g. `NiceMock >`) is **not** supported. 1. The constructors of the base mock (`MockFoo`) cannot have arguments passed by non-const reference, which happens to be banned by the [Google C++ style guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml). 1. During the constructor or destructor of `MockFoo`, the mock object is _not_ nice or strict. This may cause surprises if the constructor or destructor calls a mock method on `this` object. (This behavior, however, is consistent with C++'s general rule: if a constructor or destructor calls a virtual method of `this` object, that method is treated as non-virtual. In other words, to the base class's constructor or destructor, `this` object behaves like an instance of the base class, not the derived class. This rule is required for safety. Otherwise a base constructor may use members of a derived class before they are initialized, or a base destructor may use members of a derived class after they have been destroyed.) Finally, you should be **very cautious** when using this feature, as the decision you make applies to **all** future changes to the mock class. If an important change is made in the interface you are mocking (and thus in the mock class), it could break your tests (if you use `StrictMock`) or let bugs pass through without a warning (if you use `NiceMock`). Therefore, try to specify the mock's behavior using explicit `EXPECT_CALL` first, and only turn to `NiceMock` or `StrictMock` as the last resort. ## Simplifying the Interface without Breaking Existing Code ## Sometimes a method has a long list of arguments that is mostly uninteresting. For example, ``` class LogSink { public: ... virtual void send(LogSeverity severity, const char* full_filename, const char* base_filename, int line, const struct tm* tm_time, const char* message, size_t message_len) = 0; }; ``` This method's argument list is lengthy and hard to work with (let's say that the `message` argument is not even 0-terminated). If we mock it as is, using the mock will be awkward. If, however, we try to simplify this interface, we'll need to fix all clients depending on it, which is often infeasible. The trick is to re-dispatch the method in the mock class: ``` class ScopedMockLog : public LogSink { public: ... virtual void send(LogSeverity severity, const char* full_filename, const char* base_filename, int line, const tm* tm_time, const char* message, size_t message_len) { // We are only interested in the log severity, full file name, and // log message. Log(severity, full_filename, std::string(message, message_len)); } // Implements the mock method: // // void Log(LogSeverity severity, // const string& file_path, // const string& message); MOCK_METHOD3(Log, void(LogSeverity severity, const string& file_path, const string& message)); }; ``` By defining a new mock method with a trimmed argument list, we make the mock class much more user-friendly. ## Alternative to Mocking Concrete Classes ## Often you may find yourself using classes that don't implement interfaces. In order to test your code that uses such a class (let's call it `Concrete`), you may be tempted to make the methods of `Concrete` virtual and then mock it. Try not to do that. Making a non-virtual function virtual is a big decision. It creates an extension point where subclasses can tweak your class' behavior. This weakens your control on the class because now it's harder to maintain the class' invariants. You should make a function virtual only when there is a valid reason for a subclass to override it. Mocking concrete classes directly is problematic as it creates a tight coupling between the class and the tests - any small change in the class may invalidate your tests and make test maintenance a pain. To avoid such problems, many programmers have been practicing "coding to interfaces": instead of talking to the `Concrete` class, your code would define an interface and talk to it. Then you implement that interface as an adaptor on top of `Concrete`. In tests, you can easily mock that interface to observe how your code is doing. This technique incurs some overhead: * You pay the cost of virtual function calls (usually not a problem). * There is more abstraction for the programmers to learn. However, it can also bring significant benefits in addition to better testability: * `Concrete`'s API may not fit your problem domain very well, as you may not be the only client it tries to serve. By designing your own interface, you have a chance to tailor it to your need - you may add higher-level functionalities, rename stuff, etc instead of just trimming the class. This allows you to write your code (user of the interface) in a more natural way, which means it will be more readable, more maintainable, and you'll be more productive. * If `Concrete`'s implementation ever has to change, you don't have to rewrite everywhere it is used. Instead, you can absorb the change in your implementation of the interface, and your other code and tests will be insulated from this change. Some people worry that if everyone is practicing this technique, they will end up writing lots of redundant code. This concern is totally understandable. However, there are two reasons why it may not be the case: * Different projects may need to use `Concrete` in different ways, so the best interfaces for them will be different. Therefore, each of them will have its own domain-specific interface on top of `Concrete`, and they will not be the same code. * If enough projects want to use the same interface, they can always share it, just like they have been sharing `Concrete`. You can check in the interface and the adaptor somewhere near `Concrete` (perhaps in a `contrib` sub-directory) and let many projects use it. You need to weigh the pros and cons carefully for your particular problem, but I'd like to assure you that the Java community has been practicing this for a long time and it's a proven effective technique applicable in a wide variety of situations. :-) ## Delegating Calls to a Fake ## Some times you have a non-trivial fake implementation of an interface. For example: ``` class Foo { public: virtual ~Foo() {} virtual char DoThis(int n) = 0; virtual void DoThat(const char* s, int* p) = 0; }; class FakeFoo : public Foo { public: virtual char DoThis(int n) { return (n > 0) ? '+' : (n < 0) ? '-' : '0'; } virtual void DoThat(const char* s, int* p) { *p = strlen(s); } }; ``` Now you want to mock this interface such that you can set expectations on it. However, you also want to use `FakeFoo` for the default behavior, as duplicating it in the mock object is, well, a lot of work. When you define the mock class using Google Mock, you can have it delegate its default action to a fake class you already have, using this pattern: ``` using ::testing::_; using ::testing::Invoke; class MockFoo : public Foo { public: // Normal mock method definitions using Google Mock. MOCK_METHOD1(DoThis, char(int n)); MOCK_METHOD2(DoThat, void(const char* s, int* p)); // Delegates the default actions of the methods to a FakeFoo object. // This must be called *before* the custom ON_CALL() statements. void DelegateToFake() { ON_CALL(*this, DoThis(_)) .WillByDefault(Invoke(&fake_, &FakeFoo::DoThis)); ON_CALL(*this, DoThat(_, _)) .WillByDefault(Invoke(&fake_, &FakeFoo::DoThat)); } private: FakeFoo fake_; // Keeps an instance of the fake in the mock. }; ``` With that, you can use `MockFoo` in your tests as usual. Just remember that if you don't explicitly set an action in an `ON_CALL()` or `EXPECT_CALL()`, the fake will be called upon to do it: ``` using ::testing::_; TEST(AbcTest, Xyz) { MockFoo foo; foo.DelegateToFake(); // Enables the fake for delegation. // Put your ON_CALL(foo, ...)s here, if any. // No action specified, meaning to use the default action. EXPECT_CALL(foo, DoThis(5)); EXPECT_CALL(foo, DoThat(_, _)); int n = 0; EXPECT_EQ('+', foo.DoThis(5)); // FakeFoo::DoThis() is invoked. foo.DoThat("Hi", &n); // FakeFoo::DoThat() is invoked. EXPECT_EQ(2, n); } ``` **Some tips:** * If you want, you can still override the default action by providing your own `ON_CALL()` or using `.WillOnce()` / `.WillRepeatedly()` in `EXPECT_CALL()`. * In `DelegateToFake()`, you only need to delegate the methods whose fake implementation you intend to use. * The general technique discussed here works for overloaded methods, but you'll need to tell the compiler which version you mean. To disambiguate a mock function (the one you specify inside the parentheses of `ON_CALL()`), see the "Selecting Between Overloaded Functions" section on this page; to disambiguate a fake function (the one you place inside `Invoke()`), use a `static_cast` to specify the function's type. * Having to mix a mock and a fake is often a sign of something gone wrong. Perhaps you haven't got used to the interaction-based way of testing yet. Or perhaps your interface is taking on too many roles and should be split up. Therefore, **don't abuse this**. We would only recommend to do it as an intermediate step when you are refactoring your code. Regarding the tip on mixing a mock and a fake, here's an example on why it may be a bad sign: Suppose you have a class `System` for low-level system operations. In particular, it does file and I/O operations. And suppose you want to test how your code uses `System` to do I/O, and you just want the file operations to work normally. If you mock out the entire `System` class, you'll have to provide a fake implementation for the file operation part, which suggests that `System` is taking on too many roles. Instead, you can define a `FileOps` interface and an `IOOps` interface and split `System`'s functionalities into the two. Then you can mock `IOOps` without mocking `FileOps`. ## Delegating Calls to a Real Object ## When using testing doubles (mocks, fakes, stubs, and etc), sometimes their behaviors will differ from those of the real objects. This difference could be either intentional (as in simulating an error such that you can test the error handling code) or unintentional. If your mocks have different behaviors than the real objects by mistake, you could end up with code that passes the tests but fails in production. You can use the _delegating-to-real_ technique to ensure that your mock has the same behavior as the real object while retaining the ability to validate calls. This technique is very similar to the delegating-to-fake technique, the difference being that we use a real object instead of a fake. Here's an example: ``` using ::testing::_; using ::testing::AtLeast; using ::testing::Invoke; class MockFoo : public Foo { public: MockFoo() { // By default, all calls are delegated to the real object. ON_CALL(*this, DoThis()) .WillByDefault(Invoke(&real_, &Foo::DoThis)); ON_CALL(*this, DoThat(_)) .WillByDefault(Invoke(&real_, &Foo::DoThat)); ... } MOCK_METHOD0(DoThis, ...); MOCK_METHOD1(DoThat, ...); ... private: Foo real_; }; ... MockFoo mock; EXPECT_CALL(mock, DoThis()) .Times(3); EXPECT_CALL(mock, DoThat("Hi")) .Times(AtLeast(1)); ... use mock in test ... ``` With this, Google Mock will verify that your code made the right calls (with the right arguments, in the right order, called the right number of times, etc), and a real object will answer the calls (so the behavior will be the same as in production). This gives you the best of both worlds. ## Delegating Calls to a Parent Class ## Ideally, you should code to interfaces, whose methods are all pure virtual. In reality, sometimes you do need to mock a virtual method that is not pure (i.e, it already has an implementation). For example: ``` class Foo { public: virtual ~Foo(); virtual void Pure(int n) = 0; virtual int Concrete(const char* str) { ... } }; class MockFoo : public Foo { public: // Mocking a pure method. MOCK_METHOD1(Pure, void(int n)); // Mocking a concrete method. Foo::Concrete() is shadowed. MOCK_METHOD1(Concrete, int(const char* str)); }; ``` Sometimes you may want to call `Foo::Concrete()` instead of `MockFoo::Concrete()`. Perhaps you want to do it as part of a stub action, or perhaps your test doesn't need to mock `Concrete()` at all (but it would be oh-so painful to have to define a new mock class whenever you don't need to mock one of its methods). The trick is to leave a back door in your mock class for accessing the real methods in the base class: ``` class MockFoo : public Foo { public: // Mocking a pure method. MOCK_METHOD1(Pure, void(int n)); // Mocking a concrete method. Foo::Concrete() is shadowed. MOCK_METHOD1(Concrete, int(const char* str)); // Use this to call Concrete() defined in Foo. int FooConcrete(const char* str) { return Foo::Concrete(str); } }; ``` Now, you can call `Foo::Concrete()` inside an action by: ``` using ::testing::_; using ::testing::Invoke; ... EXPECT_CALL(foo, Concrete(_)) .WillOnce(Invoke(&foo, &MockFoo::FooConcrete)); ``` or tell the mock object that you don't want to mock `Concrete()`: ``` using ::testing::Invoke; ... ON_CALL(foo, Concrete(_)) .WillByDefault(Invoke(&foo, &MockFoo::FooConcrete)); ``` (Why don't we just write `Invoke(&foo, &Foo::Concrete)`? If you do that, `MockFoo::Concrete()` will be called (and cause an infinite recursion) since `Foo::Concrete()` is virtual. That's just how C++ works.) # Using Matchers # ## Matching Argument Values Exactly ## You can specify exactly which arguments a mock method is expecting: ``` using ::testing::Return; ... EXPECT_CALL(foo, DoThis(5)) .WillOnce(Return('a')); EXPECT_CALL(foo, DoThat("Hello", bar)); ``` ## Using Simple Matchers ## You can use matchers to match arguments that have a certain property: ``` using ::testing::Ge; using ::testing::NotNull; using ::testing::Return; ... EXPECT_CALL(foo, DoThis(Ge(5))) // The argument must be >= 5. .WillOnce(Return('a')); EXPECT_CALL(foo, DoThat("Hello", NotNull())); // The second argument must not be NULL. ``` A frequently used matcher is `_`, which matches anything: ``` using ::testing::_; using ::testing::NotNull; ... EXPECT_CALL(foo, DoThat(_, NotNull())); ``` ## Combining Matchers ## You can build complex matchers from existing ones using `AllOf()`, `AnyOf()`, and `Not()`: ``` using ::testing::AllOf; using ::testing::Gt; using ::testing::HasSubstr; using ::testing::Ne; using ::testing::Not; ... // The argument must be > 5 and != 10. EXPECT_CALL(foo, DoThis(AllOf(Gt(5), Ne(10)))); // The first argument must not contain sub-string "blah". EXPECT_CALL(foo, DoThat(Not(HasSubstr("blah")), NULL)); ``` ## Casting Matchers ## Google Mock matchers are statically typed, meaning that the compiler can catch your mistake if you use a matcher of the wrong type (for example, if you use `Eq(5)` to match a `string` argument). Good for you! Sometimes, however, you know what you're doing and want the compiler to give you some slack. One example is that you have a matcher for `long` and the argument you want to match is `int`. While the two types aren't exactly the same, there is nothing really wrong with using a `Matcher` to match an `int` - after all, we can first convert the `int` argument to a `long` before giving it to the matcher. To support this need, Google Mock gives you the `SafeMatcherCast(m)` function. It casts a matcher `m` to type `Matcher`. To ensure safety, Google Mock checks that (let `U` be the type `m` accepts): 1. Type `T` can be implicitly cast to type `U`; 1. When both `T` and `U` are built-in arithmetic types (`bool`, integers, and floating-point numbers), the conversion from `T` to `U` is not lossy (in other words, any value representable by `T` can also be represented by `U`); and 1. When `U` is a reference, `T` must also be a reference (as the underlying matcher may be interested in the address of the `U` value). The code won't compile if any of these conditions isn't met. Here's one example: ``` using ::testing::SafeMatcherCast; // A base class and a child class. class Base { ... }; class Derived : public Base { ... }; class MockFoo : public Foo { public: MOCK_METHOD1(DoThis, void(Derived* derived)); }; ... MockFoo foo; // m is a Matcher we got from somewhere. EXPECT_CALL(foo, DoThis(SafeMatcherCast(m))); ``` If you find `SafeMatcherCast(m)` too limiting, you can use a similar function `MatcherCast(m)`. The difference is that `MatcherCast` works as long as you can `static_cast` type `T` to type `U`. `MatcherCast` essentially lets you bypass C++'s type system (`static_cast` isn't always safe as it could throw away information, for example), so be careful not to misuse/abuse it. ## Selecting Between Overloaded Functions ## If you expect an overloaded function to be called, the compiler may need some help on which overloaded version it is. To disambiguate functions overloaded on the const-ness of this object, use the `Const()` argument wrapper. ``` using ::testing::ReturnRef; class MockFoo : public Foo { ... MOCK_METHOD0(GetBar, Bar&()); MOCK_CONST_METHOD0(GetBar, const Bar&()); }; ... MockFoo foo; Bar bar1, bar2; EXPECT_CALL(foo, GetBar()) // The non-const GetBar(). .WillOnce(ReturnRef(bar1)); EXPECT_CALL(Const(foo), GetBar()) // The const GetBar(). .WillOnce(ReturnRef(bar2)); ``` (`Const()` is defined by Google Mock and returns a `const` reference to its argument.) To disambiguate overloaded functions with the same number of arguments but different argument types, you may need to specify the exact type of a matcher, either by wrapping your matcher in `Matcher()`, or using a matcher whose type is fixed (`TypedEq`, `An()`, etc): ``` using ::testing::An; using ::testing::Lt; using ::testing::Matcher; using ::testing::TypedEq; class MockPrinter : public Printer { public: MOCK_METHOD1(Print, void(int n)); MOCK_METHOD1(Print, void(char c)); }; TEST(PrinterTest, Print) { MockPrinter printer; EXPECT_CALL(printer, Print(An())); // void Print(int); EXPECT_CALL(printer, Print(Matcher(Lt(5)))); // void Print(int); EXPECT_CALL(printer, Print(TypedEq('a'))); // void Print(char); printer.Print(3); printer.Print(6); printer.Print('a'); } ``` ## Performing Different Actions Based on the Arguments ## When a mock method is called, the _last_ matching expectation that's still active will be selected (think "newer overrides older"). So, you can make a method do different things depending on its argument values like this: ``` using ::testing::_; using ::testing::Lt; using ::testing::Return; ... // The default case. EXPECT_CALL(foo, DoThis(_)) .WillRepeatedly(Return('b')); // The more specific case. EXPECT_CALL(foo, DoThis(Lt(5))) .WillRepeatedly(Return('a')); ``` Now, if `foo.DoThis()` is called with a value less than 5, `'a'` will be returned; otherwise `'b'` will be returned. ## Matching Multiple Arguments as a Whole ## Sometimes it's not enough to match the arguments individually. For example, we may want to say that the first argument must be less than the second argument. The `With()` clause allows us to match all arguments of a mock function as a whole. For example, ``` using ::testing::_; using ::testing::Lt; using ::testing::Ne; ... EXPECT_CALL(foo, InRange(Ne(0), _)) .With(Lt()); ``` says that the first argument of `InRange()` must not be 0, and must be less than the second argument. The expression inside `With()` must be a matcher of type `Matcher >`, where `A1`, ..., `An` are the types of the function arguments. You can also write `AllArgs(m)` instead of `m` inside `.With()`. The two forms are equivalent, but `.With(AllArgs(Lt()))` is more readable than `.With(Lt())`. You can use `Args(m)` to match the `n` selected arguments against `m`. For example, ``` using ::testing::_; using ::testing::AllOf; using ::testing::Args; using ::testing::Lt; ... EXPECT_CALL(foo, Blah(_, _, _)) .With(AllOf(Args<0, 1>(Lt()), Args<1, 2>(Lt()))); ``` says that `Blah()` will be called with arguments `x`, `y`, and `z` where `x < y < z`. As a convenience and example, Google Mock provides some matchers for 2-tuples, including the `Lt()` matcher above. See the [CheatSheet](V1_5_CheatSheet.md) for the complete list. ## Using Matchers as Predicates ## Have you noticed that a matcher is just a fancy predicate that also knows how to describe itself? Many existing algorithms take predicates as arguments (e.g. those defined in STL's `` header), and it would be a shame if Google Mock matchers are not allowed to participate. Luckily, you can use a matcher where a unary predicate functor is expected by wrapping it inside the `Matches()` function. For example, ``` #include #include std::vector v; ... // How many elements in v are >= 10? const int count = count_if(v.begin(), v.end(), Matches(Ge(10))); ``` Since you can build complex matchers from simpler ones easily using Google Mock, this gives you a way to conveniently construct composite predicates (doing the same using STL's `` header is just painful). For example, here's a predicate that's satisfied by any number that is >= 0, <= 100, and != 50: ``` Matches(AllOf(Ge(0), Le(100), Ne(50))) ``` ## Using Matchers in Google Test Assertions ## Since matchers are basically predicates that also know how to describe themselves, there is a way to take advantage of them in [Google Test](http://code.google.com/p/googletest/) assertions. It's called `ASSERT_THAT` and `EXPECT_THAT`: ``` ASSERT_THAT(value, matcher); // Asserts that value matches matcher. EXPECT_THAT(value, matcher); // The non-fatal version. ``` For example, in a Google Test test you can write: ``` #include using ::testing::AllOf; using ::testing::Ge; using ::testing::Le; using ::testing::MatchesRegex; using ::testing::StartsWith; ... EXPECT_THAT(Foo(), StartsWith("Hello")); EXPECT_THAT(Bar(), MatchesRegex("Line \\d+")); ASSERT_THAT(Baz(), AllOf(Ge(5), Le(10))); ``` which (as you can probably guess) executes `Foo()`, `Bar()`, and `Baz()`, and verifies that: * `Foo()` returns a string that starts with `"Hello"`. * `Bar()` returns a string that matches regular expression `"Line \\d+"`. * `Baz()` returns a number in the range [5, 10]. The nice thing about these macros is that _they read like English_. They generate informative messages too. For example, if the first `EXPECT_THAT()` above fails, the message will be something like: ``` Value of: Foo() Actual: "Hi, world!" Expected: starts with "Hello" ``` **Credit:** The idea of `(ASSERT|EXPECT)_THAT` was stolen from the [Hamcrest](http://code.google.com/p/hamcrest/) project, which adds `assertThat()` to JUnit. ## Using Predicates as Matchers ## Google Mock provides a built-in set of matchers. In case you find them lacking, you can use an arbitray unary predicate function or functor as a matcher - as long as the predicate accepts a value of the type you want. You do this by wrapping the predicate inside the `Truly()` function, for example: ``` using ::testing::Truly; int IsEven(int n) { return (n % 2) == 0 ? 1 : 0; } ... // Bar() must be called with an even number. EXPECT_CALL(foo, Bar(Truly(IsEven))); ``` Note that the predicate function / functor doesn't have to return `bool`. It works as long as the return value can be used as the condition in statement `if (condition) ...`. ## Matching Arguments that Are Not Copyable ## When you do an `EXPECT_CALL(mock_obj, Foo(bar))`, Google Mock saves away a copy of `bar`. When `Foo()` is called later, Google Mock compares the argument to `Foo()` with the saved copy of `bar`. This way, you don't need to worry about `bar` being modified or destroyed after the `EXPECT_CALL()` is executed. The same is true when you use matchers like `Eq(bar)`, `Le(bar)`, and so on. But what if `bar` cannot be copied (i.e. has no copy constructor)? You could define your own matcher function and use it with `Truly()`, as the previous couple of recipes have shown. Or, you may be able to get away from it if you can guarantee that `bar` won't be changed after the `EXPECT_CALL()` is executed. Just tell Google Mock that it should save a reference to `bar`, instead of a copy of it. Here's how: ``` using ::testing::Eq; using ::testing::ByRef; using ::testing::Lt; ... // Expects that Foo()'s argument == bar. EXPECT_CALL(mock_obj, Foo(Eq(ByRef(bar)))); // Expects that Foo()'s argument < bar. EXPECT_CALL(mock_obj, Foo(Lt(ByRef(bar)))); ``` Remember: if you do this, don't change `bar` after the `EXPECT_CALL()`, or the result is undefined. ## Validating a Member of an Object ## Often a mock function takes a reference to object as an argument. When matching the argument, you may not want to compare the entire object against a fixed object, as that may be over-specification. Instead, you may need to validate a certain member variable or the result of a certain getter method of the object. You can do this with `Field()` and `Property()`. More specifically, ``` Field(&Foo::bar, m) ``` is a matcher that matches a `Foo` object whose `bar` member variable satisfies matcher `m`. ``` Property(&Foo::baz, m) ``` is a matcher that matches a `Foo` object whose `baz()` method returns a value that satisfies matcher `m`. For example: > | `Field(&Foo::number, Ge(3))` | Matches `x` where `x.number >= 3`. | |:-----------------------------|:-----------------------------------| > | `Property(&Foo::name, StartsWith("John "))` | Matches `x` where `x.name()` starts with `"John "`. | Note that in `Property(&Foo::baz, ...)`, method `baz()` must take no argument and be declared as `const`. BTW, `Field()` and `Property()` can also match plain pointers to objects. For instance, ``` Field(&Foo::number, Ge(3)) ``` matches a plain pointer `p` where `p->number >= 3`. If `p` is `NULL`, the match will always fail regardless of the inner matcher. What if you want to validate more than one members at the same time? Remember that there is `AllOf()`. ## Validating the Value Pointed to by a Pointer Argument ## C++ functions often take pointers as arguments. You can use matchers like `NULL`, `NotNull()`, and other comparison matchers to match a pointer, but what if you want to make sure the value _pointed to_ by the pointer, instead of the pointer itself, has a certain property? Well, you can use the `Pointee(m)` matcher. `Pointee(m)` matches a pointer iff `m` matches the value the pointer points to. For example: ``` using ::testing::Ge; using ::testing::Pointee; ... EXPECT_CALL(foo, Bar(Pointee(Ge(3)))); ``` expects `foo.Bar()` to be called with a pointer that points to a value greater than or equal to 3. One nice thing about `Pointee()` is that it treats a `NULL` pointer as a match failure, so you can write `Pointee(m)` instead of ``` AllOf(NotNull(), Pointee(m)) ``` without worrying that a `NULL` pointer will crash your test. Also, did we tell you that `Pointee()` works with both raw pointers **and** smart pointers (`linked_ptr`, `shared_ptr`, `scoped_ptr`, and etc)? What if you have a pointer to pointer? You guessed it - you can use nested `Pointee()` to probe deeper inside the value. For example, `Pointee(Pointee(Lt(3)))` matches a pointer that points to a pointer that points to a number less than 3 (what a mouthful...). ## Testing a Certain Property of an Object ## Sometimes you want to specify that an object argument has a certain property, but there is no existing matcher that does this. If you want good error messages, you should define a matcher. If you want to do it quick and dirty, you could get away with writing an ordinary function. Let's say you have a mock function that takes an object of type `Foo`, which has an `int bar()` method and an `int baz()` method, and you want to constrain that the argument's `bar()` value plus its `baz()` value is a given number. Here's how you can define a matcher to do it: ``` using ::testing::MatcherInterface; using ::testing::MatchResultListener; class BarPlusBazEqMatcher : public MatcherInterface { public: explicit BarPlusBazEqMatcher(int expected_sum) : expected_sum_(expected_sum) {} virtual bool MatchAndExplain(const Foo& foo, MatchResultListener* listener) const { return (foo.bar() + foo.baz()) == expected_sum_; } virtual void DescribeTo(::std::ostream* os) const { *os << "bar() + baz() equals " << expected_sum_; } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "bar() + baz() does not equal " << expected_sum_; } private: const int expected_sum_; }; inline Matcher BarPlusBazEq(int expected_sum) { return MakeMatcher(new BarPlusBazEqMatcher(expected_sum)); } ... EXPECT_CALL(..., DoThis(BarPlusBazEq(5)))...; ``` ## Matching Containers ## Sometimes an STL container (e.g. list, vector, map, ...) is passed to a mock function and you may want to validate it. Since most STL containers support the `==` operator, you can write `Eq(expected_container)` or simply `expected_container` to match a container exactly. Sometimes, though, you may want to be more flexible (for example, the first element must be an exact match, but the second element can be any positive number, and so on). Also, containers used in tests often have a small number of elements, and having to define the expected container out-of-line is a bit of a hassle. You can use the `ElementsAre()` matcher in such cases: ``` using ::testing::_; using ::testing::ElementsAre; using ::testing::Gt; ... MOCK_METHOD1(Foo, void(const vector& numbers)); ... EXPECT_CALL(mock, Foo(ElementsAre(1, Gt(0), _, 5))); ``` The above matcher says that the container must have 4 elements, which must be 1, greater than 0, anything, and 5 respectively. `ElementsAre()` is overloaded to take 0 to 10 arguments. If more are needed, you can place them in a C-style array and use `ElementsAreArray()` instead: ``` using ::testing::ElementsAreArray; ... // ElementsAreArray accepts an array of element values. const int expected_vector1[] = { 1, 5, 2, 4, ... }; EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector1))); // Or, an array of element matchers. Matcher expected_vector2 = { 1, Gt(2), _, 3, ... }; EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector2))); ``` In case the array needs to be dynamically created (and therefore the array size cannot be inferred by the compiler), you can give `ElementsAreArray()` an additional argument to specify the array size: ``` using ::testing::ElementsAreArray; ... int* const expected_vector3 = new int[count]; ... fill expected_vector3 with values ... EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector3, count))); ``` **Tips:** * `ElementAre*()` works with _any_ container that implements the STL iterator concept (i.e. it has a `const_iterator` type and supports `begin()/end()`) and supports `size()`, not just the ones defined in STL. It will even work with container types yet to be written - as long as they follows the above pattern. * You can use nested `ElementAre*()` to match nested (multi-dimensional) containers. * If the container is passed by pointer instead of by reference, just write `Pointee(ElementsAre*(...))`. * The order of elements _matters_ for `ElementsAre*()`. Therefore don't use it with containers whose element order is undefined (e.g. `hash_map`). ## Sharing Matchers ## Under the hood, a Google Mock matcher object consists of a pointer to a ref-counted implementation object. Copying matchers is allowed and very efficient, as only the pointer is copied. When the last matcher that references the implementation object dies, the implementation object will be deleted. Therefore, if you have some complex matcher that you want to use again and again, there is no need to build it everytime. Just assign it to a matcher variable and use that variable repeatedly! For example, ``` Matcher in_range = AllOf(Gt(5), Le(10)); ... use in_range as a matcher in multiple EXPECT_CALLs ... ``` # Setting Expectations # ## Ignoring Uninteresting Calls ## If you are not interested in how a mock method is called, just don't say anything about it. In this case, if the method is ever called, Google Mock will perform its default action to allow the test program to continue. If you are not happy with the default action taken by Google Mock, you can override it using `DefaultValue::Set()` (described later in this document) or `ON_CALL()`. Please note that once you expressed interest in a particular mock method (via `EXPECT_CALL()`), all invocations to it must match some expectation. If this function is called but the arguments don't match any `EXPECT_CALL()` statement, it will be an error. ## Disallowing Unexpected Calls ## If a mock method shouldn't be called at all, explicitly say so: ``` using ::testing::_; ... EXPECT_CALL(foo, Bar(_)) .Times(0); ``` If some calls to the method are allowed, but the rest are not, just list all the expected calls: ``` using ::testing::AnyNumber; using ::testing::Gt; ... EXPECT_CALL(foo, Bar(5)); EXPECT_CALL(foo, Bar(Gt(10))) .Times(AnyNumber()); ``` A call to `foo.Bar()` that doesn't match any of the `EXPECT_CALL()` statements will be an error. ## Expecting Ordered Calls ## Although an `EXPECT_CALL()` statement defined earlier takes precedence when Google Mock tries to match a function call with an expectation, by default calls don't have to happen in the order `EXPECT_CALL()` statements are written. For example, if the arguments match the matchers in the third `EXPECT_CALL()`, but not those in the first two, then the third expectation will be used. If you would rather have all calls occur in the order of the expectations, put the `EXPECT_CALL()` statements in a block where you define a variable of type `InSequence`: ``` using ::testing::_; using ::testing::InSequence; { InSequence s; EXPECT_CALL(foo, DoThis(5)); EXPECT_CALL(bar, DoThat(_)) .Times(2); EXPECT_CALL(foo, DoThis(6)); } ``` In this example, we expect a call to `foo.DoThis(5)`, followed by two calls to `bar.DoThat()` where the argument can be anything, which are in turn followed by a call to `foo.DoThis(6)`. If a call occurred out-of-order, Google Mock will report an error. ## Expecting Partially Ordered Calls ## Sometimes requiring everything to occur in a predetermined order can lead to brittle tests. For example, we may care about `A` occurring before both `B` and `C`, but aren't interested in the relative order of `B` and `C`. In this case, the test should reflect our real intent, instead of being overly constraining. Google Mock allows you to impose an arbitrary DAG (directed acyclic graph) on the calls. One way to express the DAG is to use the [After](V1_5_CheatSheet#The_After_Clause.md) clause of `EXPECT_CALL`. Another way is via the `InSequence()` clause (not the same as the `InSequence` class), which we borrowed from jMock 2. It's less flexible than `After()`, but more convenient when you have long chains of sequential calls, as it doesn't require you to come up with different names for the expectations in the chains. Here's how it works: If we view `EXPECT_CALL()` statements as nodes in a graph, and add an edge from node A to node B wherever A must occur before B, we can get a DAG. We use the term "sequence" to mean a directed path in this DAG. Now, if we decompose the DAG into sequences, we just need to know which sequences each `EXPECT_CALL()` belongs to in order to be able to reconstruct the orginal DAG. So, to specify the partial order on the expectations we need to do two things: first to define some `Sequence` objects, and then for each `EXPECT_CALL()` say which `Sequence` objects it is part of. Expectations in the same sequence must occur in the order they are written. For example, ``` using ::testing::Sequence; Sequence s1, s2; EXPECT_CALL(foo, A()) .InSequence(s1, s2); EXPECT_CALL(bar, B()) .InSequence(s1); EXPECT_CALL(bar, C()) .InSequence(s2); EXPECT_CALL(foo, D()) .InSequence(s2); ``` specifies the following DAG (where `s1` is `A -> B`, and `s2` is `A -> C -> D`): ``` +---> B | A ---| | +---> C ---> D ``` This means that A must occur before B and C, and C must occur before D. There's no restriction about the order other than these. ## Controlling When an Expectation Retires ## When a mock method is called, Google Mock only consider expectations that are still active. An expectation is active when created, and becomes inactive (aka _retires_) when a call that has to occur later has occurred. For example, in ``` using ::testing::_; using ::testing::Sequence; Sequence s1, s2; EXPECT_CALL(log, Log(WARNING, _, "File too large.")) // #1 .Times(AnyNumber()) .InSequence(s1, s2); EXPECT_CALL(log, Log(WARNING, _, "Data set is empty.")) // #2 .InSequence(s1); EXPECT_CALL(log, Log(WARNING, _, "User not found.")) // #3 .InSequence(s2); ``` as soon as either #2 or #3 is matched, #1 will retire. If a warning `"File too large."` is logged after this, it will be an error. Note that an expectation doesn't retire automatically when it's saturated. For example, ``` using ::testing::_; ... EXPECT_CALL(log, Log(WARNING, _, _)); // #1 EXPECT_CALL(log, Log(WARNING, _, "File too large.")); // #2 ``` says that there will be exactly one warning with the message `"File too large."`. If the second warning contains this message too, #2 will match again and result in an upper-bound-violated error. If this is not what you want, you can ask an expectation to retire as soon as it becomes saturated: ``` using ::testing::_; ... EXPECT_CALL(log, Log(WARNING, _, _)); // #1 EXPECT_CALL(log, Log(WARNING, _, "File too large.")) // #2 .RetiresOnSaturation(); ``` Here #2 can be used only once, so if you have two warnings with the message `"File too large."`, the first will match #2 and the second will match #1 - there will be no error. # Using Actions # ## Returning References from Mock Methods ## If a mock function's return type is a reference, you need to use `ReturnRef()` instead of `Return()` to return a result: ``` using ::testing::ReturnRef; class MockFoo : public Foo { public: MOCK_METHOD0(GetBar, Bar&()); }; ... MockFoo foo; Bar bar; EXPECT_CALL(foo, GetBar()) .WillOnce(ReturnRef(bar)); ``` ## Combining Actions ## Want to do more than one thing when a function is called? That's fine. `DoAll()` allow you to do sequence of actions every time. Only the return value of the last action in the sequence will be used. ``` using ::testing::DoAll; class MockFoo : public Foo { public: MOCK_METHOD1(Bar, bool(int n)); }; ... EXPECT_CALL(foo, Bar(_)) .WillOnce(DoAll(action_1, action_2, ... action_n)); ``` ## Mocking Side Effects ## Sometimes a method exhibits its effect not via returning a value but via side effects. For example, it may change some global state or modify an output argument. To mock side effects, in general you can define your own action by implementing `::testing::ActionInterface`. If all you need to do is to change an output argument, the built-in `SetArgumentPointee()` action is convenient: ``` using ::testing::SetArgumentPointee; class MockMutator : public Mutator { public: MOCK_METHOD2(Mutate, void(bool mutate, int* value)); ... }; ... MockMutator mutator; EXPECT_CALL(mutator, Mutate(true, _)) .WillOnce(SetArgumentPointee<1>(5)); ``` In this example, when `mutator.Mutate()` is called, we will assign 5 to the `int` variable pointed to by argument #1 (0-based). `SetArgumentPointee()` conveniently makes an internal copy of the value you pass to it, removing the need to keep the value in scope and alive. The implication however is that the value must have a copy constructor and assignment operator. If the mock method also needs to return a value as well, you can chain `SetArgumentPointee()` with `Return()` using `DoAll()`: ``` using ::testing::_; using ::testing::Return; using ::testing::SetArgumentPointee; class MockMutator : public Mutator { public: ... MOCK_METHOD1(MutateInt, bool(int* value)); }; ... MockMutator mutator; EXPECT_CALL(mutator, MutateInt(_)) .WillOnce(DoAll(SetArgumentPointee<0>(5), Return(true))); ``` If the output argument is an array, use the `SetArrayArgument(first, last)` action instead. It copies the elements in source range `[first, last)` to the array pointed to by the `N`-th (0-based) argument: ``` using ::testing::NotNull; using ::testing::SetArrayArgument; class MockArrayMutator : public ArrayMutator { public: MOCK_METHOD2(Mutate, void(int* values, int num_values)); ... }; ... MockArrayMutator mutator; int values[5] = { 1, 2, 3, 4, 5 }; EXPECT_CALL(mutator, Mutate(NotNull(), 5)) .WillOnce(SetArrayArgument<0>(values, values + 5)); ``` This also works when the argument is an output iterator: ``` using ::testing::_; using ::testing::SeArrayArgument; class MockRolodex : public Rolodex { public: MOCK_METHOD1(GetNames, void(std::back_insert_iterator >)); ... }; ... MockRolodex rolodex; vector names; names.push_back("George"); names.push_back("John"); names.push_back("Thomas"); EXPECT_CALL(rolodex, GetNames(_)) .WillOnce(SetArrayArgument<0>(names.begin(), names.end())); ``` ## Changing a Mock Object's Behavior Based on the State ## If you expect a call to change the behavior of a mock object, you can use `::testing::InSequence` to specify different behaviors before and after the call: ``` using ::testing::InSequence; using ::testing::Return; ... { InSequence seq; EXPECT_CALL(my_mock, IsDirty()) .WillRepeatedly(Return(true)); EXPECT_CALL(my_mock, Flush()); EXPECT_CALL(my_mock, IsDirty()) .WillRepeatedly(Return(false)); } my_mock.FlushIfDirty(); ``` This makes `my_mock.IsDirty()` return `true` before `my_mock.Flush()` is called and return `false` afterwards. If the behavior change is more complex, you can store the effects in a variable and make a mock method get its return value from that variable: ``` using ::testing::_; using ::testing::SaveArg; using ::testing::Return; ACTION_P(ReturnPointee, p) { return *p; } ... int previous_value = 0; EXPECT_CALL(my_mock, GetPrevValue()) .WillRepeatedly(ReturnPointee(&previous_value)); EXPECT_CALL(my_mock, UpdateValue(_)) .WillRepeatedly(SaveArg<0>(&previous_value)); my_mock.DoSomethingToUpdateValue(); ``` Here `my_mock.GetPrevValue()` will always return the argument of the last `UpdateValue()` call. ## Setting the Default Value for a Return Type ## If a mock method's return type is a built-in C++ type or pointer, by default it will return 0 when invoked. You only need to specify an action if this default value doesn't work for you. Sometimes, you may want to change this default value, or you may want to specify a default value for types Google Mock doesn't know about. You can do this using the `::testing::DefaultValue` class template: ``` class MockFoo : public Foo { public: MOCK_METHOD0(CalculateBar, Bar()); }; ... Bar default_bar; // Sets the default return value for type Bar. DefaultValue::Set(default_bar); MockFoo foo; // We don't need to specify an action here, as the default // return value works for us. EXPECT_CALL(foo, CalculateBar()); foo.CalculateBar(); // This should return default_bar. // Unsets the default return value. DefaultValue::Clear(); ``` Please note that changing the default value for a type can make you tests hard to understand. We recommend you to use this feature judiciously. For example, you may want to make sure the `Set()` and `Clear()` calls are right next to the code that uses your mock. ## Setting the Default Actions for a Mock Method ## You've learned how to change the default value of a given type. However, this may be too coarse for your purpose: perhaps you have two mock methods with the same return type and you want them to have different behaviors. The `ON_CALL()` macro allows you to customize your mock's behavior at the method level: ``` using ::testing::_; using ::testing::AnyNumber; using ::testing::Gt; using ::testing::Return; ... ON_CALL(foo, Sign(_)) .WillByDefault(Return(-1)); ON_CALL(foo, Sign(0)) .WillByDefault(Return(0)); ON_CALL(foo, Sign(Gt(0))) .WillByDefault(Return(1)); EXPECT_CALL(foo, Sign(_)) .Times(AnyNumber()); foo.Sign(5); // This should return 1. foo.Sign(-9); // This should return -1. foo.Sign(0); // This should return 0. ``` As you may have guessed, when there are more than one `ON_CALL()` statements, the news order take precedence over the older ones. In other words, the **last** one that matches the function arguments will be used. This matching order allows you to set up the common behavior in a mock object's constructor or the test fixture's set-up phase and specialize the mock's behavior later. ## Using Functions/Methods/Functors as Actions ## If the built-in actions don't suit you, you can easily use an existing function, method, or functor as an action: ``` using ::testing::_; using ::testing::Invoke; class MockFoo : public Foo { public: MOCK_METHOD2(Sum, int(int x, int y)); MOCK_METHOD1(ComplexJob, bool(int x)); }; int CalculateSum(int x, int y) { return x + y; } class Helper { public: bool ComplexJob(int x); }; ... MockFoo foo; Helper helper; EXPECT_CALL(foo, Sum(_, _)) .WillOnce(Invoke(CalculateSum)); EXPECT_CALL(foo, ComplexJob(_)) .WillOnce(Invoke(&helper, &Helper::ComplexJob)); foo.Sum(5, 6); // Invokes CalculateSum(5, 6). foo.ComplexJob(10); // Invokes helper.ComplexJob(10); ``` The only requirement is that the type of the function, etc must be _compatible_ with the signature of the mock function, meaning that the latter's arguments can be implicitly converted to the corresponding arguments of the former, and the former's return type can be implicitly converted to that of the latter. So, you can invoke something whose type is _not_ exactly the same as the mock function, as long as it's safe to do so - nice, huh? ## Invoking a Function/Method/Functor Without Arguments ## `Invoke()` is very useful for doing actions that are more complex. It passes the mock function's arguments to the function or functor being invoked such that the callee has the full context of the call to work with. If the invoked function is not interested in some or all of the arguments, it can simply ignore them. Yet, a common pattern is that a test author wants to invoke a function without the arguments of the mock function. `Invoke()` allows her to do that using a wrapper function that throws away the arguments before invoking an underlining nullary function. Needless to say, this can be tedious and obscures the intent of the test. `InvokeWithoutArgs()` solves this problem. It's like `Invoke()` except that it doesn't pass the mock function's arguments to the callee. Here's an example: ``` using ::testing::_; using ::testing::InvokeWithoutArgs; class MockFoo : public Foo { public: MOCK_METHOD1(ComplexJob, bool(int n)); }; bool Job1() { ... } ... MockFoo foo; EXPECT_CALL(foo, ComplexJob(_)) .WillOnce(InvokeWithoutArgs(Job1)); foo.ComplexJob(10); // Invokes Job1(). ``` ## Invoking an Argument of the Mock Function ## Sometimes a mock function will receive a function pointer or a functor (in other words, a "callable") as an argument, e.g. ``` class MockFoo : public Foo { public: MOCK_METHOD2(DoThis, bool(int n, bool (*fp)(int))); }; ``` and you may want to invoke this callable argument: ``` using ::testing::_; ... MockFoo foo; EXPECT_CALL(foo, DoThis(_, _)) .WillOnce(...); // Will execute (*fp)(5), where fp is the // second argument DoThis() receives. ``` Arghh, you need to refer to a mock function argument but C++ has no lambda (yet), so you have to define your own action. :-( Or do you really? Well, Google Mock has an action to solve _exactly_ this problem: ``` InvokeArgument(arg_1, arg_2, ..., arg_m) ``` will invoke the `N`-th (0-based) argument the mock function receives, with `arg_1`, `arg_2`, ..., and `arg_m`. No matter if the argument is a function pointer or a functor, Google Mock handles them both. With that, you could write: ``` using ::testing::_; using ::testing::InvokeArgument; ... EXPECT_CALL(foo, DoThis(_, _)) .WillOnce(InvokeArgument<1>(5)); // Will execute (*fp)(5), where fp is the // second argument DoThis() receives. ``` What if the callable takes an argument by reference? No problem - just wrap it inside `ByRef()`: ``` ... MOCK_METHOD1(Bar, bool(bool (*fp)(int, const Helper&))); ... using ::testing::_; using ::testing::ByRef; using ::testing::InvokeArgument; ... MockFoo foo; Helper helper; ... EXPECT_CALL(foo, Bar(_)) .WillOnce(InvokeArgument<0>(5, ByRef(helper))); // ByRef(helper) guarantees that a reference to helper, not a copy of it, // will be passed to the callable. ``` What if the callable takes an argument by reference and we do **not** wrap the argument in `ByRef()`? Then `InvokeArgument()` will _make a copy_ of the argument, and pass a _reference to the copy_, instead of a reference to the original value, to the callable. This is especially handy when the argument is a temporary value: ``` ... MOCK_METHOD1(DoThat, bool(bool (*f)(const double& x, const string& s))); ... using ::testing::_; using ::testing::InvokeArgument; ... MockFoo foo; ... EXPECT_CALL(foo, DoThat(_)) .WillOnce(InvokeArgument<0>(5.0, string("Hi"))); // Will execute (*f)(5.0, string("Hi")), where f is the function pointer // DoThat() receives. Note that the values 5.0 and string("Hi") are // temporary and dead once the EXPECT_CALL() statement finishes. Yet // it's fine to perform this action later, since a copy of the values // are kept inside the InvokeArgument action. ``` ## Ignoring an Action's Result ## Sometimes you have an action that returns _something_, but you need an action that returns `void` (perhaps you want to use it in a mock function that returns `void`, or perhaps it needs to be used in `DoAll()` and it's not the last in the list). `IgnoreResult()` lets you do that. For example: ``` using ::testing::_; using ::testing::Invoke; using ::testing::Return; int Process(const MyData& data); string DoSomething(); class MockFoo : public Foo { public: MOCK_METHOD1(Abc, void(const MyData& data)); MOCK_METHOD0(Xyz, bool()); }; ... MockFoo foo; EXPECT_CALL(foo, Abc(_)) // .WillOnce(Invoke(Process)); // The above line won't compile as Process() returns int but Abc() needs // to return void. .WillOnce(IgnoreResult(Invoke(Process))); EXPECT_CALL(foo, Xyz()) .WillOnce(DoAll(IgnoreResult(Invoke(DoSomething)), // Ignores the string DoSomething() returns. Return(true))); ``` Note that you **cannot** use `IgnoreResult()` on an action that already returns `void`. Doing so will lead to ugly compiler errors. ## Selecting an Action's Arguments ## Say you have a mock function `Foo()` that takes seven arguments, and you have a custom action that you want to invoke when `Foo()` is called. Trouble is, the custom action only wants three arguments: ``` using ::testing::_; using ::testing::Invoke; ... MOCK_METHOD7(Foo, bool(bool visible, const string& name, int x, int y, const map, double>& weight, double min_weight, double max_wight)); ... bool IsVisibleInQuadrant1(bool visible, int x, int y) { return visible && x >= 0 && y >= 0; } ... EXPECT_CALL(mock, Foo(_, _, _, _, _, _, _)) .WillOnce(Invoke(IsVisibleInQuadrant1)); // Uh, won't compile. :-( ``` To please the compiler God, you can to define an "adaptor" that has the same signature as `Foo()` and calls the custom action with the right arguments: ``` using ::testing::_; using ::testing::Invoke; bool MyIsVisibleInQuadrant1(bool visible, const string& name, int x, int y, const map, double>& weight, double min_weight, double max_wight) { return IsVisibleInQuadrant1(visible, x, y); } ... EXPECT_CALL(mock, Foo(_, _, _, _, _, _, _)) .WillOnce(Invoke(MyIsVisibleInQuadrant1)); // Now it works. ``` But isn't this awkward? Google Mock provides a generic _action adaptor_, so you can spend your time minding more important business than writing your own adaptors. Here's the syntax: ``` WithArgs(action) ``` creates an action that passes the arguments of the mock function at the given indices (0-based) to the inner `action` and performs it. Using `WithArgs`, our original example can be written as: ``` using ::testing::_; using ::testing::Invoke; using ::testing::WithArgs; ... EXPECT_CALL(mock, Foo(_, _, _, _, _, _, _)) .WillOnce(WithArgs<0, 2, 3>(Invoke(IsVisibleInQuadrant1))); // No need to define your own adaptor. ``` For better readability, Google Mock also gives you: * `WithoutArgs(action)` when the inner `action` takes _no_ argument, and * `WithArg(action)` (no `s` after `Arg`) when the inner `action` takes _one_ argument. As you may have realized, `InvokeWithoutArgs(...)` is just syntactic sugar for `WithoutArgs(Inovke(...))`. Here are more tips: * The inner action used in `WithArgs` and friends does not have to be `Invoke()` -- it can be anything. * You can repeat an argument in the argument list if necessary, e.g. `WithArgs<2, 3, 3, 5>(...)`. * You can change the order of the arguments, e.g. `WithArgs<3, 2, 1>(...)`. * The types of the selected arguments do _not_ have to match the signature of the inner action exactly. It works as long as they can be implicitly converted to the corresponding arguments of the inner action. For example, if the 4-th argument of the mock function is an `int` and `my_action` takes a `double`, `WithArg<4>(my_action)` will work. ## Ignoring Arguments in Action Functions ## The selecting-an-action's-arguments recipe showed us one way to make a mock function and an action with incompatible argument lists fit together. The downside is that wrapping the action in `WithArgs<...>()` can get tedious for people writing the tests. If you are defining a function, method, or functor to be used with `Invoke*()`, and you are not interested in some of its arguments, an alternative to `WithArgs` is to declare the uninteresting arguments as `Unused`. This makes the definition less cluttered and less fragile in case the types of the uninteresting arguments change. It could also increase the chance the action function can be reused. For example, given ``` MOCK_METHOD3(Foo, double(const string& label, double x, double y)); MOCK_METHOD3(Bar, double(int index, double x, double y)); ``` instead of ``` using ::testing::_; using ::testing::Invoke; double DistanceToOriginWithLabel(const string& label, double x, double y) { return sqrt(x*x + y*y); } double DistanceToOriginWithIndex(int index, double x, double y) { return sqrt(x*x + y*y); } ... EXEPCT_CALL(mock, Foo("abc", _, _)) .WillOnce(Invoke(DistanceToOriginWithLabel)); EXEPCT_CALL(mock, Bar(5, _, _)) .WillOnce(Invoke(DistanceToOriginWithIndex)); ``` you could write ``` using ::testing::_; using ::testing::Invoke; using ::testing::Unused; double DistanceToOrigin(Unused, double x, double y) { return sqrt(x*x + y*y); } ... EXEPCT_CALL(mock, Foo("abc", _, _)) .WillOnce(Invoke(DistanceToOrigin)); EXEPCT_CALL(mock, Bar(5, _, _)) .WillOnce(Invoke(DistanceToOrigin)); ``` ## Sharing Actions ## Just like matchers, a Google Mock action object consists of a pointer to a ref-counted implementation object. Therefore copying actions is also allowed and very efficient. When the last action that references the implementation object dies, the implementation object will be deleted. If you have some complex action that you want to use again and again, you may not have to build it from scratch everytime. If the action doesn't have an internal state (i.e. if it always does the same thing no matter how many times it has been called), you can assign it to an action variable and use that variable repeatedly. For example: ``` Action set_flag = DoAll(SetArgumentPointee<0>(5), Return(true)); ... use set_flag in .WillOnce() and .WillRepeatedly() ... ``` However, if the action has its own state, you may be surprised if you share the action object. Suppose you have an action factory `IncrementCounter(init)` which creates an action that increments and returns a counter whose initial value is `init`, using two actions created from the same expression and using a shared action will exihibit different behaviors. Example: ``` EXPECT_CALL(foo, DoThis()) .WillRepeatedly(IncrementCounter(0)); EXPECT_CALL(foo, DoThat()) .WillRepeatedly(IncrementCounter(0)); foo.DoThis(); // Returns 1. foo.DoThis(); // Returns 2. foo.DoThat(); // Returns 1 - Blah() uses a different // counter than Bar()'s. ``` versus ``` Action increment = IncrementCounter(0); EXPECT_CALL(foo, DoThis()) .WillRepeatedly(increment); EXPECT_CALL(foo, DoThat()) .WillRepeatedly(increment); foo.DoThis(); // Returns 1. foo.DoThis(); // Returns 2. foo.DoThat(); // Returns 3 - the counter is shared. ``` # Misc Recipes on Using Google Mock # ## Forcing a Verification ## When it's being destoyed, your friendly mock object will automatically verify that all expectations on it have been satisfied, and will generate [Google Test](http://code.google.com/p/googletest/) failures if not. This is convenient as it leaves you with one less thing to worry about. That is, unless you are not sure if your mock object will be destoyed. How could it be that your mock object won't eventually be destroyed? Well, it might be created on the heap and owned by the code you are testing. Suppose there's a bug in that code and it doesn't delete the mock object properly - you could end up with a passing test when there's actually a bug. Using a heap checker is a good idea and can alleviate the concern, but its implementation may not be 100% reliable. So, sometimes you do want to _force_ Google Mock to verify a mock object before it is (hopefully) destructed. You can do this with `Mock::VerifyAndClearExpectations(&mock_object)`: ``` TEST(MyServerTest, ProcessesRequest) { using ::testing::Mock; MockFoo* const foo = new MockFoo; EXPECT_CALL(*foo, ...)...; // ... other expectations ... // server now owns foo. MyServer server(foo); server.ProcessRequest(...); // In case that server's destructor will forget to delete foo, // this will verify the expectations anyway. Mock::VerifyAndClearExpectations(foo); } // server is destroyed when it goes out of scope here. ``` **Tip:** The `Mock::VerifyAndClearExpectations()` function returns a `bool` to indicate whether the verification was successful (`true` for yes), so you can wrap that function call inside a `ASSERT_TRUE()` if there is no point going further when the verification has failed. ## Using Check Points ## Sometimes you may want to "reset" a mock object at various check points in your test: at each check point, you verify that all existing expectations on the mock object have been satisfied, and then you set some new expectations on it as if it's newly created. This allows you to work with a mock object in "phases" whose sizes are each manageable. One such scenario is that in your test's `SetUp()` function, you may want to put the object you are testing into a certain state, with the help from a mock object. Once in the desired state, you want to clear all expectations on the mock, such that in the `TEST_F` body you can set fresh expectations on it. As you may have figured out, the `Mock::VerifyAndClearExpectations()` function we saw in the previous recipe can help you here. Or, if you are using `ON_CALL()` to set default actions on the mock object and want to clear the default actions as well, use `Mock::VerifyAndClear(&mock_object)` instead. This function does what `Mock::VerifyAndClearExpectations(&mock_object)` does and returns the same `bool`, **plus** it clears the `ON_CALL()` statements on `mock_object` too. Another trick you can use to achieve the same effect is to put the expectations in sequences and insert calls to a dummy "check-point" function at specific places. Then you can verify that the mock function calls do happen at the right time. For example, if you are exercising code: ``` Foo(1); Foo(2); Foo(3); ``` and want to verify that `Foo(1)` and `Foo(3)` both invoke `mock.Bar("a")`, but `Foo(2)` doesn't invoke anything. You can write: ``` using ::testing::MockFunction; TEST(FooTest, InvokesBarCorrectly) { MyMock mock; // Class MockFunction has exactly one mock method. It is named // Call() and has type F. MockFunction check; { InSequence s; EXPECT_CALL(mock, Bar("a")); EXPECT_CALL(check, Call("1")); EXPECT_CALL(check, Call("2")); EXPECT_CALL(mock, Bar("a")); } Foo(1); check.Call("1"); Foo(2); check.Call("2"); Foo(3); } ``` The expectation spec says that the first `Bar("a")` must happen before check point "1", the second `Bar("a")` must happen after check point "2", and nothing should happen between the two check points. The explicit check points make it easy to tell which `Bar("a")` is called by which call to `Foo()`. ## Mocking Destructors ## Sometimes you want to make sure a mock object is destructed at the right time, e.g. after `bar->A()` is called but before `bar->B()` is called. We already know that you can specify constraints on the order of mock function calls, so all we need to do is to mock the destructor of the mock function. This sounds simple, except for one problem: a destructor is a special function with special syntax and special semantics, and the `MOCK_METHOD0` macro doesn't work for it: ``` MOCK_METHOD0(~MockFoo, void()); // Won't compile! ``` The good news is that you can use a simple pattern to achieve the same effect. First, add a mock function `Die()` to your mock class and call it in the destructor, like this: ``` class MockFoo : public Foo { ... // Add the following two lines to the mock class. MOCK_METHOD0(Die, void()); virtual ~MockFoo() { Die(); } }; ``` (If the name `Die()` clashes with an existing symbol, choose another name.) Now, we have translated the problem of testing when a `MockFoo` object dies to testing when its `Die()` method is called: ``` MockFoo* foo = new MockFoo; MockBar* bar = new MockBar; ... { InSequence s; // Expects *foo to die after bar->A() and before bar->B(). EXPECT_CALL(*bar, A()); EXPECT_CALL(*foo, Die()); EXPECT_CALL(*bar, B()); } ``` And that's that. ## Using Google Mock and Threads ## **IMPORTANT NOTE:** What we describe in this recipe is **NOT** true yet, as Google Mock is not currently thread-safe. However, all we need to make it thread-safe is to implement some synchronization operations in `` - and then the information below will become true. In a **unit** test, it's best if you could isolate and test a piece of code in a single-threaded context. That avoids race conditions and dead locks, and makes debugging your test much easier. Yet many programs are multi-threaded, and sometimes to test something we need to pound on it from more than one thread. Google Mock works for this purpose too. Remember the steps for using a mock: 1. Create a mock object `foo`. 1. Set its default actions and expectations using `ON_CALL()` and `EXPECT_CALL()`. 1. The code under test calls methods of `foo`. 1. Optionally, verify and reset the mock. 1. Destroy the mock yourself, or let the code under test destroy it. The destructor will automatically verify it. If you follow the following simple rules, your mocks and threads can live happily togeter: * Execute your _test code_ (as opposed to the code being tested) in _one_ thread. This makes your test easy to follow. * Obviously, you can do step #1 without locking. * When doing step #2 and #5, make sure no other thread is accessing `foo`. Obvious too, huh? * #3 and #4 can be done either in one thread or in multiple threads - anyway you want. Google Mock takes care of the locking, so you don't have to do any - unless required by your test logic. If you violate the rules (for example, if you set expectations on a mock while another thread is calling its methods), you get undefined behavior. That's not fun, so don't do it. Google Mock guarantees that the action for a mock function is done in the same thread that called the mock function. For example, in ``` EXPECT_CALL(mock, Foo(1)) .WillOnce(action1); EXPECT_CALL(mock, Foo(2)) .WillOnce(action2); ``` if `Foo(1)` is called in thread 1 and `Foo(2)` is called in thread 2, Google Mock will execute `action1` in thread 1 and `action2` in thread 2. Google Mock does _not_ impose a sequence on actions performed in different threads (doing so may create deadlocks as the actions may need to cooperate). This means that the execution of `action1` and `action2` in the above example _may_ interleave. If this is a problem, you should add proper synchronization logic to `action1` and `action2` to make the test thread-safe. Also, remember that `DefaultValue` is a global resource that potentially affects _all_ living mock objects in your program. Naturally, you won't want to mess with it from multiple threads or when there still are mocks in action. ## Controlling How Much Information Google Mock Prints ## When Google Mock sees something that has the potential of being an error (e.g. a mock function with no expectation is called, a.k.a. an uninteresting call, which is allowed but perhaps you forgot to explicitly ban the call), it prints some warning messages, including the arguments of the function and the return value. Hopefully this will remind you to take a look and see if there is indeed a problem. Sometimes you are confident that your tests are correct and may not appreciate such friendly messages. Some other times, you are debugging your tests or learning about the behavior of the code you are testing, and wish you could observe every mock call that happens (including argument values and the return value). Clearly, one size doesn't fit all. You can control how much Google Mock tells you using the `--gmock_verbose=LEVEL` command-line flag, where `LEVEL` is a string with three possible values: * `info`: Google Mock will print all informational messages, warnings, and errors (most verbose). At this setting, Google Mock will also log any calls to the `ON_CALL/EXPECT_CALL` macros. * `warning`: Google Mock will print both warnings and errors (less verbose). This is the default. * `error`: Google Mock will print errors only (least verbose). Alternatively, you can adjust the value of that flag from within your tests like so: ``` ::testing::FLAGS_gmock_verbose = "error"; ``` Now, judiciously use the right flag to enable Google Mock serve you better! ## Running Tests in Emacs ## If you build and run your tests in Emacs, the source file locations of Google Mock and [Google Test](http://code.google.com/p/googletest/) errors will be highlighted. Just press `` on one of them and you'll be taken to the offending line. Or, you can just type `C-x `` to jump to the next error. To make it even easier, you can add the following lines to your `~/.emacs` file: ``` (global-set-key "\M-m" 'compile) ; m is for make (global-set-key [M-down] 'next-error) (global-set-key [M-up] '(lambda () (interactive) (next-error -1))) ``` Then you can type `M-m` to start a build, or `M-up`/`M-down` to move back and forth between errors. ## Fusing Google Mock Source Files ## Google Mock's implementation consists of dozens of files (excluding its own tests). Sometimes you may want them to be packaged up in fewer files instead, such that you can easily copy them to a new machine and start hacking there. For this we provide an experimental Python script `fuse_gmock_files.py` in the `scripts/` directory (starting with release 1.2.0). Assuming you have Python 2.4 or above installed on your machine, just go to that directory and run ``` python fuse_gmock_files.py OUTPUT_DIR ``` and you should see an `OUTPUT_DIR` directory being created with files `gtest/gtest.h`, `gmock/gmock.h`, and `gmock-gtest-all.cc` in it. These three files contain everything you need to use Google Mock (and Google Test). Just copy them to anywhere you want and you are ready to write tests and use mocks. You can use the [scrpts/test/Makefile](http://code.google.com/p/googlemock/source/browse/trunk/scripts/test/Makefile) file as an example on how to compile your tests against them. # Extending Google Mock # ## Writing New Matchers Quickly ## The `MATCHER*` family of macros can be used to define custom matchers easily. The syntax: ``` MATCHER(name, "description string") { statements; } ``` will define a matcher with the given name that executes the statements, which must return a `bool` to indicate if the match succeeds. Inside the statements, you can refer to the value being matched by `arg`, and refer to its type by `arg_type`. The description string documents what the matcher does, and is used to generate the failure message when the match fails. Since a `MATCHER()` is usually defined in a header file shared by multiple C++ source files, we require the description to be a C-string _literal_ to avoid possible side effects. It can be empty (`""`), in which case Google Mock will use the sequence of words in the matcher name as the description. For example: ``` MATCHER(IsDivisibleBy7, "") { return (arg % 7) == 0; } ``` allows you to write ``` // Expects mock_foo.Bar(n) to be called where n is divisible by 7. EXPECT_CALL(mock_foo, Bar(IsDivisibleBy7())); ``` or, ``` // Verifies that the value of some_expression is divisible by 7. EXPECT_THAT(some_expression, IsDivisibleBy7()); ``` If the above assertion fails, it will print something like: ``` Value of: some_expression Expected: is divisible by 7 Actual: 27 ``` where the description `"is divisible by 7"` is automatically calculated from the matcher name `IsDivisibleBy7`. Optionally, you can stream additional information to a hidden argument named `result_listener` to explain the match result. For example, a better definition of `IsDivisibleBy7` is: ``` MATCHER(IsDivisibleBy7, "") { if ((arg % 7) == 0) return true; *result_listener << "the remainder is " << (arg % 7); return false; } ``` With this definition, the above assertion will give a better message: ``` Value of: some_expression Expected: is divisible by 7 Actual: 27 (the remainder is 6) ``` You should let `MatchAndExplain()` print _any additional information_ that can help a user understand the match result. Note that it should explain why the match succeeds in case of a success (unless it's obvious) - this is useful when the matcher is used inside `Not()`. There is no need to print the argument value itself, as Google Mock already prints it for you. **Notes:** 1. The type of the value being matched (`arg_type`) is determined by the context in which you use the matcher and is supplied to you by the compiler, so you don't need to worry about declaring it (nor can you). This allows the matcher to be polymorphic. For example, `IsDivisibleBy7()` can be used to match any type where the value of `(arg % 7) == 0` can be implicitly converted to a `bool`. In the `Bar(IsDivisibleBy7())` example above, if method `Bar()` takes an `int`, `arg_type` will be `int`; if it takes an `unsigned long`, `arg_type` will be `unsigned long`; and so on. 1. Google Mock doesn't guarantee when or how many times a matcher will be invoked. Therefore the matcher logic must be _purely functional_ (i.e. it cannot have any side effect, and the result must not depend on anything other than the value being matched and the matcher parameters). This requirement must be satisfied no matter how you define the matcher (e.g. using one of the methods described in the following recipes). In particular, a matcher can never call a mock function, as that will affect the state of the mock object and Google Mock. ## Writing New Parameterized Matchers Quickly ## Sometimes you'll want to define a matcher that has parameters. For that you can use the macro: ``` MATCHER_P(name, param_name, "description string") { statements; } ``` For example: ``` MATCHER_P(HasAbsoluteValue, value, "") { return abs(arg) == value; } ``` will allow you to write: ``` EXPECT_THAT(Blah("a"), HasAbsoluteValue(n)); ``` which may lead to this message (assuming `n` is 10): ``` Value of: Blah("a") Expected: has absolute value 10 Actual: -9 ``` Note that both the matcher description and its parameter are printed, making the message human-friendly. In the matcher definition body, you can write `foo_type` to reference the type of a parameter named `foo`. For example, in the body of `MATCHER_P(HasAbsoluteValue, value)` above, you can write `value_type` to refer to the type of `value`. Google Mock also provides `MATCHER_P2`, `MATCHER_P3`, ..., up to `MATCHER_P10` to support multi-parameter matchers: ``` MATCHER_Pk(name, param_1, ..., param_k, "description string") { statements; } ``` Please note that the custom description string is for a particular **instance** of the matcher, where the parameters have been bound to actual values. Therefore usually you'll want the parameter values to be part of the description. Google Mock lets you do that using Python-style interpolations. The following syntaxes are supported currently: | `%%` | a single `%` character | |:-----|:-----------------------| | `%(*)s` | all parameters of the matcher printed as a tuple | | `%(foo)s` | value of the matcher parameter named `foo` | For example, ``` MATCHER_P2(InClosedRange, low, hi, "is in range [%(low)s, %(hi)s]") { return low <= arg && arg <= hi; } ... EXPECT_THAT(3, InClosedRange(4, 6)); ``` would generate a failure that contains the message: ``` Expected: is in range [4, 6] ``` If you specify `""` as the description, the failure message will contain the sequence of words in the matcher name followed by the parameter values printed as a tuple. For example, ``` MATCHER_P2(InClosedRange, low, hi, "") { ... } ... EXPECT_THAT(3, InClosedRange(4, 6)); ``` would generate a failure that contains the text: ``` Expected: in closed range (4, 6) ``` For the purpose of typing, you can view ``` MATCHER_Pk(Foo, p1, ..., pk, "description string") { ... } ``` as shorthand for ``` template FooMatcherPk Foo(p1_type p1, ..., pk_type pk) { ... } ``` When you write `Foo(v1, ..., vk)`, the compiler infers the types of the parameters `v1`, ..., and `vk` for you. If you are not happy with the result of the type inference, you can specify the types by explicitly instantiating the template, as in `Foo(5, false)`. As said earlier, you don't get to (or need to) specify `arg_type` as that's determined by the context in which the matcher is used. You can assign the result of expression `Foo(p1, ..., pk)` to a variable of type `FooMatcherPk`. This can be useful when composing matchers. Matchers that don't have a parameter or have only one parameter have special types: you can assign `Foo()` to a `FooMatcher`-typed variable, and assign `Foo(p)` to a `FooMatcherP`-typed variable. While you can instantiate a matcher template with reference types, passing the parameters by pointer usually makes your code more readable. If, however, you still want to pass a parameter by reference, be aware that in the failure message generated by the matcher you will see the value of the referenced object but not its address. You can overload matchers with different numbers of parameters: ``` MATCHER_P(Blah, a, "description string 1") { ... } MATCHER_P2(Blah, a, b, "description string 2") { ... } ``` While it's tempting to always use the `MATCHER*` macros when defining a new matcher, you should also consider implementing `MatcherInterface` or using `MakePolymorphicMatcher()` instead (see the recipes that follow), especially if you need to use the matcher a lot. While these approaches require more work, they give you more control on the types of the value being matched and the matcher parameters, which in general leads to better compiler error messages that pay off in the long run. They also allow overloading matchers based on parameter types (as opposed to just based on the number of parameters). ## Writing New Monomorphic Matchers ## A matcher of argument type `T` implements `::testing::MatcherInterface` and does two things: it tests whether a value of type `T` matches the matcher, and can describe what kind of values it matches. The latter ability is used for generating readable error messages when expectations are violated. The interface looks like this: ``` class MatchResultListener { public: ... // Streams x to the underlying ostream; does nothing if the ostream // is NULL. template MatchResultListener& operator<<(const T& x); // Returns the underlying ostream. ::std::ostream* stream(); }; template class MatcherInterface { public: virtual ~MatcherInterface(); // Returns true iff the matcher matches x; also explains the match // result to 'listener'. virtual bool MatchAndExplain(T x, MatchResultListener* listener) const = 0; // Describes this matcher to an ostream. virtual void DescribeTo(::std::ostream* os) const = 0; // Describes the negation of this matcher to an ostream. virtual void DescribeNegationTo(::std::ostream* os) const; }; ``` If you need a custom matcher but `Truly()` is not a good option (for example, you may not be happy with the way `Truly(predicate)` describes itself, or you may want your matcher to be polymorphic as `Eq(value)` is), you can define a matcher to do whatever you want in two steps: first implement the matcher interface, and then define a factory function to create a matcher instance. The second step is not strictly needed but it makes the syntax of using the matcher nicer. For example, you can define a matcher to test whether an `int` is divisible by 7 and then use it like this: ``` using ::testing::MakeMatcher; using ::testing::Matcher; using ::testing::MatcherInterface; using ::testing::MatchResultListener; class DivisibleBy7Matcher : public MatcherInterface { public: virtual bool MatchAndExplain(int n, MatchResultListener* listener) const { return (n % 7) == 0; } virtual void DescribeTo(::std::ostream* os) const { *os << "is divisible by 7"; } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "is not divisible by 7"; } }; inline Matcher DivisibleBy7() { return MakeMatcher(new DivisibleBy7Matcher); } ... EXPECT_CALL(foo, Bar(DivisibleBy7())); ``` You may improve the matcher message by streaming additional information to the `listener` argument in `MatchAndExplain()`: ``` class DivisibleBy7Matcher : public MatcherInterface { public: virtual bool MatchAndExplain(int n, MatchResultListener* listener) const { const int remainder = n % 7; if (remainder != 0) { *listener << "the remainder is " << remainder; } return remainder == 0; } ... }; ``` Then, `EXPECT_THAT(x, DivisibleBy7());` may general a message like this: ``` Value of: x Expected: is divisible by 7 Actual: 23 (the remainder is 2) ``` ## Writing New Polymorphic Matchers ## You've learned how to write your own matchers in the previous recipe. Just one problem: a matcher created using `MakeMatcher()` only works for one particular type of arguments. If you want a _polymorphic_ matcher that works with arguments of several types (for instance, `Eq(x)` can be used to match a `value` as long as `value` == `x` compiles -- `value` and `x` don't have to share the same type), you can learn the trick from `` but it's a bit involved. Fortunately, most of the time you can define a polymorphic matcher easily with the help of `MakePolymorphicMatcher()`. Here's how you can define `NotNull()` as an example: ``` using ::testing::MakePolymorphicMatcher; using ::testing::MatchResultListener; using ::testing::NotNull; using ::testing::PolymorphicMatcher; class NotNullMatcher { public: // To implement a polymorphic matcher, first define a COPYABLE class // that has three members MatchAndExplain(), DescribeTo(), and // DescribeNegationTo(), like the following. // In this example, we want to use NotNull() with any pointer, so // MatchAndExplain() accepts a pointer of any type as its first argument. // In general, you can define MatchAndExplain() as an ordinary method or // a method template, or even overload it. template bool MatchAndExplain(T* p, MatchResultListener* /* listener */) const { return p != NULL; } // Describes the property of a value matching this matcher. void DescribeTo(::std::ostream* os) const { *os << "is not NULL"; } // Describes the property of a value NOT matching this matcher. void DescribeNegationTo(::std::ostream* os) const { *os << "is NULL"; } }; // To construct a polymorphic matcher, pass an instance of the class // to MakePolymorphicMatcher(). Note the return type. inline PolymorphicMatcher NotNull() { return MakePolymorphicMatcher(NotNullMatcher()); } ... EXPECT_CALL(foo, Bar(NotNull())); // The argument must be a non-NULL pointer. ``` **Note:** Your polymorphic matcher class does **not** need to inherit from `MatcherInterface` or any other class, and its methods do **not** need to be virtual. Like in a monomorphic matcher, you may explain the match result by streaming additional information to the `listener` argument in `MatchAndExplain()`. ## Writing New Cardinalities ## A cardinality is used in `Times()` to tell Google Mock how many times you expect a call to occur. It doesn't have to be exact. For example, you can say `AtLeast(5)` or `Between(2, 4)`. If the built-in set of cardinalities doesn't suit you, you are free to define your own by implementing the following interface (in namespace `testing`): ``` class CardinalityInterface { public: virtual ~CardinalityInterface(); // Returns true iff call_count calls will satisfy this cardinality. virtual bool IsSatisfiedByCallCount(int call_count) const = 0; // Returns true iff call_count calls will saturate this cardinality. virtual bool IsSaturatedByCallCount(int call_count) const = 0; // Describes self to an ostream. virtual void DescribeTo(::std::ostream* os) const = 0; }; ``` For example, to specify that a call must occur even number of times, you can write ``` using ::testing::Cardinality; using ::testing::CardinalityInterface; using ::testing::MakeCardinality; class EvenNumberCardinality : public CardinalityInterface { public: virtual bool IsSatisfiedByCallCount(int call_count) const { return (call_count % 2) == 0; } virtual bool IsSaturatedByCallCount(int call_count) const { return false; } virtual void DescribeTo(::std::ostream* os) const { *os << "called even number of times"; } }; Cardinality EvenNumber() { return MakeCardinality(new EvenNumberCardinality); } ... EXPECT_CALL(foo, Bar(3)) .Times(EvenNumber()); ``` ## Writing New Actions Quickly ## If the built-in actions don't work for you, and you find it inconvenient to use `Invoke()`, you can use a macro from the `ACTION*` family to quickly define a new action that can be used in your code as if it's a built-in action. By writing ``` ACTION(name) { statements; } ``` in a namespace scope (i.e. not inside a class or function), you will define an action with the given name that executes the statements. The value returned by `statements` will be used as the return value of the action. Inside the statements, you can refer to the K-th (0-based) argument of the mock function as `argK`. For example: ``` ACTION(IncrementArg1) { return ++(*arg1); } ``` allows you to write ``` ... WillOnce(IncrementArg1()); ``` Note that you don't need to specify the types of the mock function arguments. Rest assured that your code is type-safe though: you'll get a compiler error if `*arg1` doesn't support the `++` operator, or if the type of `++(*arg1)` isn't compatible with the mock function's return type. Another example: ``` ACTION(Foo) { (*arg2)(5); Blah(); *arg1 = 0; return arg0; } ``` defines an action `Foo()` that invokes argument #2 (a function pointer) with 5, calls function `Blah()`, sets the value pointed to by argument #1 to 0, and returns argument #0. For more convenience and flexibility, you can also use the following pre-defined symbols in the body of `ACTION`: | `argK_type` | The type of the K-th (0-based) argument of the mock function | |:------------|:-------------------------------------------------------------| | `args` | All arguments of the mock function as a tuple | | `args_type` | The type of all arguments of the mock function as a tuple | | `return_type` | The return type of the mock function | | `function_type` | The type of the mock function | For example, when using an `ACTION` as a stub action for mock function: ``` int DoSomething(bool flag, int* ptr); ``` we have: | **Pre-defined Symbol** | **Is Bound To** | |:-----------------------|:----------------| | `arg0` | the value of `flag` | | `arg0_type` | the type `bool` | | `arg1` | the value of `ptr` | | `arg1_type` | the type `int*` | | `args` | the tuple `(flag, ptr)` | | `args_type` | the type `std::tr1::tuple` | | `return_type` | the type `int` | | `function_type` | the type `int(bool, int*)` | ## Writing New Parameterized Actions Quickly ## Sometimes you'll want to parameterize an action you define. For that we have another macro ``` ACTION_P(name, param) { statements; } ``` For example, ``` ACTION_P(Add, n) { return arg0 + n; } ``` will allow you to write ``` // Returns argument #0 + 5. ... WillOnce(Add(5)); ``` For convenience, we use the term _arguments_ for the values used to invoke the mock function, and the term _parameters_ for the values used to instantiate an action. Note that you don't need to provide the type of the parameter either. Suppose the parameter is named `param`, you can also use the Google-Mock-defined symbol `param_type` to refer to the type of the parameter as inferred by the compiler. For example, in the body of `ACTION_P(Add, n)` above, you can write `n_type` for the type of `n`. Google Mock also provides `ACTION_P2`, `ACTION_P3`, and etc to support multi-parameter actions. For example, ``` ACTION_P2(ReturnDistanceTo, x, y) { double dx = arg0 - x; double dy = arg1 - y; return sqrt(dx*dx + dy*dy); } ``` lets you write ``` ... WillOnce(ReturnDistanceTo(5.0, 26.5)); ``` You can view `ACTION` as a degenerated parameterized action where the number of parameters is 0. You can also easily define actions overloaded on the number of parameters: ``` ACTION_P(Plus, a) { ... } ACTION_P2(Plus, a, b) { ... } ``` ## Restricting the Type of an Argument or Parameter in an ACTION ## For maximum brevity and reusability, the `ACTION*` macros don't ask you to provide the types of the mock function arguments and the action parameters. Instead, we let the compiler infer the types for us. Sometimes, however, we may want to be more explicit about the types. There are several tricks to do that. For example: ``` ACTION(Foo) { // Makes sure arg0 can be converted to int. int n = arg0; ... use n instead of arg0 here ... } ACTION_P(Bar, param) { // Makes sure the type of arg1 is const char*. ::testing::StaticAssertTypeEq(); // Makes sure param can be converted to bool. bool flag = param; } ``` where `StaticAssertTypeEq` is a compile-time assertion in Google Test that verifies two types are the same. ## Writing New Action Templates Quickly ## Sometimes you want to give an action explicit template parameters that cannot be inferred from its value parameters. `ACTION_TEMPLATE()` supports that and can be viewed as an extension to `ACTION()` and `ACTION_P*()`. The syntax: ``` ACTION_TEMPLATE(ActionName, HAS_m_TEMPLATE_PARAMS(kind1, name1, ..., kind_m, name_m), AND_n_VALUE_PARAMS(p1, ..., p_n)) { statements; } ``` defines an action template that takes _m_ explicit template parameters and _n_ value parameters, where _m_ is between 1 and 10, and _n_ is between 0 and 10. `name_i` is the name of the i-th template parameter, and `kind_i` specifies whether it's a `typename`, an integral constant, or a template. `p_i` is the name of the i-th value parameter. Example: ``` // DuplicateArg(output) converts the k-th argument of the mock // function to type T and copies it to *output. ACTION_TEMPLATE(DuplicateArg, // Note the comma between int and k: HAS_2_TEMPLATE_PARAMS(int, k, typename, T), AND_1_VALUE_PARAMS(output)) { *output = T(std::tr1::get(args)); } ``` To create an instance of an action template, write: ``` ActionName(v1, ..., v_n) ``` where the `t`s are the template arguments and the `v`s are the value arguments. The value argument types are inferred by the compiler. For example: ``` using ::testing::_; ... int n; EXPECT_CALL(mock, Foo(_, _)) .WillOnce(DuplicateArg<1, unsigned char>(&n)); ``` If you want to explicitly specify the value argument types, you can provide additional template arguments: ``` ActionName(v1, ..., v_n) ``` where `u_i` is the desired type of `v_i`. `ACTION_TEMPLATE` and `ACTION`/`ACTION_P*` can be overloaded on the number of value parameters, but not on the number of template parameters. Without the restriction, the meaning of the following is unclear: ``` OverloadedAction(x); ``` Are we using a single-template-parameter action where `bool` refers to the type of `x`, or a two-template-parameter action where the compiler is asked to infer the type of `x`? ## Using the ACTION Object's Type ## If you are writing a function that returns an `ACTION` object, you'll need to know its type. The type depends on the macro used to define the action and the parameter types. The rule is relatively simple: | **Given Definition** | **Expression** | **Has Type** | |:---------------------|:---------------|:-------------| | `ACTION(Foo)` | `Foo()` | `FooAction` | | `ACTION_TEMPLATE(Foo, HAS_m_TEMPLATE_PARAMS(...), AND_0_VALUE_PARAMS())` | `Foo()` | `FooAction` | | `ACTION_P(Bar, param)` | `Bar(int_value)` | `BarActionP` | | `ACTION_TEMPLATE(Bar, HAS_m_TEMPLATE_PARAMS(...), AND_1_VALUE_PARAMS(p1))` | `Bar(int_value)` | `FooActionP` | | `ACTION_P2(Baz, p1, p2)` | `Baz(bool_value, int_value)` | `BazActionP2` | | `ACTION_TEMPLATE(Baz, HAS_m_TEMPLATE_PARAMS(...), AND_2_VALUE_PARAMS(p1, p2))` | `Baz(bool_value, int_value)` | `FooActionP2` | | ... | ... | ... | Note that we have to pick different suffixes (`Action`, `ActionP`, `ActionP2`, and etc) for actions with different numbers of value parameters, or the action definitions cannot be overloaded on the number of them. ## Writing New Monomorphic Actions ## While the `ACTION*` macros are very convenient, sometimes they are inappropriate. For example, despite the tricks shown in the previous recipes, they don't let you directly specify the types of the mock function arguments and the action parameters, which in general leads to unoptimized compiler error messages that can baffle unfamiliar users. They also don't allow overloading actions based on parameter types without jumping through some hoops. An alternative to the `ACTION*` macros is to implement `::testing::ActionInterface`, where `F` is the type of the mock function in which the action will be used. For example: ``` template class ActionInterface { public: virtual ~ActionInterface(); // Performs the action. Result is the return type of function type // F, and ArgumentTuple is the tuple of arguments of F. // // For example, if F is int(bool, const string&), then Result would // be int, and ArgumentTuple would be tr1::tuple. virtual Result Perform(const ArgumentTuple& args) = 0; }; using ::testing::_; using ::testing::Action; using ::testing::ActionInterface; using ::testing::MakeAction; typedef int IncrementMethod(int*); class IncrementArgumentAction : public ActionInterface { public: virtual int Perform(const tr1::tuple& args) { int* p = tr1::get<0>(args); // Grabs the first argument. return *p++; } }; Action IncrementArgument() { return MakeAction(new IncrementArgumentAction); } ... EXPECT_CALL(foo, Baz(_)) .WillOnce(IncrementArgument()); int n = 5; foo.Baz(&n); // Should return 5 and change n to 6. ``` ## Writing New Polymorphic Actions ## The previous recipe showed you how to define your own action. This is all good, except that you need to know the type of the function in which the action will be used. Sometimes that can be a problem. For example, if you want to use the action in functions with _different_ types (e.g. like `Return()` and `SetArgumentPointee()`). If an action can be used in several types of mock functions, we say it's _polymorphic_. The `MakePolymorphicAction()` function template makes it easy to define such an action: ``` namespace testing { template PolymorphicAction MakePolymorphicAction(const Impl& impl); } // namespace testing ``` As an example, let's define an action that returns the second argument in the mock function's argument list. The first step is to define an implementation class: ``` class ReturnSecondArgumentAction { public: template Result Perform(const ArgumentTuple& args) const { // To get the i-th (0-based) argument, use tr1::get(args). return tr1::get<1>(args); } }; ``` This implementation class does _not_ need to inherit from any particular class. What matters is that it must have a `Perform()` method template. This method template takes the mock function's arguments as a tuple in a **single** argument, and returns the result of the action. It can be either `const` or not, but must be invokable with exactly one template argument, which is the result type. In other words, you must be able to call `Perform(args)` where `R` is the mock function's return type and `args` is its arguments in a tuple. Next, we use `MakePolymorphicAction()` to turn an instance of the implementation class into the polymorphic action we need. It will be convenient to have a wrapper for this: ``` using ::testing::MakePolymorphicAction; using ::testing::PolymorphicAction; PolymorphicAction ReturnSecondArgument() { return MakePolymorphicAction(ReturnSecondArgumentAction()); } ``` Now, you can use this polymorphic action the same way you use the built-in ones: ``` using ::testing::_; class MockFoo : public Foo { public: MOCK_METHOD2(DoThis, int(bool flag, int n)); MOCK_METHOD3(DoThat, string(int x, const char* str1, const char* str2)); }; ... MockFoo foo; EXPECT_CALL(foo, DoThis(_, _)) .WillOnce(ReturnSecondArgument()); EXPECT_CALL(foo, DoThat(_, _, _)) .WillOnce(ReturnSecondArgument()); ... foo.DoThis(true, 5); // Will return 5. foo.DoThat(1, "Hi", "Bye"); // Will return "Hi". ``` ## Teaching Google Mock How to Print Your Values ## When an uninteresting or unexpected call occurs, Google Mock prints the argument values to help you debug. The `EXPECT_THAT` and `ASSERT_THAT` assertions also print the value being validated when the test fails. Google Mock does this using the user-extensible value printer defined in ``. This printer knows how to print the built-in C++ types, native arrays, STL containers, and any type that supports the `<<` operator. For other types, it prints the raw bytes in the value and hope you the user can figure it out. Did I say that the printer is `extensible`? That means you can teach it to do a better job at printing your particular type than to dump the bytes. To do that, you just need to define `<<` for your type: ``` #include namespace foo { class Foo { ... }; // It's important that the << operator is defined in the SAME // namespace that defines Foo. C++'s look-up rules rely on that. ::std::ostream& operator<<(::std::ostream& os, const Foo& foo) { return os << foo.DebugString(); // Whatever needed to print foo to os. } } // namespace foo ``` Sometimes, this might not be an option. For example, your team may consider it dangerous or bad style to have a `<<` operator for `Foo`, or `Foo` may already have a `<<` operator that doesn't do what you want (and you cannot change it). Don't despair though - Google Mock gives you a second chance to get it right. Namely, you can define a `PrintTo()` function like this: ``` #include namespace foo { class Foo { ... }; // It's important that PrintTo() is defined in the SAME // namespace that defines Foo. C++'s look-up rules rely on that. void PrintTo(const Foo& foo, ::std::ostream* os) { *os << foo.DebugString(); // Whatever needed to print foo to os. } } // namespace foo ``` What if you have both `<<` and `PrintTo()`? In this case, the latter will override the former when Google Mock is concerned. This allows you to customize how the value should appear in Google Mock's output without affecting code that relies on the behavior of its `<<` operator. **Note:** When printing a pointer of type `T*`, Google Mock calls `PrintTo(T*, std::ostream* os)` instead of `operator<<(std::ostream&, T*)`. Therefore the only way to affect how a pointer is printed by Google Mock is to define `PrintTo()` for it. Also note that `T*` and `const T*` are different types, so you may need to define `PrintTo()` for both. Why does Google Mock treat pointers specially? There are several reasons: * We cannot use `operator<<` to print a `signed char*` or `unsigned char*`, since it will print the pointer as a NUL-terminated C string, which likely will cause an access violation. * We want `NULL` pointers to be printed as `"NULL"`, but `operator<<` prints it as `"0"`, `"nullptr"`, or something else, depending on the compiler. * With some compilers, printing a `NULL` `char*` using `operator<<` will segfault. * `operator<<` prints a function pointer as a `bool` (hence it always prints `"1"`), which is not very useful.vendor/googletest/gtest-1.7.0/googlemock/docs/v1_5/Documentation.md000066400000000000000000000014151300002025200252620ustar00rootroot00000000000000This page lists all documentation wiki pages for Google Mock **version 1.5.0** -- **if you use a different version of Google Mock, please read the documentation for that specific version instead.** * [ForDummies](V1_5_ForDummies.md) -- start here if you are new to Google Mock. * [CheatSheet](V1_5_CheatSheet.md) -- a quick reference. * [CookBook](V1_5_CookBook.md) -- recipes for doing various tasks using Google Mock. * [FrequentlyAskedQuestions](V1_5_FrequentlyAskedQuestions.md) -- check here before asking a question on the mailing list. To contribute code to Google Mock, read: * DevGuide -- read this _before_ writing your first patch. * [Pump Manual](http://code.google.com/p/googletest/wiki/PumpManual) -- how we generate some of Google Mock's source files.vendor/googletest/gtest-1.7.0/googlemock/docs/v1_5/ForDummies.md000066400000000000000000000722331300002025200245310ustar00rootroot00000000000000 (**Note:** If you get compiler errors that you don't understand, be sure to consult [Google Mock Doctor](V1_5_FrequentlyAskedQuestions#How_am_I_supposed_to_make_sense_of_these_horrible_template_error.md).) # What Is Google C++ Mocking Framework? # When you write a prototype or test, often it's not feasible or wise to rely on real objects entirely. A **mock object** implements the same interface as a real object (so it can be used as one), but lets you specify at run time how it will be used and what it should do (which methods will be called? in which order? how many times? with what arguments? what will they return? etc). **Note:** It is easy to confuse the term _fake objects_ with mock objects. Fakes and mocks actually mean very different things in the Test-Driven Development (TDD) community: * **Fake** objects have working implementations, but usually take some shortcut (perhaps to make the operations less expensive), which makes them not suitable for production. An in-memory file system would be an example of a fake. * **Mocks** are objects pre-programmed with _expectations_, which form a specification of the calls they are expected to receive. If all this seems too abstract for you, don't worry - the most important thing to remember is that a mock allows you to check the _interaction_ between itself and code that uses it. The difference between fakes and mocks will become much clearer once you start to use mocks. **Google C++ Mocking Framework** (or **Google Mock** for short) is a library (sometimes we also call it a "framework" to make it sound cool) for creating mock classes and using them. It does to C++ what [jMock](http://www.jmock.org/) and [EasyMock](http://www.easymock.org/) do to Java. Using Google Mock involves three basic steps: 1. Use some simple macros to describe the interface you want to mock, and they will expand to the implementation of your mock class; 1. Create some mock objects and specify its expectations and behavior using an intuitive syntax; 1. Exercise code that uses the mock objects. Google Mock will catch any violation of the expectations as soon as it arises. # Why Google Mock? # While mock objects help you remove unnecessary dependencies in tests and make them fast and reliable, using mocks manually in C++ is _hard_: * Someone has to implement the mocks. The job is usually tedious and error-prone. No wonder people go great distance to avoid it. * The quality of those manually written mocks is a bit, uh, unpredictable. You may see some really polished ones, but you may also see some that were hacked up in a hurry and have all sorts of ad hoc restrictions. * The knowledge you gained from using one mock doesn't transfer to the next. In contrast, Java and Python programmers have some fine mock frameworks, which automate the creation of mocks. As a result, mocking is a proven effective technique and widely adopted practice in those communities. Having the right tool absolutely makes the difference. Google Mock was built to help C++ programmers. It was inspired by [jMock](http://www.jmock.org/) and [EasyMock](http://www.easymock.org/), but designed with C++'s specifics in mind. It is your friend if any of the following problems is bothering you: * You are stuck with a sub-optimal design and wish you had done more prototyping before it was too late, but prototyping in C++ is by no means "rapid". * Your tests are slow as they depend on too many libraries or use expensive resources (e.g. a database). * Your tests are brittle as some resources they use are unreliable (e.g. the network). * You want to test how your code handles a failure (e.g. a file checksum error), but it's not easy to cause one. * You need to make sure that your module interacts with other modules in the right way, but it's hard to observe the interaction; therefore you resort to observing the side effects at the end of the action, which is awkward at best. * You want to "mock out" your dependencies, except that they don't have mock implementations yet; and, frankly, you aren't thrilled by some of those hand-written mocks. We encourage you to use Google Mock as: * a _design_ tool, for it lets you experiment with your interface design early and often. More iterations lead to better designs! * a _testing_ tool to cut your tests' outbound dependencies and probe the interaction between your module and its collaborators. # Getting Started # Using Google Mock is easy! Inside your C++ source file, just #include `` and ``, and you are ready to go. # A Case for Mock Turtles # Let's look at an example. Suppose you are developing a graphics program that relies on a LOGO-like API for drawing. How would you test that it does the right thing? Well, you can run it and compare the screen with a golden screen snapshot, but let's admit it: tests like this are expensive to run and fragile (What if you just upgraded to a shiny new graphics card that has better anti-aliasing? Suddenly you have to update all your golden images.). It would be too painful if all your tests are like this. Fortunately, you learned about Dependency Injection and know the right thing to do: instead of having your application talk to the drawing API directly, wrap the API in an interface (say, `Turtle`) and code to that interface: ``` class Turtle { ... virtual ~Turtle() {} virtual void PenUp() = 0; virtual void PenDown() = 0; virtual void Forward(int distance) = 0; virtual void Turn(int degrees) = 0; virtual void GoTo(int x, int y) = 0; virtual int GetX() const = 0; virtual int GetY() const = 0; }; ``` (Note that the destructor of `Turtle` **must** be virtual, as is the case for **all** classes you intend to inherit from - otherwise the destructor of the derived class will not be called when you delete an object through a base pointer, and you'll get corrupted program states like memory leaks.) You can control whether the turtle's movement will leave a trace using `PenUp()` and `PenDown()`, and control its movement using `Forward()`, `Turn()`, and `GoTo()`. Finally, `GetX()` and `GetY()` tell you the current position of the turtle. Your program will normally use a real implementation of this interface. In tests, you can use a mock implementation instead. This allows you to easily check what drawing primitives your program is calling, with what arguments, and in which order. Tests written this way are much more robust (they won't break because your new machine does anti-aliasing differently), easier to read and maintain (the intent of a test is expressed in the code, not in some binary images), and run _much, much faster_. # Writing the Mock Class # If you are lucky, the mocks you need to use have already been implemented by some nice people. If, however, you find yourself in the position to write a mock class, relax - Google Mock turns this task into a fun game! (Well, almost.) ## How to Define It ## Using the `Turtle` interface as example, here are the simple steps you need to follow: 1. Derive a class `MockTurtle` from `Turtle`. 1. Take a virtual function of `Turtle`. Count how many arguments it has. 1. In the `public:` section of the child class, write `MOCK_METHODn();` (or `MOCK_CONST_METHODn();` if you are mocking a `const` method), where `n` is the number of the arguments; if you counted wrong, shame on you, and a compiler error will tell you so. 1. Now comes the fun part: you take the function signature, cut-and-paste the _function name_ as the _first_ argument to the macro, and leave what's left as the _second_ argument (in case you're curious, this is the _type of the function_). 1. Repeat until all virtual functions you want to mock are done. After the process, you should have something like: ``` #include // Brings in Google Mock. class MockTurtle : public Turtle { public: ... MOCK_METHOD0(PenUp, void()); MOCK_METHOD0(PenDown, void()); MOCK_METHOD1(Forward, void(int distance)); MOCK_METHOD1(Turn, void(int degrees)); MOCK_METHOD2(GoTo, void(int x, int y)); MOCK_CONST_METHOD0(GetX, int()); MOCK_CONST_METHOD0(GetY, int()); }; ``` You don't need to define these mock methods somewhere else - the `MOCK_METHOD*` macros will generate the definitions for you. It's that simple! Once you get the hang of it, you can pump out mock classes faster than your source-control system can handle your check-ins. **Tip:** If even this is too much work for you, you'll find the `gmock_gen.py` tool in Google Mock's `scripts/generator/` directory (courtesy of the [cppclean](http://code.google.com/p/cppclean/) project) useful. This command-line tool requires that you have Python 2.4 installed. You give it a C++ file and the name of an abstract class defined in it, and it will print the definition of the mock class for you. Due to the complexity of the C++ language, this script may not always work, but it can be quite handy when it does. For more details, read the [user documentation](http://code.google.com/p/googlemock/source/browse/trunk/scripts/generator/README). ## Where to Put It ## When you define a mock class, you need to decide where to put its definition. Some people put it in a `*_test.cc`. This is fine when the interface being mocked (say, `Foo`) is owned by the same person or team. Otherwise, when the owner of `Foo` changes it, your test could break. (You can't really expect `Foo`'s maintainer to fix every test that uses `Foo`, can you?) So, the rule of thumb is: if you need to mock `Foo` and it's owned by others, define the mock class in `Foo`'s package (better, in a `testing` sub-package such that you can clearly separate production code and testing utilities), and put it in a `mock_foo.h`. Then everyone can reference `mock_foo.h` from their tests. If `Foo` ever changes, there is only one copy of `MockFoo` to change, and only tests that depend on the changed methods need to be fixed. Another way to do it: you can introduce a thin layer `FooAdaptor` on top of `Foo` and code to this new interface. Since you own `FooAdaptor`, you can absorb changes in `Foo` much more easily. While this is more work initially, carefully choosing the adaptor interface can make your code easier to write and more readable (a net win in the long run), as you can choose `FooAdaptor` to fit your specific domain much better than `Foo` does. # Using Mocks in Tests # Once you have a mock class, using it is easy. The typical work flow is: 1. Import the Google Mock names from the `testing` namespace such that you can use them unqualified (You only have to do it once per file. Remember that namespaces are a good idea and good for your health.). 1. Create some mock objects. 1. Specify your expectations on them (How many times will a method be called? With what arguments? What should it do? etc.). 1. Exercise some code that uses the mocks; optionally, check the result using Google Test assertions. If a mock method is called more than expected or with wrong arguments, you'll get an error immediately. 1. When a mock is destructed, Google Mock will automatically check whether all expectations on it have been satisfied. Here's an example: ``` #include "path/to/mock-turtle.h" #include #include using ::testing::AtLeast; // #1 TEST(PainterTest, CanDrawSomething) { MockTurtle turtle; // #2 EXPECT_CALL(turtle, PenDown()) // #3 .Times(AtLeast(1)); Painter painter(&turtle); // #4 EXPECT_TRUE(painter.DrawCircle(0, 0, 10)); } // #5 int main(int argc, char** argv) { // The following line must be executed to initialize Google Mock // (and Google Test) before running the tests. ::testing::InitGoogleMock(&argc, argv); return RUN_ALL_TESTS(); } ``` As you might have guessed, this test checks that `PenDown()` is called at least once. If the `painter` object didn't call this method, your test will fail with a message like this: ``` path/to/my_test.cc:119: Failure Actual function call count doesn't match this expectation: Actually: never called; Expected: called at least once. ``` **Tip 1:** If you run the test from an Emacs buffer, you can hit `` on the line number displayed in the error message to jump right to the failed expectation. **Tip 2:** If your mock objects are never deleted, the final verification won't happen. Therefore it's a good idea to use a heap leak checker in your tests when you allocate mocks on the heap. **Important note:** Google Mock requires expectations to be set **before** the mock functions are called, otherwise the behavior is **undefined**. In particular, you mustn't interleave `EXPECT_CALL()`s and calls to the mock functions. This means `EXPECT_CALL()` should be read as expecting that a call will occur _in the future_, not that a call has occurred. Why does Google Mock work like that? Well, specifying the expectation beforehand allows Google Mock to report a violation as soon as it arises, when the context (stack trace, etc) is still available. This makes debugging much easier. Admittedly, this test is contrived and doesn't do much. You can easily achieve the same effect without using Google Mock. However, as we shall reveal soon, Google Mock allows you to do _much more_ with the mocks. ## Using Google Mock with Any Testing Framework ## If you want to use something other than Google Test (e.g. [CppUnit](http://apps.sourceforge.net/mediawiki/cppunit/index.php?title=Main_Page) or [CxxTest](http://cxxtest.tigris.org/)) as your testing framework, just change the `main()` function in the previous section to: ``` int main(int argc, char** argv) { // The following line causes Google Mock to throw an exception on failure, // which will be interpreted by your testing framework as a test failure. ::testing::GTEST_FLAG(throw_on_failure) = true; ::testing::InitGoogleMock(&argc, argv); ... whatever your testing framework requires ... } ``` This approach has a catch: it makes Google Mock throw an exception from a mock object's destructor sometimes. With some compilers, this sometimes causes the test program to crash. You'll still be able to notice that the test has failed, but it's not a graceful failure. A better solution is to use Google Test's [event listener API](http://code.google.com/p/googletest/wiki/GoogleTestAdvancedGuide#Extending_Google_Test_by_Handling_Test_Events) to report a test failure to your testing framework properly. You'll need to implement the `OnTestPartResult()` method of the event listener interface, but it should be straightforward. If this turns out to be too much work, we suggest that you stick with Google Test, which works with Google Mock seamlessly (in fact, it is technically part of Google Mock.). If there is a reason that you cannot use Google Test, please let us know. # Setting Expectations # The key to using a mock object successfully is to set the _right expectations_ on it. If you set the expectations too strict, your test will fail as the result of unrelated changes. If you set them too loose, bugs can slip through. You want to do it just right such that your test can catch exactly the kind of bugs you intend it to catch. Google Mock provides the necessary means for you to do it "just right." ## General Syntax ## In Google Mock we use the `EXPECT_CALL()` macro to set an expectation on a mock method. The general syntax is: ``` EXPECT_CALL(mock_object, method(matchers)) .Times(cardinality) .WillOnce(action) .WillRepeatedly(action); ``` The macro has two arguments: first the mock object, and then the method and its arguments. Note that the two are separated by a comma (`,`), not a period (`.`). (Why using a comma? The answer is that it was necessary for technical reasons.) The macro can be followed by some optional _clauses_ that provide more information about the expectation. We'll discuss how each clause works in the coming sections. This syntax is designed to make an expectation read like English. For example, you can probably guess that ``` using ::testing::Return;... EXPECT_CALL(turtle, GetX()) .Times(5) .WillOnce(Return(100)) .WillOnce(Return(150)) .WillRepeatedly(Return(200)); ``` says that the `turtle` object's `GetX()` method will be called five times, it will return 100 the first time, 150 the second time, and then 200 every time. Some people like to call this style of syntax a Domain-Specific Language (DSL). **Note:** Why do we use a macro to do this? It serves two purposes: first it makes expectations easily identifiable (either by `grep` or by a human reader), and second it allows Google Mock to include the source file location of a failed expectation in messages, making debugging easier. ## Matchers: What Arguments Do We Expect? ## When a mock function takes arguments, we must specify what arguments we are expecting; for example: ``` // Expects the turtle to move forward by 100 units. EXPECT_CALL(turtle, Forward(100)); ``` Sometimes you may not want to be too specific (Remember that talk about tests being too rigid? Over specification leads to brittle tests and obscures the intent of tests. Therefore we encourage you to specify only what's necessary - no more, no less.). If you care to check that `Forward()` will be called but aren't interested in its actual argument, write `_` as the argument, which means "anything goes": ``` using ::testing::_; ... // Expects the turtle to move forward. EXPECT_CALL(turtle, Forward(_)); ``` `_` is an instance of what we call **matchers**. A matcher is like a predicate and can test whether an argument is what we'd expect. You can use a matcher inside `EXPECT_CALL()` wherever a function argument is expected. A list of built-in matchers can be found in the [CheatSheet](V1_5_CheatSheet.md). For example, here's the `Ge` (greater than or equal) matcher: ``` using ::testing::Ge;... EXPECT_CALL(turtle, Forward(Ge(100))); ``` This checks that the turtle will be told to go forward by at least 100 units. ## Cardinalities: How Many Times Will It Be Called? ## The first clause we can specify following an `EXPECT_CALL()` is `Times()`. We call its argument a **cardinality** as it tells _how many times_ the call should occur. It allows us to repeat an expectation many times without actually writing it as many times. More importantly, a cardinality can be "fuzzy", just like a matcher can be. This allows a user to express the intent of a test exactly. An interesting special case is when we say `Times(0)`. You may have guessed - it means that the function shouldn't be called with the given arguments at all, and Google Mock will report a Google Test failure whenever the function is (wrongfully) called. We've seen `AtLeast(n)` as an example of fuzzy cardinalities earlier. For the list of built-in cardinalities you can use, see the [CheatSheet](V1_5_CheatSheet.md). The `Times()` clause can be omitted. **If you omit `Times()`, Google Mock will infer the cardinality for you.** The rules are easy to remember: * If **neither** `WillOnce()` **nor** `WillRepeatedly()` is in the `EXPECT_CALL()`, the inferred cardinality is `Times(1)`. * If there are `n WillOnce()`'s but **no** `WillRepeatedly()`, where `n` >= 1, the cardinality is `Times(n)`. * If there are `n WillOnce()`'s and **one** `WillRepeatedly()`, where `n` >= 0, the cardinality is `Times(AtLeast(n))`. **Quick quiz:** what do you think will happen if a function is expected to be called twice but actually called four times? ## Actions: What Should It Do? ## Remember that a mock object doesn't really have a working implementation? We as users have to tell it what to do when a method is invoked. This is easy in Google Mock. First, if the return type of a mock function is a built-in type or a pointer, the function has a **default action** (a `void` function will just return, a `bool` function will return `false`, and other functions will return 0). If you don't say anything, this behavior will be used. Second, if a mock function doesn't have a default action, or the default action doesn't suit you, you can specify the action to be taken each time the expectation matches using a series of `WillOnce()` clauses followed by an optional `WillRepeatedly()`. For example, ``` using ::testing::Return;... EXPECT_CALL(turtle, GetX()) .WillOnce(Return(100)) .WillOnce(Return(200)) .WillOnce(Return(300)); ``` This says that `turtle.GetX()` will be called _exactly three times_ (Google Mock inferred this from how many `WillOnce()` clauses we've written, since we didn't explicitly write `Times()`), and will return 100, 200, and 300 respectively. ``` using ::testing::Return;... EXPECT_CALL(turtle, GetY()) .WillOnce(Return(100)) .WillOnce(Return(200)) .WillRepeatedly(Return(300)); ``` says that `turtle.GetY()` will be called _at least twice_ (Google Mock knows this as we've written two `WillOnce()` clauses and a `WillRepeatedly()` while having no explicit `Times()`), will return 100 the first time, 200 the second time, and 300 from the third time on. Of course, if you explicitly write a `Times()`, Google Mock will not try to infer the cardinality itself. What if the number you specified is larger than there are `WillOnce()` clauses? Well, after all `WillOnce()`s are used up, Google Mock will do the _default_ action for the function every time (unless, of course, you have a `WillRepeatedly()`.). What can we do inside `WillOnce()` besides `Return()`? You can return a reference using `ReturnRef(variable)`, or invoke a pre-defined function, among [others](V1_5_CheatSheet#Actions.md). **Important note:** The `EXPECT_CALL()` statement evaluates the action clause only once, even though the action may be performed many times. Therefore you must be careful about side effects. The following may not do what you want: ``` int n = 100; EXPECT_CALL(turtle, GetX()) .Times(4) .WillOnce(Return(n++)); ``` Instead of returning 100, 101, 102, ..., consecutively, this mock function will always return 100 as `n++` is only evaluated once. Similarly, `Return(new Foo)` will create a new `Foo` object when the `EXPECT_CALL()` is executed, and will return the same pointer every time. If you want the side effect to happen every time, you need to define a custom action, which we'll teach in the [CookBook](V1_5_CookBook.md). Time for another quiz! What do you think the following means? ``` using ::testing::Return;... EXPECT_CALL(turtle, GetY()) .Times(4) .WillOnce(Return(100)); ``` Obviously `turtle.GetY()` is expected to be called four times. But if you think it will return 100 every time, think twice! Remember that one `WillOnce()` clause will be consumed each time the function is invoked and the default action will be taken afterwards. So the right answer is that `turtle.GetY()` will return 100 the first time, but **return 0 from the second time on**, as returning 0 is the default action for `int` functions. ## Using Multiple Expectations ## So far we've only shown examples where you have a single expectation. More realistically, you're going to specify expectations on multiple mock methods, which may be from multiple mock objects. By default, when a mock method is invoked, Google Mock will search the expectations in the **reverse order** they are defined, and stop when an active expectation that matches the arguments is found (you can think of it as "newer rules override older ones."). If the matching expectation cannot take any more calls, you will get an upper-bound-violated failure. Here's an example: ``` using ::testing::_;... EXPECT_CALL(turtle, Forward(_)); // #1 EXPECT_CALL(turtle, Forward(10)) // #2 .Times(2); ``` If `Forward(10)` is called three times in a row, the third time it will be an error, as the last matching expectation (#2) has been saturated. If, however, the third `Forward(10)` call is replaced by `Forward(20)`, then it would be OK, as now #1 will be the matching expectation. **Side note:** Why does Google Mock search for a match in the _reverse_ order of the expectations? The reason is that this allows a user to set up the default expectations in a mock object's constructor or the test fixture's set-up phase and then customize the mock by writing more specific expectations in the test body. So, if you have two expectations on the same method, you want to put the one with more specific matchers **after** the other, or the more specific rule would be shadowed by the more general one that comes after it. ## Ordered vs Unordered Calls ## By default, an expectation can match a call even though an earlier expectation hasn't been satisfied. In other words, the calls don't have to occur in the order the expectations are specified. Sometimes, you may want all the expected calls to occur in a strict order. To say this in Google Mock is easy: ``` using ::testing::InSequence;... TEST(FooTest, DrawsLineSegment) { ... { InSequence dummy; EXPECT_CALL(turtle, PenDown()); EXPECT_CALL(turtle, Forward(100)); EXPECT_CALL(turtle, PenUp()); } Foo(); } ``` By creating an object of type `InSequence`, all expectations in its scope are put into a _sequence_ and have to occur _sequentially_. Since we are just relying on the constructor and destructor of this object to do the actual work, its name is really irrelevant. In this example, we test that `Foo()` calls the three expected functions in the order as written. If a call is made out-of-order, it will be an error. (What if you care about the relative order of some of the calls, but not all of them? Can you specify an arbitrary partial order? The answer is ... yes! If you are impatient, the details can be found in the [CookBook](V1_5_CookBook.md).) ## All Expectations Are Sticky (Unless Said Otherwise) ## Now let's do a quick quiz to see how well you can use this mock stuff already. How would you test that the turtle is asked to go to the origin _exactly twice_ (you want to ignore any other instructions it receives)? After you've come up with your answer, take a look at ours and compare notes (solve it yourself first - don't cheat!): ``` using ::testing::_;... EXPECT_CALL(turtle, GoTo(_, _)) // #1 .Times(AnyNumber()); EXPECT_CALL(turtle, GoTo(0, 0)) // #2 .Times(2); ``` Suppose `turtle.GoTo(0, 0)` is called three times. In the third time, Google Mock will see that the arguments match expectation #2 (remember that we always pick the last matching expectation). Now, since we said that there should be only two such calls, Google Mock will report an error immediately. This is basically what we've told you in the "Using Multiple Expectations" section above. This example shows that **expectations in Google Mock are "sticky" by default**, in the sense that they remain active even after we have reached their invocation upper bounds. This is an important rule to remember, as it affects the meaning of the spec, and is **different** to how it's done in many other mocking frameworks (Why'd we do that? Because we think our rule makes the common cases easier to express and understand.). Simple? Let's see if you've really understood it: what does the following code say? ``` using ::testing::Return; ... for (int i = n; i > 0; i--) { EXPECT_CALL(turtle, GetX()) .WillOnce(Return(10*i)); } ``` If you think it says that `turtle.GetX()` will be called `n` times and will return 10, 20, 30, ..., consecutively, think twice! The problem is that, as we said, expectations are sticky. So, the second time `turtle.GetX()` is called, the last (latest) `EXPECT_CALL()` statement will match, and will immediately lead to an "upper bound exceeded" error - this piece of code is not very useful! One correct way of saying that `turtle.GetX()` will return 10, 20, 30, ..., is to explicitly say that the expectations are _not_ sticky. In other words, they should _retire_ as soon as they are saturated: ``` using ::testing::Return; ... for (int i = n; i > 0; i--) { EXPECT_CALL(turtle, GetX()) .WillOnce(Return(10*i)) .RetiresOnSaturation(); } ``` And, there's a better way to do it: in this case, we expect the calls to occur in a specific order, and we line up the actions to match the order. Since the order is important here, we should make it explicit using a sequence: ``` using ::testing::InSequence; using ::testing::Return; ... { InSequence s; for (int i = 1; i <= n; i++) { EXPECT_CALL(turtle, GetX()) .WillOnce(Return(10*i)) .RetiresOnSaturation(); } } ``` By the way, the other situation where an expectation may _not_ be sticky is when it's in a sequence - as soon as another expectation that comes after it in the sequence has been used, it automatically retires (and will never be used to match any call). ## Uninteresting Calls ## A mock object may have many methods, and not all of them are that interesting. For example, in some tests we may not care about how many times `GetX()` and `GetY()` get called. In Google Mock, if you are not interested in a method, just don't say anything about it. If a call to this method occurs, you'll see a warning in the test output, but it won't be a failure. # What Now? # Congratulations! You've learned enough about Google Mock to start using it. Now, you might want to join the [googlemock](http://groups.google.com/group/googlemock) discussion group and actually write some tests using Google Mock - it will be fun. Hey, it may even be addictive - you've been warned. Then, if you feel like increasing your mock quotient, you should move on to the [CookBook](V1_5_CookBook.md). You can learn many advanced features of Google Mock there -- and advance your level of enjoyment and testing bliss.vendor/googletest/gtest-1.7.0/googlemock/docs/v1_5/FrequentlyAskedQuestions.md000066400000000000000000000552001300002025200274730ustar00rootroot00000000000000 Please send your questions to the [googlemock](http://groups.google.com/group/googlemock) discussion group. If you need help with compiler errors, make sure you have tried [Google Mock Doctor](#How_am_I_supposed_to_make_sense_of_these_horrible_template_error.md) first. ## I wrote some matchers. After I upgraded to a new version of Google Mock, they no longer compile. What's going on? ## After version 1.4.0 of Google Mock was released, we had an idea on how to make it easier to write matchers that can generate informative messages efficiently. We experimented with this idea and liked what we saw. Therefore we decided to implement it. Unfortunately, this means that if you have defined your own matchers by implementing `MatcherInterface` or using `MakePolymorphicMatcher()`, your definitions will no longer compile. Matchers defined using the `MATCHER*` family of macros are not affected. Sorry for the hassle if your matchers are affected. We believe it's in everyone's long-term interest to make this change sooner than later. Fortunately, it's usually not hard to migrate an existing matcher to the new API. Here's what you need to do: If you wrote your matcher like this: ``` // Old matcher definition that doesn't work with the latest // Google Mock. using ::testing::MatcherInterface; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool Matches(MyType value) const { // Returns true if value matches. return value.GetFoo() > 5; } ... }; ``` you'll need to change it to: ``` // New matcher definition that works with the latest Google Mock. using ::testing::MatcherInterface; using ::testing::MatchResultListener; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. return value.GetFoo() > 5; } ... }; ``` (i.e. rename `Matches()` to `MatchAndExplain()` and give it a second argument of type `MatchResultListener*`.) If you were also using `ExplainMatchResultTo()` to improve the matcher message: ``` // Old matcher definition that doesn't work with the lastest // Google Mock. using ::testing::MatcherInterface; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool Matches(MyType value) const { // Returns true if value matches. return value.GetFoo() > 5; } virtual void ExplainMatchResultTo(MyType value, ::std::ostream* os) const { // Prints some helpful information to os to help // a user understand why value matches (or doesn't match). *os << "the Foo property is " << value.GetFoo(); } ... }; ``` you should move the logic of `ExplainMatchResultTo()` into `MatchAndExplain()`, using the `MatchResultListener` argument where the `::std::ostream` was used: ``` // New matcher definition that works with the latest Google Mock. using ::testing::MatcherInterface; using ::testing::MatchResultListener; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. *listener << "the Foo property is " << value.GetFoo(); return value.GetFoo() > 5; } ... }; ``` If your matcher is defined using `MakePolymorphicMatcher()`: ``` // Old matcher definition that doesn't work with the latest // Google Mock. using ::testing::MakePolymorphicMatcher; ... class MyGreatMatcher { public: ... bool Matches(MyType value) const { // Returns true if value matches. return value.GetBar() < 42; } ... }; ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` you should rename the `Matches()` method to `MatchAndExplain()` and add a `MatchResultListener*` argument (the same as what you need to do for matchers defined by implementing `MatcherInterface`): ``` // New matcher definition that works with the latest Google Mock. using ::testing::MakePolymorphicMatcher; using ::testing::MatchResultListener; ... class MyGreatMatcher { public: ... bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. return value.GetBar() < 42; } ... }; ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` If your polymorphic matcher uses `ExplainMatchResultTo()` for better failure messages: ``` // Old matcher definition that doesn't work with the latest // Google Mock. using ::testing::MakePolymorphicMatcher; ... class MyGreatMatcher { public: ... bool Matches(MyType value) const { // Returns true if value matches. return value.GetBar() < 42; } ... }; void ExplainMatchResultTo(const MyGreatMatcher& matcher, MyType value, ::std::ostream* os) { // Prints some helpful information to os to help // a user understand why value matches (or doesn't match). *os << "the Bar property is " << value.GetBar(); } ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` you'll need to move the logic inside `ExplainMatchResultTo()` to `MatchAndExplain()`: ``` // New matcher definition that works with the latest Google Mock. using ::testing::MakePolymorphicMatcher; using ::testing::MatchResultListener; ... class MyGreatMatcher { public: ... bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. *listener << "the Bar property is " << value.GetBar(); return value.GetBar() < 42; } ... }; ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` For more information, you can read these [two](V1_5_CookBook#Writing_New_Monomorphic_Matchers.md) [recipes](V1_5_CookBook#Writing_New_Polymorphic_Matchers.md) from the cookbook. As always, you are welcome to post questions on `googlemock@googlegroups.com` if you need any help. ## When using Google Mock, do I have to use Google Test as the testing framework? I have my favorite testing framework and don't want to switch. ## Google Mock works out of the box with Google Test. However, it's easy to configure it to work with any testing framework of your choice. [Here](V1_5_ForDummies#Using_Google_Mock_with_Any_Testing_Framework.md) is how. ## How am I supposed to make sense of these horrible template errors? ## If you are confused by the compiler errors gcc threw at you, try consulting the _Google Mock Doctor_ tool first. What it does is to scan stdin for gcc error messages, and spit out diagnoses on the problems (we call them diseases) your code has. To "install", run command: ``` alias gmd='/scripts/gmock_doctor.py' ``` To use it, do: ``` 2>&1 | gmd ``` For example: ``` make my_test 2>&1 | gmd ``` Or you can run `gmd` and copy-n-paste gcc's error messages to it. ## Can I mock a variadic function? ## You cannot mock a variadic function (i.e. a function taking ellipsis (`...`) arguments) directly in Google Mock. The problem is that in general, there is _no way_ for a mock object to know how many arguments are passed to the variadic method, and what the arguments' types are. Only the _author of the base class_ knows the protocol, and we cannot look into his head. Therefore, to mock such a function, the _user_ must teach the mock object how to figure out the number of arguments and their types. One way to do it is to provide overloaded versions of the function. Ellipsis arguments are inherited from C and not really a C++ feature. They are unsafe to use and don't work with arguments that have constructors or destructors. Therefore we recommend to avoid them in C++ as much as possible. ## MSVC gives me warning C4301 or C4373 when I define a mock method with a const parameter. Why? ## If you compile this using Microsoft Visual C++ 2005 SP1: ``` class Foo { ... virtual void Bar(const int i) = 0; }; class MockFoo : public Foo { ... MOCK_METHOD1(Bar, void(const int i)); }; ``` You may get the following warning: ``` warning C4301: 'MockFoo::Bar': overriding virtual function only differs from 'Foo::Bar' by const/volatile qualifier ``` This is a MSVC bug. The same code compiles fine with gcc ,for example. If you use Visual C++ 2008 SP1, you would get the warning: ``` warning C4373: 'MockFoo::Bar': virtual function overrides 'Foo::Bar', previous versions of the compiler did not override when parameters only differed by const/volatile qualifiers ``` In C++, if you _declare_ a function with a `const` parameter, the `const` modifier is _ignored_. Therefore, the `Foo` base class above is equivalent to: ``` class Foo { ... virtual void Bar(int i) = 0; // int or const int? Makes no difference. }; ``` In fact, you can _declare_ Bar() with an `int` parameter, and _define_ it with a `const int` parameter. The compiler will still match them up. Since making a parameter `const` is meaningless in the method _declaration_, we recommend to remove it in both `Foo` and `MockFoo`. That should workaround the VC bug. Note that we are talking about the _top-level_ `const` modifier here. If the function parameter is passed by pointer or reference, declaring the _pointee_ or _referee_ as `const` is still meaningful. For example, the following two declarations are _not_ equivalent: ``` void Bar(int* p); // Neither p nor *p is const. void Bar(const int* p); // p is not const, but *p is. ``` ## I have a huge mock class, and Microsoft Visual C++ runs out of memory when compiling it. What can I do? ## We've noticed that when the `/clr` compiler flag is used, Visual C++ uses 5~6 times as much memory when compiling a mock class. We suggest to avoid `/clr` when compiling native C++ mocks. ## I can't figure out why Google Mock thinks my expectations are not satisfied. What should I do? ## You might want to run your test with `--gmock_verbose=info`. This flag lets Google Mock print a trace of every mock function call it receives. By studying the trace, you'll gain insights on why the expectations you set are not met. ## How can I assert that a function is NEVER called? ## ``` EXPECT_CALL(foo, Bar(_)) .Times(0); ``` ## I have a failed test where Google Mock tells me TWICE that a particular expectation is not satisfied. Isn't this redundant? ## When Google Mock detects a failure, it prints relevant information (the mock function arguments, the state of relevant expectations, and etc) to help the user debug. If another failure is detected, Google Mock will do the same, including printing the state of relevant expectations. Sometimes an expectation's state didn't change between two failures, and you'll see the same description of the state twice. They are however _not_ redundant, as they refer to _different points in time_. The fact they are the same _is_ interesting information. ## I get a heap check failure when using a mock object, but using a real object is fine. What can be wrong? ## Does the class (hopefully a pure interface) you are mocking have a virtual destructor? Whenever you derive from a base class, make sure its destructor is virtual. Otherwise Bad Things will happen. Consider the following code: ``` class Base { public: // Not virtual, but should be. ~Base() { ... } ... }; class Derived : public Base { public: ... private: std::string value_; }; ... Base* p = new Derived; ... delete p; // Surprise! ~Base() will be called, but ~Derived() will not // - value_ is leaked. ``` By changing `~Base()` to virtual, `~Derived()` will be correctly called when `delete p` is executed, and the heap checker will be happy. ## The "newer expectations override older ones" rule makes writing expectations awkward. Why does Google Mock do that? ## When people complain about this, often they are referring to code like: ``` // foo.Bar() should be called twice, return 1 the first time, and return // 2 the second time. However, I have to write the expectations in the // reverse order. This sucks big time!!! EXPECT_CALL(foo, Bar()) .WillOnce(Return(2)) .RetiresOnSaturation(); EXPECT_CALL(foo, Bar()) .WillOnce(Return(1)) .RetiresOnSaturation(); ``` The problem is that they didn't pick the **best** way to express the test's intent. By default, expectations don't have to be matched in _any_ particular order. If you want them to match in a certain order, you need to be explicit. This is Google Mock's (and jMock's) fundamental philosophy: it's easy to accidentally over-specify your tests, and we want to make it harder to do so. There are two better ways to write the test spec. You could either put the expectations in sequence: ``` // foo.Bar() should be called twice, return 1 the first time, and return // 2 the second time. Using a sequence, we can write the expectations // in their natural order. { InSequence s; EXPECT_CALL(foo, Bar()) .WillOnce(Return(1)) .RetiresOnSaturation(); EXPECT_CALL(foo, Bar()) .WillOnce(Return(2)) .RetiresOnSaturation(); } ``` or you can put the sequence of actions in the same expectation: ``` // foo.Bar() should be called twice, return 1 the first time, and return // 2 the second time. EXPECT_CALL(foo, Bar()) .WillOnce(Return(1)) .WillOnce(Return(2)) .RetiresOnSaturation(); ``` Back to the original questions: why does Google Mock search the expectations (and `ON_CALL`s) from back to front? Because this allows a user to set up a mock's behavior for the common case early (e.g. in the mock's constructor or the test fixture's set-up phase) and customize it with more specific rules later. If Google Mock searches from front to back, this very useful pattern won't be possible. ## Google Mock prints a warning when a function without EXPECT\_CALL is called, even if I have set its behavior using ON\_CALL. Would it be reasonable not to show the warning in this case? ## When choosing between being neat and being safe, we lean toward the latter. So the answer is that we think it's better to show the warning. Often people write `ON_CALL`s in the mock object's constructor or `SetUp()`, as the default behavior rarely changes from test to test. Then in the test body they set the expectations, which are often different for each test. Having an `ON_CALL` in the set-up part of a test doesn't mean that the calls are expected. If there's no `EXPECT_CALL` and the method is called, it's possibly an error. If we quietly let the call go through without notifying the user, bugs may creep in unnoticed. If, however, you are sure that the calls are OK, you can write ``` EXPECT_CALL(foo, Bar(_)) .WillRepeatedly(...); ``` instead of ``` ON_CALL(foo, Bar(_)) .WillByDefault(...); ``` This tells Google Mock that you do expect the calls and no warning should be printed. Also, you can control the verbosity using the `--gmock_verbose` flag. If you find the output too noisy when debugging, just choose a less verbose level. ## How can I delete the mock function's argument in an action? ## If you find yourself needing to perform some action that's not supported by Google Mock directly, remember that you can define your own actions using [MakeAction()](V1_5_CookBook#Writing_New_Actions.md) or [MakePolymorphicAction()](V1_5_CookBook#Writing_New_Polymorphic_Actions.md), or you can write a stub function and invoke it using [Invoke()](V1_5_CookBook#Using_Functions_Methods_Functors.md). ## MOCK\_METHODn()'s second argument looks funny. Why don't you use the MOCK\_METHODn(Method, return\_type, arg\_1, ..., arg\_n) syntax? ## What?! I think it's beautiful. :-) While which syntax looks more natural is a subjective matter to some extent, Google Mock's syntax was chosen for several practical advantages it has. Try to mock a function that takes a map as an argument: ``` virtual int GetSize(const map& m); ``` Using the proposed syntax, it would be: ``` MOCK_METHOD1(GetSize, int, const map& m); ``` Guess what? You'll get a compiler error as the compiler thinks that `const map& m` are **two**, not one, arguments. To work around this you can use `typedef` to give the map type a name, but that gets in the way of your work. Google Mock's syntax avoids this problem as the function's argument types are protected inside a pair of parentheses: ``` // This compiles fine. MOCK_METHOD1(GetSize, int(const map& m)); ``` You still need a `typedef` if the return type contains an unprotected comma, but that's much rarer. Other advantages include: 1. `MOCK_METHOD1(Foo, int, bool)` can leave a reader wonder whether the method returns `int` or `bool`, while there won't be such confusion using Google Mock's syntax. 1. The way Google Mock describes a function type is nothing new, although many people may not be familiar with it. The same syntax was used in C, and the `function` library in `tr1` uses this syntax extensively. Since `tr1` will become a part of the new version of STL, we feel very comfortable to be consistent with it. 1. The function type syntax is also used in other parts of Google Mock's API (e.g. the action interface) in order to make the implementation tractable. A user needs to learn it anyway in order to utilize Google Mock's more advanced features. We'd as well stick to the same syntax in `MOCK_METHOD*`! ## My code calls a static/global function. Can I mock it? ## You can, but you need to make some changes. In general, if you find yourself needing to mock a static function, it's a sign that your modules are too tightly coupled (and less flexible, less reusable, less testable, etc). You are probably better off defining a small interface and call the function through that interface, which then can be easily mocked. It's a bit of work initially, but usually pays for itself quickly. This Google Testing Blog [post](http://googletesting.blogspot.com/2008/06/defeat-static-cling.html) says it excellently. Check it out. ## My mock object needs to do complex stuff. It's a lot of pain to specify the actions. Google Mock sucks! ## I know it's not a question, but you get an answer for free any way. :-) With Google Mock, you can create mocks in C++ easily. And people might be tempted to use them everywhere. Sometimes they work great, and sometimes you may find them, well, a pain to use. So, what's wrong in the latter case? When you write a test without using mocks, you exercise the code and assert that it returns the correct value or that the system is in an expected state. This is sometimes called "state-based testing". Mocks are great for what some call "interaction-based" testing: instead of checking the system state at the very end, mock objects verify that they are invoked the right way and report an error as soon as it arises, giving you a handle on the precise context in which the error was triggered. This is often more effective and economical to do than state-based testing. If you are doing state-based testing and using a test double just to simulate the real object, you are probably better off using a fake. Using a mock in this case causes pain, as it's not a strong point for mocks to perform complex actions. If you experience this and think that mocks suck, you are just not using the right tool for your problem. Or, you might be trying to solve the wrong problem. :-) ## I got a warning "Uninteresting function call encountered - default action taken.." Should I panic? ## By all means, NO! It's just an FYI. What it means is that you have a mock function, you haven't set any expectations on it (by Google Mock's rule this means that you are not interested in calls to this function and therefore it can be called any number of times), and it is called. That's OK - you didn't say it's not OK to call the function! What if you actually meant to disallow this function to be called, but forgot to write `EXPECT_CALL(foo, Bar()).Times(0)`? While one can argue that it's the user's fault, Google Mock tries to be nice and prints you a note. So, when you see the message and believe that there shouldn't be any uninteresting calls, you should investigate what's going on. To make your life easier, Google Mock prints the function name and arguments when an uninteresting call is encountered. ## I want to define a custom action. Should I use Invoke() or implement the action interface? ## Either way is fine - you want to choose the one that's more convenient for your circumstance. Usually, if your action is for a particular function type, defining it using `Invoke()` should be easier; if your action can be used in functions of different types (e.g. if you are defining `Return(value)`), `MakePolymorphicAction()` is easiest. Sometimes you want precise control on what types of functions the action can be used in, and implementing `ActionInterface` is the way to go here. See the implementation of `Return()` in `include/gmock/gmock-actions.h` for an example. ## I'm using the set-argument-pointee action, and the compiler complains about "conflicting return type specified". What does it mean? ## You got this error as Google Mock has no idea what value it should return when the mock method is called. `SetArgumentPointee()` says what the side effect is, but doesn't say what the return value should be. You need `DoAll()` to chain a `SetArgumentPointee()` with a `Return()`. See this [recipe](V1_5_CookBook#Mocking_Side_Effects.md) for more details and an example. ## My question is not in your FAQ! ## If you cannot find the answer to your question in this FAQ, there are some other resources you can use: 1. read other [wiki pages](http://code.google.com/p/googlemock/w/list), 1. search the mailing list [archive](http://groups.google.com/group/googlemock/topics), 1. ask it on [googlemock@googlegroups.com](mailto:googlemock@googlegroups.com) and someone will answer it (to prevent spam, we require you to join the [discussion group](http://groups.google.com/group/googlemock) before you can post.). Please note that creating an issue in the [issue tracker](http://code.google.com/p/googlemock/issues/list) is _not_ a good way to get your answer, as it is monitored infrequently by a very small number of people. When asking a question, it's helpful to provide as much of the following information as possible (people cannot help you if there's not enough information in your question): * the version (or the revision number if you check out from SVN directly) of Google Mock you use (Google Mock is under active development, so it's possible that your problem has been solved in a later version), * your operating system, * the name and version of your compiler, * the complete command line flags you give to your compiler, * the complete compiler error messages (if the question is about compilation), * the _actual_ code (ideally, a minimal but complete program) that has the problem you encounter.vendor/googletest/gtest-1.7.0/googlemock/docs/v1_6/000077500000000000000000000000001300002025200221275ustar00rootroot00000000000000vendor/googletest/gtest-1.7.0/googlemock/docs/v1_6/CheatSheet.md000066400000000000000000000611771300002025200245020ustar00rootroot00000000000000 # Defining a Mock Class # ## Mocking a Normal Class ## Given ``` class Foo { ... virtual ~Foo(); virtual int GetSize() const = 0; virtual string Describe(const char* name) = 0; virtual string Describe(int type) = 0; virtual bool Process(Bar elem, int count) = 0; }; ``` (note that `~Foo()` **must** be virtual) we can define its mock as ``` #include "gmock/gmock.h" class MockFoo : public Foo { MOCK_CONST_METHOD0(GetSize, int()); MOCK_METHOD1(Describe, string(const char* name)); MOCK_METHOD1(Describe, string(int type)); MOCK_METHOD2(Process, bool(Bar elem, int count)); }; ``` To create a "nice" mock object which ignores all uninteresting calls, or a "strict" mock object, which treats them as failures: ``` NiceMock nice_foo; // The type is a subclass of MockFoo. StrictMock strict_foo; // The type is a subclass of MockFoo. ``` ## Mocking a Class Template ## To mock ``` template class StackInterface { public: ... virtual ~StackInterface(); virtual int GetSize() const = 0; virtual void Push(const Elem& x) = 0; }; ``` (note that `~StackInterface()` **must** be virtual) just append `_T` to the `MOCK_*` macros: ``` template class MockStack : public StackInterface { public: ... MOCK_CONST_METHOD0_T(GetSize, int()); MOCK_METHOD1_T(Push, void(const Elem& x)); }; ``` ## Specifying Calling Conventions for Mock Functions ## If your mock function doesn't use the default calling convention, you can specify it by appending `_WITH_CALLTYPE` to any of the macros described in the previous two sections and supplying the calling convention as the first argument to the macro. For example, ``` MOCK_METHOD_1_WITH_CALLTYPE(STDMETHODCALLTYPE, Foo, bool(int n)); MOCK_CONST_METHOD2_WITH_CALLTYPE(STDMETHODCALLTYPE, Bar, int(double x, double y)); ``` where `STDMETHODCALLTYPE` is defined by `` on Windows. # Using Mocks in Tests # The typical flow is: 1. Import the Google Mock names you need to use. All Google Mock names are in the `testing` namespace unless they are macros or otherwise noted. 1. Create the mock objects. 1. Optionally, set the default actions of the mock objects. 1. Set your expectations on the mock objects (How will they be called? What wil they do?). 1. Exercise code that uses the mock objects; if necessary, check the result using [Google Test](http://code.google.com/p/googletest/) assertions. 1. When a mock objects is destructed, Google Mock automatically verifies that all expectations on it have been satisfied. Here is an example: ``` using ::testing::Return; // #1 TEST(BarTest, DoesThis) { MockFoo foo; // #2 ON_CALL(foo, GetSize()) // #3 .WillByDefault(Return(1)); // ... other default actions ... EXPECT_CALL(foo, Describe(5)) // #4 .Times(3) .WillRepeatedly(Return("Category 5")); // ... other expectations ... EXPECT_EQ("good", MyProductionFunction(&foo)); // #5 } // #6 ``` # Setting Default Actions # Google Mock has a **built-in default action** for any function that returns `void`, `bool`, a numeric value, or a pointer. To customize the default action for functions with return type `T` globally: ``` using ::testing::DefaultValue; DefaultValue::Set(value); // Sets the default value to be returned. // ... use the mocks ... DefaultValue::Clear(); // Resets the default value. ``` To customize the default action for a particular method, use `ON_CALL()`: ``` ON_CALL(mock_object, method(matchers)) .With(multi_argument_matcher) ? .WillByDefault(action); ``` # Setting Expectations # `EXPECT_CALL()` sets **expectations** on a mock method (How will it be called? What will it do?): ``` EXPECT_CALL(mock_object, method(matchers)) .With(multi_argument_matcher) ? .Times(cardinality) ? .InSequence(sequences) * .After(expectations) * .WillOnce(action) * .WillRepeatedly(action) ? .RetiresOnSaturation(); ? ``` If `Times()` is omitted, the cardinality is assumed to be: * `Times(1)` when there is neither `WillOnce()` nor `WillRepeatedly()`; * `Times(n)` when there are `n WillOnce()`s but no `WillRepeatedly()`, where `n` >= 1; or * `Times(AtLeast(n))` when there are `n WillOnce()`s and a `WillRepeatedly()`, where `n` >= 0. A method with no `EXPECT_CALL()` is free to be invoked _any number of times_, and the default action will be taken each time. # Matchers # A **matcher** matches a _single_ argument. You can use it inside `ON_CALL()` or `EXPECT_CALL()`, or use it to validate a value directly: | `EXPECT_THAT(value, matcher)` | Asserts that `value` matches `matcher`. | |:------------------------------|:----------------------------------------| | `ASSERT_THAT(value, matcher)` | The same as `EXPECT_THAT(value, matcher)`, except that it generates a **fatal** failure. | Built-in matchers (where `argument` is the function argument) are divided into several categories: ## Wildcard ## |`_`|`argument` can be any value of the correct type.| |:--|:-----------------------------------------------| |`A()` or `An()`|`argument` can be any value of type `type`. | ## Generic Comparison ## |`Eq(value)` or `value`|`argument == value`| |:---------------------|:------------------| |`Ge(value)` |`argument >= value`| |`Gt(value)` |`argument > value` | |`Le(value)` |`argument <= value`| |`Lt(value)` |`argument < value` | |`Ne(value)` |`argument != value`| |`IsNull()` |`argument` is a `NULL` pointer (raw or smart).| |`NotNull()` |`argument` is a non-null pointer (raw or smart).| |`Ref(variable)` |`argument` is a reference to `variable`.| |`TypedEq(value)`|`argument` has type `type` and is equal to `value`. You may need to use this instead of `Eq(value)` when the mock function is overloaded.| Except `Ref()`, these matchers make a _copy_ of `value` in case it's modified or destructed later. If the compiler complains that `value` doesn't have a public copy constructor, try wrap it in `ByRef()`, e.g. `Eq(ByRef(non_copyable_value))`. If you do that, make sure `non_copyable_value` is not changed afterwards, or the meaning of your matcher will be changed. ## Floating-Point Matchers ## |`DoubleEq(a_double)`|`argument` is a `double` value approximately equal to `a_double`, treating two NaNs as unequal.| |:-------------------|:----------------------------------------------------------------------------------------------| |`FloatEq(a_float)` |`argument` is a `float` value approximately equal to `a_float`, treating two NaNs as unequal. | |`NanSensitiveDoubleEq(a_double)`|`argument` is a `double` value approximately equal to `a_double`, treating two NaNs as equal. | |`NanSensitiveFloatEq(a_float)`|`argument` is a `float` value approximately equal to `a_float`, treating two NaNs as equal. | These matchers use ULP-based comparison (the same as used in [Google Test](http://code.google.com/p/googletest/)). They automatically pick a reasonable error bound based on the absolute value of the expected value. `DoubleEq()` and `FloatEq()` conform to the IEEE standard, which requires comparing two NaNs for equality to return false. The `NanSensitive*` version instead treats two NaNs as equal, which is often what a user wants. ## String Matchers ## The `argument` can be either a C string or a C++ string object: |`ContainsRegex(string)`|`argument` matches the given regular expression.| |:----------------------|:-----------------------------------------------| |`EndsWith(suffix)` |`argument` ends with string `suffix`. | |`HasSubstr(string)` |`argument` contains `string` as a sub-string. | |`MatchesRegex(string)` |`argument` matches the given regular expression with the match starting at the first character and ending at the last character.| |`StartsWith(prefix)` |`argument` starts with string `prefix`. | |`StrCaseEq(string)` |`argument` is equal to `string`, ignoring case. | |`StrCaseNe(string)` |`argument` is not equal to `string`, ignoring case.| |`StrEq(string)` |`argument` is equal to `string`. | |`StrNe(string)` |`argument` is not equal to `string`. | `ContainsRegex()` and `MatchesRegex()` use the regular expression syntax defined [here](http://code.google.com/p/googletest/wiki/V1_6_AdvancedGuide#Regular_Expression_Syntax). `StrCaseEq()`, `StrCaseNe()`, `StrEq()`, and `StrNe()` work for wide strings as well. ## Container Matchers ## Most STL-style containers support `==`, so you can use `Eq(expected_container)` or simply `expected_container` to match a container exactly. If you want to write the elements in-line, match them more flexibly, or get more informative messages, you can use: | `Contains(e)` | `argument` contains an element that matches `e`, which can be either a value or a matcher. | |:--------------|:-------------------------------------------------------------------------------------------| | `Each(e)` | `argument` is a container where _every_ element matches `e`, which can be either a value or a matcher. | | `ElementsAre(e0, e1, ..., en)` | `argument` has `n + 1` elements, where the i-th element matches `ei`, which can be a value or a matcher. 0 to 10 arguments are allowed. | | `ElementsAreArray(array)` or `ElementsAreArray(array, count)` | The same as `ElementsAre()` except that the expected element values/matchers come from a C-style array. | | `ContainerEq(container)` | The same as `Eq(container)` except that the failure message also includes which elements are in one container but not the other. | | `Pointwise(m, container)` | `argument` contains the same number of elements as in `container`, and for all i, (the i-th element in `argument`, the i-th element in `container`) match `m`, which is a matcher on 2-tuples. E.g. `Pointwise(Le(), upper_bounds)` verifies that each element in `argument` doesn't exceed the corresponding element in `upper_bounds`. | These matchers can also match: 1. a native array passed by reference (e.g. in `Foo(const int (&a)[5])`), and 1. an array passed as a pointer and a count (e.g. in `Bar(const T* buffer, int len)` -- see [Multi-argument Matchers](#Multiargument_Matchers.md)). where the array may be multi-dimensional (i.e. its elements can be arrays). ## Member Matchers ## |`Field(&class::field, m)`|`argument.field` (or `argument->field` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _class_.| |:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------| |`Key(e)` |`argument.first` matches `e`, which can be either a value or a matcher. E.g. `Contains(Key(Le(5)))` can verify that a `map` contains a key `<= 5`.| |`Pair(m1, m2)` |`argument` is an `std::pair` whose `first` field matches `m1` and `second` field matches `m2`. | |`Property(&class::property, m)`|`argument.property()` (or `argument->property()` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _class_.| ## Matching the Result of a Function or Functor ## |`ResultOf(f, m)`|`f(argument)` matches matcher `m`, where `f` is a function or functor.| |:---------------|:---------------------------------------------------------------------| ## Pointer Matchers ## |`Pointee(m)`|`argument` (either a smart pointer or a raw pointer) points to a value that matches matcher `m`.| |:-----------|:-----------------------------------------------------------------------------------------------| ## Multiargument Matchers ## Technically, all matchers match a _single_ value. A "multi-argument" matcher is just one that matches a _tuple_. The following matchers can be used to match a tuple `(x, y)`: |`Eq()`|`x == y`| |:-----|:-------| |`Ge()`|`x >= y`| |`Gt()`|`x > y` | |`Le()`|`x <= y`| |`Lt()`|`x < y` | |`Ne()`|`x != y`| You can use the following selectors to pick a subset of the arguments (or reorder them) to participate in the matching: |`AllArgs(m)`|Equivalent to `m`. Useful as syntactic sugar in `.With(AllArgs(m))`.| |:-----------|:-------------------------------------------------------------------| |`Args(m)`|The tuple of the `k` selected (using 0-based indices) arguments matches `m`, e.g. `Args<1, 2>(Eq())`.| ## Composite Matchers ## You can make a matcher from one or more other matchers: |`AllOf(m1, m2, ..., mn)`|`argument` matches all of the matchers `m1` to `mn`.| |:-----------------------|:---------------------------------------------------| |`AnyOf(m1, m2, ..., mn)`|`argument` matches at least one of the matchers `m1` to `mn`.| |`Not(m)` |`argument` doesn't match matcher `m`. | ## Adapters for Matchers ## |`MatcherCast(m)`|casts matcher `m` to type `Matcher`.| |:------------------|:--------------------------------------| |`SafeMatcherCast(m)`| [safely casts](http://code.google.com/p/googlemock/wiki/V1_6_CookBook#Casting_Matchers) matcher `m` to type `Matcher`. | |`Truly(predicate)` |`predicate(argument)` returns something considered by C++ to be true, where `predicate` is a function or functor.| ## Matchers as Predicates ## |`Matches(m)(value)`|evaluates to `true` if `value` matches `m`. You can use `Matches(m)` alone as a unary functor.| |:------------------|:---------------------------------------------------------------------------------------------| |`ExplainMatchResult(m, value, result_listener)`|evaluates to `true` if `value` matches `m`, explaining the result to `result_listener`. | |`Value(value, m)` |evaluates to `true` if `value` matches `m`. | ## Defining Matchers ## | `MATCHER(IsEven, "") { return (arg % 2) == 0; }` | Defines a matcher `IsEven()` to match an even number. | |:-------------------------------------------------|:------------------------------------------------------| | `MATCHER_P(IsDivisibleBy, n, "") { *result_listener << "where the remainder is " << (arg % n); return (arg % n) == 0; }` | Defines a macher `IsDivisibleBy(n)` to match a number divisible by `n`. | | `MATCHER_P2(IsBetween, a, b, std::string(negation ? "isn't" : "is") + " between " + PrintToString(a) + " and " + PrintToString(b)) { return a <= arg && arg <= b; }` | Defines a matcher `IsBetween(a, b)` to match a value in the range [`a`, `b`]. | **Notes:** 1. The `MATCHER*` macros cannot be used inside a function or class. 1. The matcher body must be _purely functional_ (i.e. it cannot have any side effect, and the result must not depend on anything other than the value being matched and the matcher parameters). 1. You can use `PrintToString(x)` to convert a value `x` of any type to a string. ## Matchers as Test Assertions ## |`ASSERT_THAT(expression, m)`|Generates a [fatal failure](http://code.google.com/p/googletest/wiki/V1_6_Primer#Assertions) if the value of `expression` doesn't match matcher `m`.| |:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------| |`EXPECT_THAT(expression, m)`|Generates a non-fatal failure if the value of `expression` doesn't match matcher `m`. | # Actions # **Actions** specify what a mock function should do when invoked. ## Returning a Value ## |`Return()`|Return from a `void` mock function.| |:---------|:----------------------------------| |`Return(value)`|Return `value`. If the type of `value` is different to the mock function's return type, `value` is converted to the latter type at the time the expectation is set, not when the action is executed.| |`ReturnArg()`|Return the `N`-th (0-based) argument.| |`ReturnNew(a1, ..., ak)`|Return `new T(a1, ..., ak)`; a different object is created each time.| |`ReturnNull()`|Return a null pointer. | |`ReturnPointee(ptr)`|Return the value pointed to by `ptr`.| |`ReturnRef(variable)`|Return a reference to `variable`. | |`ReturnRefOfCopy(value)`|Return a reference to a copy of `value`; the copy lives as long as the action.| ## Side Effects ## |`Assign(&variable, value)`|Assign `value` to variable.| |:-------------------------|:--------------------------| | `DeleteArg()` | Delete the `N`-th (0-based) argument, which must be a pointer. | | `SaveArg(pointer)` | Save the `N`-th (0-based) argument to `*pointer`. | | `SaveArgPointee(pointer)` | Save the value pointed to by the `N`-th (0-based) argument to `*pointer`. | | `SetArgReferee(value)` | Assign value to the variable referenced by the `N`-th (0-based) argument. | |`SetArgPointee(value)` |Assign `value` to the variable pointed by the `N`-th (0-based) argument.| |`SetArgumentPointee(value)`|Same as `SetArgPointee(value)`. Deprecated. Will be removed in v1.7.0.| |`SetArrayArgument(first, last)`|Copies the elements in source range [`first`, `last`) to the array pointed to by the `N`-th (0-based) argument, which can be either a pointer or an iterator. The action does not take ownership of the elements in the source range.| |`SetErrnoAndReturn(error, value)`|Set `errno` to `error` and return `value`.| |`Throw(exception)` |Throws the given exception, which can be any copyable value. Available since v1.1.0.| ## Using a Function or a Functor as an Action ## |`Invoke(f)`|Invoke `f` with the arguments passed to the mock function, where `f` can be a global/static function or a functor.| |:----------|:-----------------------------------------------------------------------------------------------------------------| |`Invoke(object_pointer, &class::method)`|Invoke the {method on the object with the arguments passed to the mock function. | |`InvokeWithoutArgs(f)`|Invoke `f`, which can be a global/static function or a functor. `f` must take no arguments. | |`InvokeWithoutArgs(object_pointer, &class::method)`|Invoke the method on the object, which takes no arguments. | |`InvokeArgument(arg1, arg2, ..., argk)`|Invoke the mock function's `N`-th (0-based) argument, which must be a function or a functor, with the `k` arguments.| The return value of the invoked function is used as the return value of the action. When defining a function or functor to be used with `Invoke*()`, you can declare any unused parameters as `Unused`: ``` double Distance(Unused, double x, double y) { return sqrt(x*x + y*y); } ... EXPECT_CALL(mock, Foo("Hi", _, _)).WillOnce(Invoke(Distance)); ``` In `InvokeArgument(...)`, if an argument needs to be passed by reference, wrap it inside `ByRef()`. For example, ``` InvokeArgument<2>(5, string("Hi"), ByRef(foo)) ``` calls the mock function's #2 argument, passing to it `5` and `string("Hi")` by value, and `foo` by reference. ## Default Action ## |`DoDefault()`|Do the default action (specified by `ON_CALL()` or the built-in one).| |:------------|:--------------------------------------------------------------------| **Note:** due to technical reasons, `DoDefault()` cannot be used inside a composite action - trying to do so will result in a run-time error. ## Composite Actions ## |`DoAll(a1, a2, ..., an)`|Do all actions `a1` to `an` and return the result of `an` in each invocation. The first `n - 1` sub-actions must return void. | |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------| |`IgnoreResult(a)` |Perform action `a` and ignore its result. `a` must not return void. | |`WithArg(a)` |Pass the `N`-th (0-based) argument of the mock function to action `a` and perform it. | |`WithArgs(a)`|Pass the selected (0-based) arguments of the mock function to action `a` and perform it. | |`WithoutArgs(a)` |Perform action `a` without any arguments. | ## Defining Actions ## | `ACTION(Sum) { return arg0 + arg1; }` | Defines an action `Sum()` to return the sum of the mock function's argument #0 and #1. | |:--------------------------------------|:---------------------------------------------------------------------------------------| | `ACTION_P(Plus, n) { return arg0 + n; }` | Defines an action `Plus(n)` to return the sum of the mock function's argument #0 and `n`. | | `ACTION_Pk(Foo, p1, ..., pk) { statements; }` | Defines a parameterized action `Foo(p1, ..., pk)` to execute the given `statements`. | The `ACTION*` macros cannot be used inside a function or class. # Cardinalities # These are used in `Times()` to specify how many times a mock function will be called: |`AnyNumber()`|The function can be called any number of times.| |:------------|:----------------------------------------------| |`AtLeast(n)` |The call is expected at least `n` times. | |`AtMost(n)` |The call is expected at most `n` times. | |`Between(m, n)`|The call is expected between `m` and `n` (inclusive) times.| |`Exactly(n) or n`|The call is expected exactly `n` times. In particular, the call should never happen when `n` is 0.| # Expectation Order # By default, the expectations can be matched in _any_ order. If some or all expectations must be matched in a given order, there are two ways to specify it. They can be used either independently or together. ## The After Clause ## ``` using ::testing::Expectation; ... Expectation init_x = EXPECT_CALL(foo, InitX()); Expectation init_y = EXPECT_CALL(foo, InitY()); EXPECT_CALL(foo, Bar()) .After(init_x, init_y); ``` says that `Bar()` can be called only after both `InitX()` and `InitY()` have been called. If you don't know how many pre-requisites an expectation has when you write it, you can use an `ExpectationSet` to collect them: ``` using ::testing::ExpectationSet; ... ExpectationSet all_inits; for (int i = 0; i < element_count; i++) { all_inits += EXPECT_CALL(foo, InitElement(i)); } EXPECT_CALL(foo, Bar()) .After(all_inits); ``` says that `Bar()` can be called only after all elements have been initialized (but we don't care about which elements get initialized before the others). Modifying an `ExpectationSet` after using it in an `.After()` doesn't affect the meaning of the `.After()`. ## Sequences ## When you have a long chain of sequential expectations, it's easier to specify the order using **sequences**, which don't require you to given each expectation in the chain a different name. All expected
calls in the same sequence must occur in the order they are specified. ``` using ::testing::Sequence; Sequence s1, s2; ... EXPECT_CALL(foo, Reset()) .InSequence(s1, s2) .WillOnce(Return(true)); EXPECT_CALL(foo, GetSize()) .InSequence(s1) .WillOnce(Return(1)); EXPECT_CALL(foo, Describe(A())) .InSequence(s2) .WillOnce(Return("dummy")); ``` says that `Reset()` must be called before _both_ `GetSize()` _and_ `Describe()`, and the latter two can occur in any order. To put many expectations in a sequence conveniently: ``` using ::testing::InSequence; { InSequence dummy; EXPECT_CALL(...)...; EXPECT_CALL(...)...; ... EXPECT_CALL(...)...; } ``` says that all expected calls in the scope of `dummy` must occur in strict order. The name `dummy` is irrelevant.) # Verifying and Resetting a Mock # Google Mock will verify the expectations on a mock object when it is destructed, or you can do it earlier: ``` using ::testing::Mock; ... // Verifies and removes the expectations on mock_obj; // returns true iff successful. Mock::VerifyAndClearExpectations(&mock_obj); ... // Verifies and removes the expectations on mock_obj; // also removes the default actions set by ON_CALL(); // returns true iff successful. Mock::VerifyAndClear(&mock_obj); ``` You can also tell Google Mock that a mock object can be leaked and doesn't need to be verified: ``` Mock::AllowLeak(&mock_obj); ``` # Mock Classes # Google Mock defines a convenient mock class template ``` class MockFunction { public: MOCK_METHODn(Call, R(A1, ..., An)); }; ``` See this [recipe](http://code.google.com/p/googlemock/wiki/V1_6_CookBook#Using_Check_Points) for one application of it. # Flags # | `--gmock_catch_leaked_mocks=0` | Don't report leaked mock objects as failures. | |:-------------------------------|:----------------------------------------------| | `--gmock_verbose=LEVEL` | Sets the default verbosity level (`info`, `warning`, or `error`) of Google Mock messages. |vendor/googletest/gtest-1.7.0/googlemock/docs/v1_6/CookBook.md000066400000000000000000003327641300002025200241760ustar00rootroot00000000000000 You can find recipes for using Google Mock here. If you haven't yet, please read the [ForDummies](V1_6_ForDummies.md) document first to make sure you understand the basics. **Note:** Google Mock lives in the `testing` name space. For readability, it is recommended to write `using ::testing::Foo;` once in your file before using the name `Foo` defined by Google Mock. We omit such `using` statements in this page for brevity, but you should do it in your own code. # Creating Mock Classes # ## Mocking Private or Protected Methods ## You must always put a mock method definition (`MOCK_METHOD*`) in a `public:` section of the mock class, regardless of the method being mocked being `public`, `protected`, or `private` in the base class. This allows `ON_CALL` and `EXPECT_CALL` to reference the mock function from outside of the mock class. (Yes, C++ allows a subclass to change the access level of a virtual function in the base class.) Example: ``` class Foo { public: ... virtual bool Transform(Gadget* g) = 0; protected: virtual void Resume(); private: virtual int GetTimeOut(); }; class MockFoo : public Foo { public: ... MOCK_METHOD1(Transform, bool(Gadget* g)); // The following must be in the public section, even though the // methods are protected or private in the base class. MOCK_METHOD0(Resume, void()); MOCK_METHOD0(GetTimeOut, int()); }; ``` ## Mocking Overloaded Methods ## You can mock overloaded functions as usual. No special attention is required: ``` class Foo { ... // Must be virtual as we'll inherit from Foo. virtual ~Foo(); // Overloaded on the types and/or numbers of arguments. virtual int Add(Element x); virtual int Add(int times, Element x); // Overloaded on the const-ness of this object. virtual Bar& GetBar(); virtual const Bar& GetBar() const; }; class MockFoo : public Foo { ... MOCK_METHOD1(Add, int(Element x)); MOCK_METHOD2(Add, int(int times, Element x); MOCK_METHOD0(GetBar, Bar&()); MOCK_CONST_METHOD0(GetBar, const Bar&()); }; ``` **Note:** if you don't mock all versions of the overloaded method, the compiler will give you a warning about some methods in the base class being hidden. To fix that, use `using` to bring them in scope: ``` class MockFoo : public Foo { ... using Foo::Add; MOCK_METHOD1(Add, int(Element x)); // We don't want to mock int Add(int times, Element x); ... }; ``` ## Mocking Class Templates ## To mock a class template, append `_T` to the `MOCK_*` macros: ``` template class StackInterface { ... // Must be virtual as we'll inherit from StackInterface. virtual ~StackInterface(); virtual int GetSize() const = 0; virtual void Push(const Elem& x) = 0; }; template class MockStack : public StackInterface { ... MOCK_CONST_METHOD0_T(GetSize, int()); MOCK_METHOD1_T(Push, void(const Elem& x)); }; ``` ## Mocking Nonvirtual Methods ## Google Mock can mock non-virtual functions to be used in what we call _hi-perf dependency injection_. In this case, instead of sharing a common base class with the real class, your mock class will be _unrelated_ to the real class, but contain methods with the same signatures. The syntax for mocking non-virtual methods is the _same_ as mocking virtual methods: ``` // A simple packet stream class. None of its members is virtual. class ConcretePacketStream { public: void AppendPacket(Packet* new_packet); const Packet* GetPacket(size_t packet_number) const; size_t NumberOfPackets() const; ... }; // A mock packet stream class. It inherits from no other, but defines // GetPacket() and NumberOfPackets(). class MockPacketStream { public: MOCK_CONST_METHOD1(GetPacket, const Packet*(size_t packet_number)); MOCK_CONST_METHOD0(NumberOfPackets, size_t()); ... }; ``` Note that the mock class doesn't define `AppendPacket()`, unlike the real class. That's fine as long as the test doesn't need to call it. Next, you need a way to say that you want to use `ConcretePacketStream` in production code, and use `MockPacketStream` in tests. Since the functions are not virtual and the two classes are unrelated, you must specify your choice at _compile time_ (as opposed to run time). One way to do it is to templatize your code that needs to use a packet stream. More specifically, you will give your code a template type argument for the type of the packet stream. In production, you will instantiate your template with `ConcretePacketStream` as the type argument. In tests, you will instantiate the same template with `MockPacketStream`. For example, you may write: ``` template void CreateConnection(PacketStream* stream) { ... } template class PacketReader { public: void ReadPackets(PacketStream* stream, size_t packet_num); }; ``` Then you can use `CreateConnection()` and `PacketReader` in production code, and use `CreateConnection()` and `PacketReader` in tests. ``` MockPacketStream mock_stream; EXPECT_CALL(mock_stream, ...)...; .. set more expectations on mock_stream ... PacketReader reader(&mock_stream); ... exercise reader ... ``` ## Mocking Free Functions ## It's possible to use Google Mock to mock a free function (i.e. a C-style function or a static method). You just need to rewrite your code to use an interface (abstract class). Instead of calling a free function (say, `OpenFile`) directly, introduce an interface for it and have a concrete subclass that calls the free function: ``` class FileInterface { public: ... virtual bool Open(const char* path, const char* mode) = 0; }; class File : public FileInterface { public: ... virtual bool Open(const char* path, const char* mode) { return OpenFile(path, mode); } }; ``` Your code should talk to `FileInterface` to open a file. Now it's easy to mock out the function. This may seem much hassle, but in practice you often have multiple related functions that you can put in the same interface, so the per-function syntactic overhead will be much lower. If you are concerned about the performance overhead incurred by virtual functions, and profiling confirms your concern, you can combine this with the recipe for [mocking non-virtual methods](#Mocking_Nonvirtual_Methods.md). ## Nice Mocks and Strict Mocks ## If a mock method has no `EXPECT_CALL` spec but is called, Google Mock will print a warning about the "uninteresting call". The rationale is: * New methods may be added to an interface after a test is written. We shouldn't fail a test just because a method it doesn't know about is called. * However, this may also mean there's a bug in the test, so Google Mock shouldn't be silent either. If the user believes these calls are harmless, he can add an `EXPECT_CALL()` to suppress the warning. However, sometimes you may want to suppress all "uninteresting call" warnings, while sometimes you may want the opposite, i.e. to treat all of them as errors. Google Mock lets you make the decision on a per-mock-object basis. Suppose your test uses a mock class `MockFoo`: ``` TEST(...) { MockFoo mock_foo; EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... } ``` If a method of `mock_foo` other than `DoThis()` is called, it will be reported by Google Mock as a warning. However, if you rewrite your test to use `NiceMock` instead, the warning will be gone, resulting in a cleaner test output: ``` using ::testing::NiceMock; TEST(...) { NiceMock mock_foo; EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... } ``` `NiceMock` is a subclass of `MockFoo`, so it can be used wherever `MockFoo` is accepted. It also works if `MockFoo`'s constructor takes some arguments, as `NiceMock` "inherits" `MockFoo`'s constructors: ``` using ::testing::NiceMock; TEST(...) { NiceMock mock_foo(5, "hi"); // Calls MockFoo(5, "hi"). EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... } ``` The usage of `StrictMock` is similar, except that it makes all uninteresting calls failures: ``` using ::testing::StrictMock; TEST(...) { StrictMock mock_foo; EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... // The test will fail if a method of mock_foo other than DoThis() // is called. } ``` There are some caveats though (I don't like them just as much as the next guy, but sadly they are side effects of C++'s limitations): 1. `NiceMock` and `StrictMock` only work for mock methods defined using the `MOCK_METHOD*` family of macros **directly** in the `MockFoo` class. If a mock method is defined in a **base class** of `MockFoo`, the "nice" or "strict" modifier may not affect it, depending on the compiler. In particular, nesting `NiceMock` and `StrictMock` (e.g. `NiceMock >`) is **not** supported. 1. The constructors of the base mock (`MockFoo`) cannot have arguments passed by non-const reference, which happens to be banned by the [Google C++ style guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml). 1. During the constructor or destructor of `MockFoo`, the mock object is _not_ nice or strict. This may cause surprises if the constructor or destructor calls a mock method on `this` object. (This behavior, however, is consistent with C++'s general rule: if a constructor or destructor calls a virtual method of `this` object, that method is treated as non-virtual. In other words, to the base class's constructor or destructor, `this` object behaves like an instance of the base class, not the derived class. This rule is required for safety. Otherwise a base constructor may use members of a derived class before they are initialized, or a base destructor may use members of a derived class after they have been destroyed.) Finally, you should be **very cautious** when using this feature, as the decision you make applies to **all** future changes to the mock class. If an important change is made in the interface you are mocking (and thus in the mock class), it could break your tests (if you use `StrictMock`) or let bugs pass through without a warning (if you use `NiceMock`). Therefore, try to specify the mock's behavior using explicit `EXPECT_CALL` first, and only turn to `NiceMock` or `StrictMock` as the last resort. ## Simplifying the Interface without Breaking Existing Code ## Sometimes a method has a long list of arguments that is mostly uninteresting. For example, ``` class LogSink { public: ... virtual void send(LogSeverity severity, const char* full_filename, const char* base_filename, int line, const struct tm* tm_time, const char* message, size_t message_len) = 0; }; ``` This method's argument list is lengthy and hard to work with (let's say that the `message` argument is not even 0-terminated). If we mock it as is, using the mock will be awkward. If, however, we try to simplify this interface, we'll need to fix all clients depending on it, which is often infeasible. The trick is to re-dispatch the method in the mock class: ``` class ScopedMockLog : public LogSink { public: ... virtual void send(LogSeverity severity, const char* full_filename, const char* base_filename, int line, const tm* tm_time, const char* message, size_t message_len) { // We are only interested in the log severity, full file name, and // log message. Log(severity, full_filename, std::string(message, message_len)); } // Implements the mock method: // // void Log(LogSeverity severity, // const string& file_path, // const string& message); MOCK_METHOD3(Log, void(LogSeverity severity, const string& file_path, const string& message)); }; ``` By defining a new mock method with a trimmed argument list, we make the mock class much more user-friendly. ## Alternative to Mocking Concrete Classes ## Often you may find yourself using classes that don't implement interfaces. In order to test your code that uses such a class (let's call it `Concrete`), you may be tempted to make the methods of `Concrete` virtual and then mock it. Try not to do that. Making a non-virtual function virtual is a big decision. It creates an extension point where subclasses can tweak your class' behavior. This weakens your control on the class because now it's harder to maintain the class' invariants. You should make a function virtual only when there is a valid reason for a subclass to override it. Mocking concrete classes directly is problematic as it creates a tight coupling between the class and the tests - any small change in the class may invalidate your tests and make test maintenance a pain. To avoid such problems, many programmers have been practicing "coding to interfaces": instead of talking to the `Concrete` class, your code would define an interface and talk to it. Then you implement that interface as an adaptor on top of `Concrete`. In tests, you can easily mock that interface to observe how your code is doing. This technique incurs some overhead: * You pay the cost of virtual function calls (usually not a problem). * There is more abstraction for the programmers to learn. However, it can also bring significant benefits in addition to better testability: * `Concrete`'s API may not fit your problem domain very well, as you may not be the only client it tries to serve. By designing your own interface, you have a chance to tailor it to your need - you may add higher-level functionalities, rename stuff, etc instead of just trimming the class. This allows you to write your code (user of the interface) in a more natural way, which means it will be more readable, more maintainable, and you'll be more productive. * If `Concrete`'s implementation ever has to change, you don't have to rewrite everywhere it is used. Instead, you can absorb the change in your implementation of the interface, and your other code and tests will be insulated from this change. Some people worry that if everyone is practicing this technique, they will end up writing lots of redundant code. This concern is totally understandable. However, there are two reasons why it may not be the case: * Different projects may need to use `Concrete` in different ways, so the best interfaces for them will be different. Therefore, each of them will have its own domain-specific interface on top of `Concrete`, and they will not be the same code. * If enough projects want to use the same interface, they can always share it, just like they have been sharing `Concrete`. You can check in the interface and the adaptor somewhere near `Concrete` (perhaps in a `contrib` sub-directory) and let many projects use it. You need to weigh the pros and cons carefully for your particular problem, but I'd like to assure you that the Java community has been practicing this for a long time and it's a proven effective technique applicable in a wide variety of situations. :-) ## Delegating Calls to a Fake ## Some times you have a non-trivial fake implementation of an interface. For example: ``` class Foo { public: virtual ~Foo() {} virtual char DoThis(int n) = 0; virtual void DoThat(const char* s, int* p) = 0; }; class FakeFoo : public Foo { public: virtual char DoThis(int n) { return (n > 0) ? '+' : (n < 0) ? '-' : '0'; } virtual void DoThat(const char* s, int* p) { *p = strlen(s); } }; ``` Now you want to mock this interface such that you can set expectations on it. However, you also want to use `FakeFoo` for the default behavior, as duplicating it in the mock object is, well, a lot of work. When you define the mock class using Google Mock, you can have it delegate its default action to a fake class you already have, using this pattern: ``` using ::testing::_; using ::testing::Invoke; class MockFoo : public Foo { public: // Normal mock method definitions using Google Mock. MOCK_METHOD1(DoThis, char(int n)); MOCK_METHOD2(DoThat, void(const char* s, int* p)); // Delegates the default actions of the methods to a FakeFoo object. // This must be called *before* the custom ON_CALL() statements. void DelegateToFake() { ON_CALL(*this, DoThis(_)) .WillByDefault(Invoke(&fake_, &FakeFoo::DoThis)); ON_CALL(*this, DoThat(_, _)) .WillByDefault(Invoke(&fake_, &FakeFoo::DoThat)); } private: FakeFoo fake_; // Keeps an instance of the fake in the mock. }; ``` With that, you can use `MockFoo` in your tests as usual. Just remember that if you don't explicitly set an action in an `ON_CALL()` or `EXPECT_CALL()`, the fake will be called upon to do it: ``` using ::testing::_; TEST(AbcTest, Xyz) { MockFoo foo; foo.DelegateToFake(); // Enables the fake for delegation. // Put your ON_CALL(foo, ...)s here, if any. // No action specified, meaning to use the default action. EXPECT_CALL(foo, DoThis(5)); EXPECT_CALL(foo, DoThat(_, _)); int n = 0; EXPECT_EQ('+', foo.DoThis(5)); // FakeFoo::DoThis() is invoked. foo.DoThat("Hi", &n); // FakeFoo::DoThat() is invoked. EXPECT_EQ(2, n); } ``` **Some tips:** * If you want, you can still override the default action by providing your own `ON_CALL()` or using `.WillOnce()` / `.WillRepeatedly()` in `EXPECT_CALL()`. * In `DelegateToFake()`, you only need to delegate the methods whose fake implementation you intend to use. * The general technique discussed here works for overloaded methods, but you'll need to tell the compiler which version you mean. To disambiguate a mock function (the one you specify inside the parentheses of `ON_CALL()`), see the "Selecting Between Overloaded Functions" section on this page; to disambiguate a fake function (the one you place inside `Invoke()`), use a `static_cast` to specify the function's type. * Having to mix a mock and a fake is often a sign of something gone wrong. Perhaps you haven't got used to the interaction-based way of testing yet. Or perhaps your interface is taking on too many roles and should be split up. Therefore, **don't abuse this**. We would only recommend to do it as an intermediate step when you are refactoring your code. Regarding the tip on mixing a mock and a fake, here's an example on why it may be a bad sign: Suppose you have a class `System` for low-level system operations. In particular, it does file and I/O operations. And suppose you want to test how your code uses `System` to do I/O, and you just want the file operations to work normally. If you mock out the entire `System` class, you'll have to provide a fake implementation for the file operation part, which suggests that `System` is taking on too many roles. Instead, you can define a `FileOps` interface and an `IOOps` interface and split `System`'s functionalities into the two. Then you can mock `IOOps` without mocking `FileOps`. ## Delegating Calls to a Real Object ## When using testing doubles (mocks, fakes, stubs, and etc), sometimes their behaviors will differ from those of the real objects. This difference could be either intentional (as in simulating an error such that you can test the error handling code) or unintentional. If your mocks have different behaviors than the real objects by mistake, you could end up with code that passes the tests but fails in production. You can use the _delegating-to-real_ technique to ensure that your mock has the same behavior as the real object while retaining the ability to validate calls. This technique is very similar to the delegating-to-fake technique, the difference being that we use a real object instead of a fake. Here's an example: ``` using ::testing::_; using ::testing::AtLeast; using ::testing::Invoke; class MockFoo : public Foo { public: MockFoo() { // By default, all calls are delegated to the real object. ON_CALL(*this, DoThis()) .WillByDefault(Invoke(&real_, &Foo::DoThis)); ON_CALL(*this, DoThat(_)) .WillByDefault(Invoke(&real_, &Foo::DoThat)); ... } MOCK_METHOD0(DoThis, ...); MOCK_METHOD1(DoThat, ...); ... private: Foo real_; }; ... MockFoo mock; EXPECT_CALL(mock, DoThis()) .Times(3); EXPECT_CALL(mock, DoThat("Hi")) .Times(AtLeast(1)); ... use mock in test ... ``` With this, Google Mock will verify that your code made the right calls (with the right arguments, in the right order, called the right number of times, etc), and a real object will answer the calls (so the behavior will be the same as in production). This gives you the best of both worlds. ## Delegating Calls to a Parent Class ## Ideally, you should code to interfaces, whose methods are all pure virtual. In reality, sometimes you do need to mock a virtual method that is not pure (i.e, it already has an implementation). For example: ``` class Foo { public: virtual ~Foo(); virtual void Pure(int n) = 0; virtual int Concrete(const char* str) { ... } }; class MockFoo : public Foo { public: // Mocking a pure method. MOCK_METHOD1(Pure, void(int n)); // Mocking a concrete method. Foo::Concrete() is shadowed. MOCK_METHOD1(Concrete, int(const char* str)); }; ``` Sometimes you may want to call `Foo::Concrete()` instead of `MockFoo::Concrete()`. Perhaps you want to do it as part of a stub action, or perhaps your test doesn't need to mock `Concrete()` at all (but it would be oh-so painful to have to define a new mock class whenever you don't need to mock one of its methods). The trick is to leave a back door in your mock class for accessing the real methods in the base class: ``` class MockFoo : public Foo { public: // Mocking a pure method. MOCK_METHOD1(Pure, void(int n)); // Mocking a concrete method. Foo::Concrete() is shadowed. MOCK_METHOD1(Concrete, int(const char* str)); // Use this to call Concrete() defined in Foo. int FooConcrete(const char* str) { return Foo::Concrete(str); } }; ``` Now, you can call `Foo::Concrete()` inside an action by: ``` using ::testing::_; using ::testing::Invoke; ... EXPECT_CALL(foo, Concrete(_)) .WillOnce(Invoke(&foo, &MockFoo::FooConcrete)); ``` or tell the mock object that you don't want to mock `Concrete()`: ``` using ::testing::Invoke; ... ON_CALL(foo, Concrete(_)) .WillByDefault(Invoke(&foo, &MockFoo::FooConcrete)); ``` (Why don't we just write `Invoke(&foo, &Foo::Concrete)`? If you do that, `MockFoo::Concrete()` will be called (and cause an infinite recursion) since `Foo::Concrete()` is virtual. That's just how C++ works.) # Using Matchers # ## Matching Argument Values Exactly ## You can specify exactly which arguments a mock method is expecting: ``` using ::testing::Return; ... EXPECT_CALL(foo, DoThis(5)) .WillOnce(Return('a')); EXPECT_CALL(foo, DoThat("Hello", bar)); ``` ## Using Simple Matchers ## You can use matchers to match arguments that have a certain property: ``` using ::testing::Ge; using ::testing::NotNull; using ::testing::Return; ... EXPECT_CALL(foo, DoThis(Ge(5))) // The argument must be >= 5. .WillOnce(Return('a')); EXPECT_CALL(foo, DoThat("Hello", NotNull())); // The second argument must not be NULL. ``` A frequently used matcher is `_`, which matches anything: ``` using ::testing::_; using ::testing::NotNull; ... EXPECT_CALL(foo, DoThat(_, NotNull())); ``` ## Combining Matchers ## You can build complex matchers from existing ones using `AllOf()`, `AnyOf()`, and `Not()`: ``` using ::testing::AllOf; using ::testing::Gt; using ::testing::HasSubstr; using ::testing::Ne; using ::testing::Not; ... // The argument must be > 5 and != 10. EXPECT_CALL(foo, DoThis(AllOf(Gt(5), Ne(10)))); // The first argument must not contain sub-string "blah". EXPECT_CALL(foo, DoThat(Not(HasSubstr("blah")), NULL)); ``` ## Casting Matchers ## Google Mock matchers are statically typed, meaning that the compiler can catch your mistake if you use a matcher of the wrong type (for example, if you use `Eq(5)` to match a `string` argument). Good for you! Sometimes, however, you know what you're doing and want the compiler to give you some slack. One example is that you have a matcher for `long` and the argument you want to match is `int`. While the two types aren't exactly the same, there is nothing really wrong with using a `Matcher` to match an `int` - after all, we can first convert the `int` argument to a `long` before giving it to the matcher. To support this need, Google Mock gives you the `SafeMatcherCast(m)` function. It casts a matcher `m` to type `Matcher`. To ensure safety, Google Mock checks that (let `U` be the type `m` accepts): 1. Type `T` can be implicitly cast to type `U`; 1. When both `T` and `U` are built-in arithmetic types (`bool`, integers, and floating-point numbers), the conversion from `T` to `U` is not lossy (in other words, any value representable by `T` can also be represented by `U`); and 1. When `U` is a reference, `T` must also be a reference (as the underlying matcher may be interested in the address of the `U` value). The code won't compile if any of these conditions isn't met. Here's one example: ``` using ::testing::SafeMatcherCast; // A base class and a child class. class Base { ... }; class Derived : public Base { ... }; class MockFoo : public Foo { public: MOCK_METHOD1(DoThis, void(Derived* derived)); }; ... MockFoo foo; // m is a Matcher we got from somewhere. EXPECT_CALL(foo, DoThis(SafeMatcherCast(m))); ``` If you find `SafeMatcherCast(m)` too limiting, you can use a similar function `MatcherCast(m)`. The difference is that `MatcherCast` works as long as you can `static_cast` type `T` to type `U`. `MatcherCast` essentially lets you bypass C++'s type system (`static_cast` isn't always safe as it could throw away information, for example), so be careful not to misuse/abuse it. ## Selecting Between Overloaded Functions ## If you expect an overloaded function to be called, the compiler may need some help on which overloaded version it is. To disambiguate functions overloaded on the const-ness of this object, use the `Const()` argument wrapper. ``` using ::testing::ReturnRef; class MockFoo : public Foo { ... MOCK_METHOD0(GetBar, Bar&()); MOCK_CONST_METHOD0(GetBar, const Bar&()); }; ... MockFoo foo; Bar bar1, bar2; EXPECT_CALL(foo, GetBar()) // The non-const GetBar(). .WillOnce(ReturnRef(bar1)); EXPECT_CALL(Const(foo), GetBar()) // The const GetBar(). .WillOnce(ReturnRef(bar2)); ``` (`Const()` is defined by Google Mock and returns a `const` reference to its argument.) To disambiguate overloaded functions with the same number of arguments but different argument types, you may need to specify the exact type of a matcher, either by wrapping your matcher in `Matcher()`, or using a matcher whose type is fixed (`TypedEq`, `An()`, etc): ``` using ::testing::An; using ::testing::Lt; using ::testing::Matcher; using ::testing::TypedEq; class MockPrinter : public Printer { public: MOCK_METHOD1(Print, void(int n)); MOCK_METHOD1(Print, void(char c)); }; TEST(PrinterTest, Print) { MockPrinter printer; EXPECT_CALL(printer, Print(An())); // void Print(int); EXPECT_CALL(printer, Print(Matcher(Lt(5)))); // void Print(int); EXPECT_CALL(printer, Print(TypedEq('a'))); // void Print(char); printer.Print(3); printer.Print(6); printer.Print('a'); } ``` ## Performing Different Actions Based on the Arguments ## When a mock method is called, the _last_ matching expectation that's still active will be selected (think "newer overrides older"). So, you can make a method do different things depending on its argument values like this: ``` using ::testing::_; using ::testing::Lt; using ::testing::Return; ... // The default case. EXPECT_CALL(foo, DoThis(_)) .WillRepeatedly(Return('b')); // The more specific case. EXPECT_CALL(foo, DoThis(Lt(5))) .WillRepeatedly(Return('a')); ``` Now, if `foo.DoThis()` is called with a value less than 5, `'a'` will be returned; otherwise `'b'` will be returned. ## Matching Multiple Arguments as a Whole ## Sometimes it's not enough to match the arguments individually. For example, we may want to say that the first argument must be less than the second argument. The `With()` clause allows us to match all arguments of a mock function as a whole. For example, ``` using ::testing::_; using ::testing::Lt; using ::testing::Ne; ... EXPECT_CALL(foo, InRange(Ne(0), _)) .With(Lt()); ``` says that the first argument of `InRange()` must not be 0, and must be less than the second argument. The expression inside `With()` must be a matcher of type `Matcher >`, where `A1`, ..., `An` are the types of the function arguments. You can also write `AllArgs(m)` instead of `m` inside `.With()`. The two forms are equivalent, but `.With(AllArgs(Lt()))` is more readable than `.With(Lt())`. You can use `Args(m)` to match the `n` selected arguments (as a tuple) against `m`. For example, ``` using ::testing::_; using ::testing::AllOf; using ::testing::Args; using ::testing::Lt; ... EXPECT_CALL(foo, Blah(_, _, _)) .With(AllOf(Args<0, 1>(Lt()), Args<1, 2>(Lt()))); ``` says that `Blah()` will be called with arguments `x`, `y`, and `z` where `x < y < z`. As a convenience and example, Google Mock provides some matchers for 2-tuples, including the `Lt()` matcher above. See the [CheatSheet](V1_6_CheatSheet.md) for the complete list. Note that if you want to pass the arguments to a predicate of your own (e.g. `.With(Args<0, 1>(Truly(&MyPredicate)))`), that predicate MUST be written to take a `tr1::tuple` as its argument; Google Mock will pass the `n` selected arguments as _one_ single tuple to the predicate. ## Using Matchers as Predicates ## Have you noticed that a matcher is just a fancy predicate that also knows how to describe itself? Many existing algorithms take predicates as arguments (e.g. those defined in STL's `` header), and it would be a shame if Google Mock matchers are not allowed to participate. Luckily, you can use a matcher where a unary predicate functor is expected by wrapping it inside the `Matches()` function. For example, ``` #include #include std::vector v; ... // How many elements in v are >= 10? const int count = count_if(v.begin(), v.end(), Matches(Ge(10))); ``` Since you can build complex matchers from simpler ones easily using Google Mock, this gives you a way to conveniently construct composite predicates (doing the same using STL's `` header is just painful). For example, here's a predicate that's satisfied by any number that is >= 0, <= 100, and != 50: ``` Matches(AllOf(Ge(0), Le(100), Ne(50))) ``` ## Using Matchers in Google Test Assertions ## Since matchers are basically predicates that also know how to describe themselves, there is a way to take advantage of them in [Google Test](http://code.google.com/p/googletest/) assertions. It's called `ASSERT_THAT` and `EXPECT_THAT`: ``` ASSERT_THAT(value, matcher); // Asserts that value matches matcher. EXPECT_THAT(value, matcher); // The non-fatal version. ``` For example, in a Google Test test you can write: ``` #include "gmock/gmock.h" using ::testing::AllOf; using ::testing::Ge; using ::testing::Le; using ::testing::MatchesRegex; using ::testing::StartsWith; ... EXPECT_THAT(Foo(), StartsWith("Hello")); EXPECT_THAT(Bar(), MatchesRegex("Line \\d+")); ASSERT_THAT(Baz(), AllOf(Ge(5), Le(10))); ``` which (as you can probably guess) executes `Foo()`, `Bar()`, and `Baz()`, and verifies that: * `Foo()` returns a string that starts with `"Hello"`. * `Bar()` returns a string that matches regular expression `"Line \\d+"`. * `Baz()` returns a number in the range [5, 10]. The nice thing about these macros is that _they read like English_. They generate informative messages too. For example, if the first `EXPECT_THAT()` above fails, the message will be something like: ``` Value of: Foo() Actual: "Hi, world!" Expected: starts with "Hello" ``` **Credit:** The idea of `(ASSERT|EXPECT)_THAT` was stolen from the [Hamcrest](http://code.google.com/p/hamcrest/) project, which adds `assertThat()` to JUnit. ## Using Predicates as Matchers ## Google Mock provides a built-in set of matchers. In case you find them lacking, you can use an arbitray unary predicate function or functor as a matcher - as long as the predicate accepts a value of the type you want. You do this by wrapping the predicate inside the `Truly()` function, for example: ``` using ::testing::Truly; int IsEven(int n) { return (n % 2) == 0 ? 1 : 0; } ... // Bar() must be called with an even number. EXPECT_CALL(foo, Bar(Truly(IsEven))); ``` Note that the predicate function / functor doesn't have to return `bool`. It works as long as the return value can be used as the condition in statement `if (condition) ...`. ## Matching Arguments that Are Not Copyable ## When you do an `EXPECT_CALL(mock_obj, Foo(bar))`, Google Mock saves away a copy of `bar`. When `Foo()` is called later, Google Mock compares the argument to `Foo()` with the saved copy of `bar`. This way, you don't need to worry about `bar` being modified or destroyed after the `EXPECT_CALL()` is executed. The same is true when you use matchers like `Eq(bar)`, `Le(bar)`, and so on. But what if `bar` cannot be copied (i.e. has no copy constructor)? You could define your own matcher function and use it with `Truly()`, as the previous couple of recipes have shown. Or, you may be able to get away from it if you can guarantee that `bar` won't be changed after the `EXPECT_CALL()` is executed. Just tell Google Mock that it should save a reference to `bar`, instead of a copy of it. Here's how: ``` using ::testing::Eq; using ::testing::ByRef; using ::testing::Lt; ... // Expects that Foo()'s argument == bar. EXPECT_CALL(mock_obj, Foo(Eq(ByRef(bar)))); // Expects that Foo()'s argument < bar. EXPECT_CALL(mock_obj, Foo(Lt(ByRef(bar)))); ``` Remember: if you do this, don't change `bar` after the `EXPECT_CALL()`, or the result is undefined. ## Validating a Member of an Object ## Often a mock function takes a reference to object as an argument. When matching the argument, you may not want to compare the entire object against a fixed object, as that may be over-specification. Instead, you may need to validate a certain member variable or the result of a certain getter method of the object. You can do this with `Field()` and `Property()`. More specifically, ``` Field(&Foo::bar, m) ``` is a matcher that matches a `Foo` object whose `bar` member variable satisfies matcher `m`. ``` Property(&Foo::baz, m) ``` is a matcher that matches a `Foo` object whose `baz()` method returns a value that satisfies matcher `m`. For example: > | `Field(&Foo::number, Ge(3))` | Matches `x` where `x.number >= 3`. | |:-----------------------------|:-----------------------------------| > | `Property(&Foo::name, StartsWith("John "))` | Matches `x` where `x.name()` starts with `"John "`. | Note that in `Property(&Foo::baz, ...)`, method `baz()` must take no argument and be declared as `const`. BTW, `Field()` and `Property()` can also match plain pointers to objects. For instance, ``` Field(&Foo::number, Ge(3)) ``` matches a plain pointer `p` where `p->number >= 3`. If `p` is `NULL`, the match will always fail regardless of the inner matcher. What if you want to validate more than one members at the same time? Remember that there is `AllOf()`. ## Validating the Value Pointed to by a Pointer Argument ## C++ functions often take pointers as arguments. You can use matchers like `NULL`, `NotNull()`, and other comparison matchers to match a pointer, but what if you want to make sure the value _pointed to_ by the pointer, instead of the pointer itself, has a certain property? Well, you can use the `Pointee(m)` matcher. `Pointee(m)` matches a pointer iff `m` matches the value the pointer points to. For example: ``` using ::testing::Ge; using ::testing::Pointee; ... EXPECT_CALL(foo, Bar(Pointee(Ge(3)))); ``` expects `foo.Bar()` to be called with a pointer that points to a value greater than or equal to 3. One nice thing about `Pointee()` is that it treats a `NULL` pointer as a match failure, so you can write `Pointee(m)` instead of ``` AllOf(NotNull(), Pointee(m)) ``` without worrying that a `NULL` pointer will crash your test. Also, did we tell you that `Pointee()` works with both raw pointers **and** smart pointers (`linked_ptr`, `shared_ptr`, `scoped_ptr`, and etc)? What if you have a pointer to pointer? You guessed it - you can use nested `Pointee()` to probe deeper inside the value. For example, `Pointee(Pointee(Lt(3)))` matches a pointer that points to a pointer that points to a number less than 3 (what a mouthful...). ## Testing a Certain Property of an Object ## Sometimes you want to specify that an object argument has a certain property, but there is no existing matcher that does this. If you want good error messages, you should define a matcher. If you want to do it quick and dirty, you could get away with writing an ordinary function. Let's say you have a mock function that takes an object of type `Foo`, which has an `int bar()` method and an `int baz()` method, and you want to constrain that the argument's `bar()` value plus its `baz()` value is a given number. Here's how you can define a matcher to do it: ``` using ::testing::MatcherInterface; using ::testing::MatchResultListener; class BarPlusBazEqMatcher : public MatcherInterface { public: explicit BarPlusBazEqMatcher(int expected_sum) : expected_sum_(expected_sum) {} virtual bool MatchAndExplain(const Foo& foo, MatchResultListener* listener) const { return (foo.bar() + foo.baz()) == expected_sum_; } virtual void DescribeTo(::std::ostream* os) const { *os << "bar() + baz() equals " << expected_sum_; } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "bar() + baz() does not equal " << expected_sum_; } private: const int expected_sum_; }; inline Matcher BarPlusBazEq(int expected_sum) { return MakeMatcher(new BarPlusBazEqMatcher(expected_sum)); } ... EXPECT_CALL(..., DoThis(BarPlusBazEq(5)))...; ``` ## Matching Containers ## Sometimes an STL container (e.g. list, vector, map, ...) is passed to a mock function and you may want to validate it. Since most STL containers support the `==` operator, you can write `Eq(expected_container)` or simply `expected_container` to match a container exactly. Sometimes, though, you may want to be more flexible (for example, the first element must be an exact match, but the second element can be any positive number, and so on). Also, containers used in tests often have a small number of elements, and having to define the expected container out-of-line is a bit of a hassle. You can use the `ElementsAre()` matcher in such cases: ``` using ::testing::_; using ::testing::ElementsAre; using ::testing::Gt; ... MOCK_METHOD1(Foo, void(const vector& numbers)); ... EXPECT_CALL(mock, Foo(ElementsAre(1, Gt(0), _, 5))); ``` The above matcher says that the container must have 4 elements, which must be 1, greater than 0, anything, and 5 respectively. `ElementsAre()` is overloaded to take 0 to 10 arguments. If more are needed, you can place them in a C-style array and use `ElementsAreArray()` instead: ``` using ::testing::ElementsAreArray; ... // ElementsAreArray accepts an array of element values. const int expected_vector1[] = { 1, 5, 2, 4, ... }; EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector1))); // Or, an array of element matchers. Matcher expected_vector2 = { 1, Gt(2), _, 3, ... }; EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector2))); ``` In case the array needs to be dynamically created (and therefore the array size cannot be inferred by the compiler), you can give `ElementsAreArray()` an additional argument to specify the array size: ``` using ::testing::ElementsAreArray; ... int* const expected_vector3 = new int[count]; ... fill expected_vector3 with values ... EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector3, count))); ``` **Tips:** * `ElementAre*()` works with _any_ container that implements the STL iterator concept (i.e. it has a `const_iterator` type and supports `begin()/end()`) and supports `size()`, not just the ones defined in STL. It will even work with container types yet to be written - as long as they follows the above pattern. * You can use nested `ElementAre*()` to match nested (multi-dimensional) containers. * If the container is passed by pointer instead of by reference, just write `Pointee(ElementsAre*(...))`. * The order of elements _matters_ for `ElementsAre*()`. Therefore don't use it with containers whose element order is undefined (e.g. `hash_map`). ## Sharing Matchers ## Under the hood, a Google Mock matcher object consists of a pointer to a ref-counted implementation object. Copying matchers is allowed and very efficient, as only the pointer is copied. When the last matcher that references the implementation object dies, the implementation object will be deleted. Therefore, if you have some complex matcher that you want to use again and again, there is no need to build it everytime. Just assign it to a matcher variable and use that variable repeatedly! For example, ``` Matcher in_range = AllOf(Gt(5), Le(10)); ... use in_range as a matcher in multiple EXPECT_CALLs ... ``` # Setting Expectations # ## Ignoring Uninteresting Calls ## If you are not interested in how a mock method is called, just don't say anything about it. In this case, if the method is ever called, Google Mock will perform its default action to allow the test program to continue. If you are not happy with the default action taken by Google Mock, you can override it using `DefaultValue::Set()` (described later in this document) or `ON_CALL()`. Please note that once you expressed interest in a particular mock method (via `EXPECT_CALL()`), all invocations to it must match some expectation. If this function is called but the arguments don't match any `EXPECT_CALL()` statement, it will be an error. ## Disallowing Unexpected Calls ## If a mock method shouldn't be called at all, explicitly say so: ``` using ::testing::_; ... EXPECT_CALL(foo, Bar(_)) .Times(0); ``` If some calls to the method are allowed, but the rest are not, just list all the expected calls: ``` using ::testing::AnyNumber; using ::testing::Gt; ... EXPECT_CALL(foo, Bar(5)); EXPECT_CALL(foo, Bar(Gt(10))) .Times(AnyNumber()); ``` A call to `foo.Bar()` that doesn't match any of the `EXPECT_CALL()` statements will be an error. ## Expecting Ordered Calls ## Although an `EXPECT_CALL()` statement defined earlier takes precedence when Google Mock tries to match a function call with an expectation, by default calls don't have to happen in the order `EXPECT_CALL()` statements are written. For example, if the arguments match the matchers in the third `EXPECT_CALL()`, but not those in the first two, then the third expectation will be used. If you would rather have all calls occur in the order of the expectations, put the `EXPECT_CALL()` statements in a block where you define a variable of type `InSequence`: ``` using ::testing::_; using ::testing::InSequence; { InSequence s; EXPECT_CALL(foo, DoThis(5)); EXPECT_CALL(bar, DoThat(_)) .Times(2); EXPECT_CALL(foo, DoThis(6)); } ``` In this example, we expect a call to `foo.DoThis(5)`, followed by two calls to `bar.DoThat()` where the argument can be anything, which are in turn followed by a call to `foo.DoThis(6)`. If a call occurred out-of-order, Google Mock will report an error. ## Expecting Partially Ordered Calls ## Sometimes requiring everything to occur in a predetermined order can lead to brittle tests. For example, we may care about `A` occurring before both `B` and `C`, but aren't interested in the relative order of `B` and `C`. In this case, the test should reflect our real intent, instead of being overly constraining. Google Mock allows you to impose an arbitrary DAG (directed acyclic graph) on the calls. One way to express the DAG is to use the [After](http://code.google.com/p/googlemock/wiki/V1_6_CheatSheet#The_After_Clause) clause of `EXPECT_CALL`. Another way is via the `InSequence()` clause (not the same as the `InSequence` class), which we borrowed from jMock 2. It's less flexible than `After()`, but more convenient when you have long chains of sequential calls, as it doesn't require you to come up with different names for the expectations in the chains. Here's how it works: If we view `EXPECT_CALL()` statements as nodes in a graph, and add an edge from node A to node B wherever A must occur before B, we can get a DAG. We use the term "sequence" to mean a directed path in this DAG. Now, if we decompose the DAG into sequences, we just need to know which sequences each `EXPECT_CALL()` belongs to in order to be able to reconstruct the orginal DAG. So, to specify the partial order on the expectations we need to do two things: first to define some `Sequence` objects, and then for each `EXPECT_CALL()` say which `Sequence` objects it is part of. Expectations in the same sequence must occur in the order they are written. For example, ``` using ::testing::Sequence; Sequence s1, s2; EXPECT_CALL(foo, A()) .InSequence(s1, s2); EXPECT_CALL(bar, B()) .InSequence(s1); EXPECT_CALL(bar, C()) .InSequence(s2); EXPECT_CALL(foo, D()) .InSequence(s2); ``` specifies the following DAG (where `s1` is `A -> B`, and `s2` is `A -> C -> D`): ``` +---> B | A ---| | +---> C ---> D ``` This means that A must occur before B and C, and C must occur before D. There's no restriction about the order other than these. ## Controlling When an Expectation Retires ## When a mock method is called, Google Mock only consider expectations that are still active. An expectation is active when created, and becomes inactive (aka _retires_) when a call that has to occur later has occurred. For example, in ``` using ::testing::_; using ::testing::Sequence; Sequence s1, s2; EXPECT_CALL(log, Log(WARNING, _, "File too large.")) // #1 .Times(AnyNumber()) .InSequence(s1, s2); EXPECT_CALL(log, Log(WARNING, _, "Data set is empty.")) // #2 .InSequence(s1); EXPECT_CALL(log, Log(WARNING, _, "User not found.")) // #3 .InSequence(s2); ``` as soon as either #2 or #3 is matched, #1 will retire. If a warning `"File too large."` is logged after this, it will be an error. Note that an expectation doesn't retire automatically when it's saturated. For example, ``` using ::testing::_; ... EXPECT_CALL(log, Log(WARNING, _, _)); // #1 EXPECT_CALL(log, Log(WARNING, _, "File too large.")); // #2 ``` says that there will be exactly one warning with the message `"File too large."`. If the second warning contains this message too, #2 will match again and result in an upper-bound-violated error. If this is not what you want, you can ask an expectation to retire as soon as it becomes saturated: ``` using ::testing::_; ... EXPECT_CALL(log, Log(WARNING, _, _)); // #1 EXPECT_CALL(log, Log(WARNING, _, "File too large.")) // #2 .RetiresOnSaturation(); ``` Here #2 can be used only once, so if you have two warnings with the message `"File too large."`, the first will match #2 and the second will match #1 - there will be no error. # Using Actions # ## Returning References from Mock Methods ## If a mock function's return type is a reference, you need to use `ReturnRef()` instead of `Return()` to return a result: ``` using ::testing::ReturnRef; class MockFoo : public Foo { public: MOCK_METHOD0(GetBar, Bar&()); }; ... MockFoo foo; Bar bar; EXPECT_CALL(foo, GetBar()) .WillOnce(ReturnRef(bar)); ``` ## Returning Live Values from Mock Methods ## The `Return(x)` action saves a copy of `x` when the action is _created_, and always returns the same value whenever it's executed. Sometimes you may want to instead return the _live_ value of `x` (i.e. its value at the time when the action is _executed_.). If the mock function's return type is a reference, you can do it using `ReturnRef(x)`, as shown in the previous recipe ("Returning References from Mock Methods"). However, Google Mock doesn't let you use `ReturnRef()` in a mock function whose return type is not a reference, as doing that usually indicates a user error. So, what shall you do? You may be tempted to try `ByRef()`: ``` using testing::ByRef; using testing::Return; class MockFoo : public Foo { public: MOCK_METHOD0(GetValue, int()); }; ... int x = 0; MockFoo foo; EXPECT_CALL(foo, GetValue()) .WillRepeatedly(Return(ByRef(x))); x = 42; EXPECT_EQ(42, foo.GetValue()); ``` Unfortunately, it doesn't work here. The above code will fail with error: ``` Value of: foo.GetValue() Actual: 0 Expected: 42 ``` The reason is that `Return(value)` converts `value` to the actual return type of the mock function at the time when the action is _created_, not when it is _executed_. (This behavior was chosen for the action to be safe when `value` is a proxy object that references some temporary objects.) As a result, `ByRef(x)` is converted to an `int` value (instead of a `const int&`) when the expectation is set, and `Return(ByRef(x))` will always return 0. `ReturnPointee(pointer)` was provided to solve this problem specifically. It returns the value pointed to by `pointer` at the time the action is _executed_: ``` using testing::ReturnPointee; ... int x = 0; MockFoo foo; EXPECT_CALL(foo, GetValue()) .WillRepeatedly(ReturnPointee(&x)); // Note the & here. x = 42; EXPECT_EQ(42, foo.GetValue()); // This will succeed now. ``` ## Combining Actions ## Want to do more than one thing when a function is called? That's fine. `DoAll()` allow you to do sequence of actions every time. Only the return value of the last action in the sequence will be used. ``` using ::testing::DoAll; class MockFoo : public Foo { public: MOCK_METHOD1(Bar, bool(int n)); }; ... EXPECT_CALL(foo, Bar(_)) .WillOnce(DoAll(action_1, action_2, ... action_n)); ``` ## Mocking Side Effects ## Sometimes a method exhibits its effect not via returning a value but via side effects. For example, it may change some global state or modify an output argument. To mock side effects, in general you can define your own action by implementing `::testing::ActionInterface`. If all you need to do is to change an output argument, the built-in `SetArgPointee()` action is convenient: ``` using ::testing::SetArgPointee; class MockMutator : public Mutator { public: MOCK_METHOD2(Mutate, void(bool mutate, int* value)); ... }; ... MockMutator mutator; EXPECT_CALL(mutator, Mutate(true, _)) .WillOnce(SetArgPointee<1>(5)); ``` In this example, when `mutator.Mutate()` is called, we will assign 5 to the `int` variable pointed to by argument #1 (0-based). `SetArgPointee()` conveniently makes an internal copy of the value you pass to it, removing the need to keep the value in scope and alive. The implication however is that the value must have a copy constructor and assignment operator. If the mock method also needs to return a value as well, you can chain `SetArgPointee()` with `Return()` using `DoAll()`: ``` using ::testing::_; using ::testing::Return; using ::testing::SetArgPointee; class MockMutator : public Mutator { public: ... MOCK_METHOD1(MutateInt, bool(int* value)); }; ... MockMutator mutator; EXPECT_CALL(mutator, MutateInt(_)) .WillOnce(DoAll(SetArgPointee<0>(5), Return(true))); ``` If the output argument is an array, use the `SetArrayArgument(first, last)` action instead. It copies the elements in source range `[first, last)` to the array pointed to by the `N`-th (0-based) argument: ``` using ::testing::NotNull; using ::testing::SetArrayArgument; class MockArrayMutator : public ArrayMutator { public: MOCK_METHOD2(Mutate, void(int* values, int num_values)); ... }; ... MockArrayMutator mutator; int values[5] = { 1, 2, 3, 4, 5 }; EXPECT_CALL(mutator, Mutate(NotNull(), 5)) .WillOnce(SetArrayArgument<0>(values, values + 5)); ``` This also works when the argument is an output iterator: ``` using ::testing::_; using ::testing::SeArrayArgument; class MockRolodex : public Rolodex { public: MOCK_METHOD1(GetNames, void(std::back_insert_iterator >)); ... }; ... MockRolodex rolodex; vector names; names.push_back("George"); names.push_back("John"); names.push_back("Thomas"); EXPECT_CALL(rolodex, GetNames(_)) .WillOnce(SetArrayArgument<0>(names.begin(), names.end())); ``` ## Changing a Mock Object's Behavior Based on the State ## If you expect a call to change the behavior of a mock object, you can use `::testing::InSequence` to specify different behaviors before and after the call: ``` using ::testing::InSequence; using ::testing::Return; ... { InSequence seq; EXPECT_CALL(my_mock, IsDirty()) .WillRepeatedly(Return(true)); EXPECT_CALL(my_mock, Flush()); EXPECT_CALL(my_mock, IsDirty()) .WillRepeatedly(Return(false)); } my_mock.FlushIfDirty(); ``` This makes `my_mock.IsDirty()` return `true` before `my_mock.Flush()` is called and return `false` afterwards. If the behavior change is more complex, you can store the effects in a variable and make a mock method get its return value from that variable: ``` using ::testing::_; using ::testing::SaveArg; using ::testing::Return; ACTION_P(ReturnPointee, p) { return *p; } ... int previous_value = 0; EXPECT_CALL(my_mock, GetPrevValue()) .WillRepeatedly(ReturnPointee(&previous_value)); EXPECT_CALL(my_mock, UpdateValue(_)) .WillRepeatedly(SaveArg<0>(&previous_value)); my_mock.DoSomethingToUpdateValue(); ``` Here `my_mock.GetPrevValue()` will always return the argument of the last `UpdateValue()` call. ## Setting the Default Value for a Return Type ## If a mock method's return type is a built-in C++ type or pointer, by default it will return 0 when invoked. You only need to specify an action if this default value doesn't work for you. Sometimes, you may want to change this default value, or you may want to specify a default value for types Google Mock doesn't know about. You can do this using the `::testing::DefaultValue` class template: ``` class MockFoo : public Foo { public: MOCK_METHOD0(CalculateBar, Bar()); }; ... Bar default_bar; // Sets the default return value for type Bar. DefaultValue::Set(default_bar); MockFoo foo; // We don't need to specify an action here, as the default // return value works for us. EXPECT_CALL(foo, CalculateBar()); foo.CalculateBar(); // This should return default_bar. // Unsets the default return value. DefaultValue::Clear(); ``` Please note that changing the default value for a type can make you tests hard to understand. We recommend you to use this feature judiciously. For example, you may want to make sure the `Set()` and `Clear()` calls are right next to the code that uses your mock. ## Setting the Default Actions for a Mock Method ## You've learned how to change the default value of a given type. However, this may be too coarse for your purpose: perhaps you have two mock methods with the same return type and you want them to have different behaviors. The `ON_CALL()` macro allows you to customize your mock's behavior at the method level: ``` using ::testing::_; using ::testing::AnyNumber; using ::testing::Gt; using ::testing::Return; ... ON_CALL(foo, Sign(_)) .WillByDefault(Return(-1)); ON_CALL(foo, Sign(0)) .WillByDefault(Return(0)); ON_CALL(foo, Sign(Gt(0))) .WillByDefault(Return(1)); EXPECT_CALL(foo, Sign(_)) .Times(AnyNumber()); foo.Sign(5); // This should return 1. foo.Sign(-9); // This should return -1. foo.Sign(0); // This should return 0. ``` As you may have guessed, when there are more than one `ON_CALL()` statements, the news order take precedence over the older ones. In other words, the **last** one that matches the function arguments will be used. This matching order allows you to set up the common behavior in a mock object's constructor or the test fixture's set-up phase and specialize the mock's behavior later. ## Using Functions/Methods/Functors as Actions ## If the built-in actions don't suit you, you can easily use an existing function, method, or functor as an action: ``` using ::testing::_; using ::testing::Invoke; class MockFoo : public Foo { public: MOCK_METHOD2(Sum, int(int x, int y)); MOCK_METHOD1(ComplexJob, bool(int x)); }; int CalculateSum(int x, int y) { return x + y; } class Helper { public: bool ComplexJob(int x); }; ... MockFoo foo; Helper helper; EXPECT_CALL(foo, Sum(_, _)) .WillOnce(Invoke(CalculateSum)); EXPECT_CALL(foo, ComplexJob(_)) .WillOnce(Invoke(&helper, &Helper::ComplexJob)); foo.Sum(5, 6); // Invokes CalculateSum(5, 6). foo.ComplexJob(10); // Invokes helper.ComplexJob(10); ``` The only requirement is that the type of the function, etc must be _compatible_ with the signature of the mock function, meaning that the latter's arguments can be implicitly converted to the corresponding arguments of the former, and the former's return type can be implicitly converted to that of the latter. So, you can invoke something whose type is _not_ exactly the same as the mock function, as long as it's safe to do so - nice, huh? ## Invoking a Function/Method/Functor Without Arguments ## `Invoke()` is very useful for doing actions that are more complex. It passes the mock function's arguments to the function or functor being invoked such that the callee has the full context of the call to work with. If the invoked function is not interested in some or all of the arguments, it can simply ignore them. Yet, a common pattern is that a test author wants to invoke a function without the arguments of the mock function. `Invoke()` allows her to do that using a wrapper function that throws away the arguments before invoking an underlining nullary function. Needless to say, this can be tedious and obscures the intent of the test. `InvokeWithoutArgs()` solves this problem. It's like `Invoke()` except that it doesn't pass the mock function's arguments to the callee. Here's an example: ``` using ::testing::_; using ::testing::InvokeWithoutArgs; class MockFoo : public Foo { public: MOCK_METHOD1(ComplexJob, bool(int n)); }; bool Job1() { ... } ... MockFoo foo; EXPECT_CALL(foo, ComplexJob(_)) .WillOnce(InvokeWithoutArgs(Job1)); foo.ComplexJob(10); // Invokes Job1(). ``` ## Invoking an Argument of the Mock Function ## Sometimes a mock function will receive a function pointer or a functor (in other words, a "callable") as an argument, e.g. ``` class MockFoo : public Foo { public: MOCK_METHOD2(DoThis, bool(int n, bool (*fp)(int))); }; ``` and you may want to invoke this callable argument: ``` using ::testing::_; ... MockFoo foo; EXPECT_CALL(foo, DoThis(_, _)) .WillOnce(...); // Will execute (*fp)(5), where fp is the // second argument DoThis() receives. ``` Arghh, you need to refer to a mock function argument but C++ has no lambda (yet), so you have to define your own action. :-( Or do you really? Well, Google Mock has an action to solve _exactly_ this problem: ``` InvokeArgument(arg_1, arg_2, ..., arg_m) ``` will invoke the `N`-th (0-based) argument the mock function receives, with `arg_1`, `arg_2`, ..., and `arg_m`. No matter if the argument is a function pointer or a functor, Google Mock handles them both. With that, you could write: ``` using ::testing::_; using ::testing::InvokeArgument; ... EXPECT_CALL(foo, DoThis(_, _)) .WillOnce(InvokeArgument<1>(5)); // Will execute (*fp)(5), where fp is the // second argument DoThis() receives. ``` What if the callable takes an argument by reference? No problem - just wrap it inside `ByRef()`: ``` ... MOCK_METHOD1(Bar, bool(bool (*fp)(int, const Helper&))); ... using ::testing::_; using ::testing::ByRef; using ::testing::InvokeArgument; ... MockFoo foo; Helper helper; ... EXPECT_CALL(foo, Bar(_)) .WillOnce(InvokeArgument<0>(5, ByRef(helper))); // ByRef(helper) guarantees that a reference to helper, not a copy of it, // will be passed to the callable. ``` What if the callable takes an argument by reference and we do **not** wrap the argument in `ByRef()`? Then `InvokeArgument()` will _make a copy_ of the argument, and pass a _reference to the copy_, instead of a reference to the original value, to the callable. This is especially handy when the argument is a temporary value: ``` ... MOCK_METHOD1(DoThat, bool(bool (*f)(const double& x, const string& s))); ... using ::testing::_; using ::testing::InvokeArgument; ... MockFoo foo; ... EXPECT_CALL(foo, DoThat(_)) .WillOnce(InvokeArgument<0>(5.0, string("Hi"))); // Will execute (*f)(5.0, string("Hi")), where f is the function pointer // DoThat() receives. Note that the values 5.0 and string("Hi") are // temporary and dead once the EXPECT_CALL() statement finishes. Yet // it's fine to perform this action later, since a copy of the values // are kept inside the InvokeArgument action. ``` ## Ignoring an Action's Result ## Sometimes you have an action that returns _something_, but you need an action that returns `void` (perhaps you want to use it in a mock function that returns `void`, or perhaps it needs to be used in `DoAll()` and it's not the last in the list). `IgnoreResult()` lets you do that. For example: ``` using ::testing::_; using ::testing::Invoke; using ::testing::Return; int Process(const MyData& data); string DoSomething(); class MockFoo : public Foo { public: MOCK_METHOD1(Abc, void(const MyData& data)); MOCK_METHOD0(Xyz, bool()); }; ... MockFoo foo; EXPECT_CALL(foo, Abc(_)) // .WillOnce(Invoke(Process)); // The above line won't compile as Process() returns int but Abc() needs // to return void. .WillOnce(IgnoreResult(Invoke(Process))); EXPECT_CALL(foo, Xyz()) .WillOnce(DoAll(IgnoreResult(Invoke(DoSomething)), // Ignores the string DoSomething() returns. Return(true))); ``` Note that you **cannot** use `IgnoreResult()` on an action that already returns `void`. Doing so will lead to ugly compiler errors. ## Selecting an Action's Arguments ## Say you have a mock function `Foo()` that takes seven arguments, and you have a custom action that you want to invoke when `Foo()` is called. Trouble is, the custom action only wants three arguments: ``` using ::testing::_; using ::testing::Invoke; ... MOCK_METHOD7(Foo, bool(bool visible, const string& name, int x, int y, const map, double>& weight, double min_weight, double max_wight)); ... bool IsVisibleInQuadrant1(bool visible, int x, int y) { return visible && x >= 0 && y >= 0; } ... EXPECT_CALL(mock, Foo(_, _, _, _, _, _, _)) .WillOnce(Invoke(IsVisibleInQuadrant1)); // Uh, won't compile. :-( ``` To please the compiler God, you can to define an "adaptor" that has the same signature as `Foo()` and calls the custom action with the right arguments: ``` using ::testing::_; using ::testing::Invoke; bool MyIsVisibleInQuadrant1(bool visible, const string& name, int x, int y, const map, double>& weight, double min_weight, double max_wight) { return IsVisibleInQuadrant1(visible, x, y); } ... EXPECT_CALL(mock, Foo(_, _, _, _, _, _, _)) .WillOnce(Invoke(MyIsVisibleInQuadrant1)); // Now it works. ``` But isn't this awkward? Google Mock provides a generic _action adaptor_, so you can spend your time minding more important business than writing your own adaptors. Here's the syntax: ``` WithArgs(action) ``` creates an action that passes the arguments of the mock function at the given indices (0-based) to the inner `action` and performs it. Using `WithArgs`, our original example can be written as: ``` using ::testing::_; using ::testing::Invoke; using ::testing::WithArgs; ... EXPECT_CALL(mock, Foo(_, _, _, _, _, _, _)) .WillOnce(WithArgs<0, 2, 3>(Invoke(IsVisibleInQuadrant1))); // No need to define your own adaptor. ``` For better readability, Google Mock also gives you: * `WithoutArgs(action)` when the inner `action` takes _no_ argument, and * `WithArg(action)` (no `s` after `Arg`) when the inner `action` takes _one_ argument. As you may have realized, `InvokeWithoutArgs(...)` is just syntactic sugar for `WithoutArgs(Inovke(...))`. Here are more tips: * The inner action used in `WithArgs` and friends does not have to be `Invoke()` -- it can be anything. * You can repeat an argument in the argument list if necessary, e.g. `WithArgs<2, 3, 3, 5>(...)`. * You can change the order of the arguments, e.g. `WithArgs<3, 2, 1>(...)`. * The types of the selected arguments do _not_ have to match the signature of the inner action exactly. It works as long as they can be implicitly converted to the corresponding arguments of the inner action. For example, if the 4-th argument of the mock function is an `int` and `my_action` takes a `double`, `WithArg<4>(my_action)` will work. ## Ignoring Arguments in Action Functions ## The selecting-an-action's-arguments recipe showed us one way to make a mock function and an action with incompatible argument lists fit together. The downside is that wrapping the action in `WithArgs<...>()` can get tedious for people writing the tests. If you are defining a function, method, or functor to be used with `Invoke*()`, and you are not interested in some of its arguments, an alternative to `WithArgs` is to declare the uninteresting arguments as `Unused`. This makes the definition less cluttered and less fragile in case the types of the uninteresting arguments change. It could also increase the chance the action function can be reused. For example, given ``` MOCK_METHOD3(Foo, double(const string& label, double x, double y)); MOCK_METHOD3(Bar, double(int index, double x, double y)); ``` instead of ``` using ::testing::_; using ::testing::Invoke; double DistanceToOriginWithLabel(const string& label, double x, double y) { return sqrt(x*x + y*y); } double DistanceToOriginWithIndex(int index, double x, double y) { return sqrt(x*x + y*y); } ... EXEPCT_CALL(mock, Foo("abc", _, _)) .WillOnce(Invoke(DistanceToOriginWithLabel)); EXEPCT_CALL(mock, Bar(5, _, _)) .WillOnce(Invoke(DistanceToOriginWithIndex)); ``` you could write ``` using ::testing::_; using ::testing::Invoke; using ::testing::Unused; double DistanceToOrigin(Unused, double x, double y) { return sqrt(x*x + y*y); } ... EXEPCT_CALL(mock, Foo("abc", _, _)) .WillOnce(Invoke(DistanceToOrigin)); EXEPCT_CALL(mock, Bar(5, _, _)) .WillOnce(Invoke(DistanceToOrigin)); ``` ## Sharing Actions ## Just like matchers, a Google Mock action object consists of a pointer to a ref-counted implementation object. Therefore copying actions is also allowed and very efficient. When the last action that references the implementation object dies, the implementation object will be deleted. If you have some complex action that you want to use again and again, you may not have to build it from scratch everytime. If the action doesn't have an internal state (i.e. if it always does the same thing no matter how many times it has been called), you can assign it to an action variable and use that variable repeatedly. For example: ``` Action set_flag = DoAll(SetArgPointee<0>(5), Return(true)); ... use set_flag in .WillOnce() and .WillRepeatedly() ... ``` However, if the action has its own state, you may be surprised if you share the action object. Suppose you have an action factory `IncrementCounter(init)` which creates an action that increments and returns a counter whose initial value is `init`, using two actions created from the same expression and using a shared action will exihibit different behaviors. Example: ``` EXPECT_CALL(foo, DoThis()) .WillRepeatedly(IncrementCounter(0)); EXPECT_CALL(foo, DoThat()) .WillRepeatedly(IncrementCounter(0)); foo.DoThis(); // Returns 1. foo.DoThis(); // Returns 2. foo.DoThat(); // Returns 1 - Blah() uses a different // counter than Bar()'s. ``` versus ``` Action increment = IncrementCounter(0); EXPECT_CALL(foo, DoThis()) .WillRepeatedly(increment); EXPECT_CALL(foo, DoThat()) .WillRepeatedly(increment); foo.DoThis(); // Returns 1. foo.DoThis(); // Returns 2. foo.DoThat(); // Returns 3 - the counter is shared. ``` # Misc Recipes on Using Google Mock # ## Making the Compilation Faster ## Believe it or not, the _vast majority_ of the time spent on compiling a mock class is in generating its constructor and destructor, as they perform non-trivial tasks (e.g. verification of the expectations). What's more, mock methods with different signatures have different types and thus their constructors/destructors need to be generated by the compiler separately. As a result, if you mock many different types of methods, compiling your mock class can get really slow. If you are experiencing slow compilation, you can move the definition of your mock class' constructor and destructor out of the class body and into a `.cpp` file. This way, even if you `#include` your mock class in N files, the compiler only needs to generate its constructor and destructor once, resulting in a much faster compilation. Let's illustrate the idea using an example. Here's the definition of a mock class before applying this recipe: ``` // File mock_foo.h. ... class MockFoo : public Foo { public: // Since we don't declare the constructor or the destructor, // the compiler will generate them in every translation unit // where this mock class is used. MOCK_METHOD0(DoThis, int()); MOCK_METHOD1(DoThat, bool(const char* str)); ... more mock methods ... }; ``` After the change, it would look like: ``` // File mock_foo.h. ... class MockFoo : public Foo { public: // The constructor and destructor are declared, but not defined, here. MockFoo(); virtual ~MockFoo(); MOCK_METHOD0(DoThis, int()); MOCK_METHOD1(DoThat, bool(const char* str)); ... more mock methods ... }; ``` and ``` // File mock_foo.cpp. #include "path/to/mock_foo.h" // The definitions may appear trivial, but the functions actually do a // lot of things through the constructors/destructors of the member // variables used to implement the mock methods. MockFoo::MockFoo() {} MockFoo::~MockFoo() {} ``` ## Forcing a Verification ## When it's being destoyed, your friendly mock object will automatically verify that all expectations on it have been satisfied, and will generate [Google Test](http://code.google.com/p/googletest/) failures if not. This is convenient as it leaves you with one less thing to worry about. That is, unless you are not sure if your mock object will be destoyed. How could it be that your mock object won't eventually be destroyed? Well, it might be created on the heap and owned by the code you are testing. Suppose there's a bug in that code and it doesn't delete the mock object properly - you could end up with a passing test when there's actually a bug. Using a heap checker is a good idea and can alleviate the concern, but its implementation may not be 100% reliable. So, sometimes you do want to _force_ Google Mock to verify a mock object before it is (hopefully) destructed. You can do this with `Mock::VerifyAndClearExpectations(&mock_object)`: ``` TEST(MyServerTest, ProcessesRequest) { using ::testing::Mock; MockFoo* const foo = new MockFoo; EXPECT_CALL(*foo, ...)...; // ... other expectations ... // server now owns foo. MyServer server(foo); server.ProcessRequest(...); // In case that server's destructor will forget to delete foo, // this will verify the expectations anyway. Mock::VerifyAndClearExpectations(foo); } // server is destroyed when it goes out of scope here. ``` **Tip:** The `Mock::VerifyAndClearExpectations()` function returns a `bool` to indicate whether the verification was successful (`true` for yes), so you can wrap that function call inside a `ASSERT_TRUE()` if there is no point going further when the verification has failed. ## Using Check Points ## Sometimes you may want to "reset" a mock object at various check points in your test: at each check point, you verify that all existing expectations on the mock object have been satisfied, and then you set some new expectations on it as if it's newly created. This allows you to work with a mock object in "phases" whose sizes are each manageable. One such scenario is that in your test's `SetUp()` function, you may want to put the object you are testing into a certain state, with the help from a mock object. Once in the desired state, you want to clear all expectations on the mock, such that in the `TEST_F` body you can set fresh expectations on it. As you may have figured out, the `Mock::VerifyAndClearExpectations()` function we saw in the previous recipe can help you here. Or, if you are using `ON_CALL()` to set default actions on the mock object and want to clear the default actions as well, use `Mock::VerifyAndClear(&mock_object)` instead. This function does what `Mock::VerifyAndClearExpectations(&mock_object)` does and returns the same `bool`, **plus** it clears the `ON_CALL()` statements on `mock_object` too. Another trick you can use to achieve the same effect is to put the expectations in sequences and insert calls to a dummy "check-point" function at specific places. Then you can verify that the mock function calls do happen at the right time. For example, if you are exercising code: ``` Foo(1); Foo(2); Foo(3); ``` and want to verify that `Foo(1)` and `Foo(3)` both invoke `mock.Bar("a")`, but `Foo(2)` doesn't invoke anything. You can write: ``` using ::testing::MockFunction; TEST(FooTest, InvokesBarCorrectly) { MyMock mock; // Class MockFunction has exactly one mock method. It is named // Call() and has type F. MockFunction check; { InSequence s; EXPECT_CALL(mock, Bar("a")); EXPECT_CALL(check, Call("1")); EXPECT_CALL(check, Call("2")); EXPECT_CALL(mock, Bar("a")); } Foo(1); check.Call("1"); Foo(2); check.Call("2"); Foo(3); } ``` The expectation spec says that the first `Bar("a")` must happen before check point "1", the second `Bar("a")` must happen after check point "2", and nothing should happen between the two check points. The explicit check points make it easy to tell which `Bar("a")` is called by which call to `Foo()`. ## Mocking Destructors ## Sometimes you want to make sure a mock object is destructed at the right time, e.g. after `bar->A()` is called but before `bar->B()` is called. We already know that you can specify constraints on the order of mock function calls, so all we need to do is to mock the destructor of the mock function. This sounds simple, except for one problem: a destructor is a special function with special syntax and special semantics, and the `MOCK_METHOD0` macro doesn't work for it: ``` MOCK_METHOD0(~MockFoo, void()); // Won't compile! ``` The good news is that you can use a simple pattern to achieve the same effect. First, add a mock function `Die()` to your mock class and call it in the destructor, like this: ``` class MockFoo : public Foo { ... // Add the following two lines to the mock class. MOCK_METHOD0(Die, void()); virtual ~MockFoo() { Die(); } }; ``` (If the name `Die()` clashes with an existing symbol, choose another name.) Now, we have translated the problem of testing when a `MockFoo` object dies to testing when its `Die()` method is called: ``` MockFoo* foo = new MockFoo; MockBar* bar = new MockBar; ... { InSequence s; // Expects *foo to die after bar->A() and before bar->B(). EXPECT_CALL(*bar, A()); EXPECT_CALL(*foo, Die()); EXPECT_CALL(*bar, B()); } ``` And that's that. ## Using Google Mock and Threads ## **IMPORTANT NOTE:** What we describe in this recipe is **ONLY** true on platforms where Google Mock is thread-safe. Currently these are only platforms that support the pthreads library (this includes Linux and Mac). To make it thread-safe on other platforms we only need to implement some synchronization operations in `"gtest/internal/gtest-port.h"`. In a **unit** test, it's best if you could isolate and test a piece of code in a single-threaded context. That avoids race conditions and dead locks, and makes debugging your test much easier. Yet many programs are multi-threaded, and sometimes to test something we need to pound on it from more than one thread. Google Mock works for this purpose too. Remember the steps for using a mock: 1. Create a mock object `foo`. 1. Set its default actions and expectations using `ON_CALL()` and `EXPECT_CALL()`. 1. The code under test calls methods of `foo`. 1. Optionally, verify and reset the mock. 1. Destroy the mock yourself, or let the code under test destroy it. The destructor will automatically verify it. If you follow the following simple rules, your mocks and threads can live happily togeter: * Execute your _test code_ (as opposed to the code being tested) in _one_ thread. This makes your test easy to follow. * Obviously, you can do step #1 without locking. * When doing step #2 and #5, make sure no other thread is accessing `foo`. Obvious too, huh? * #3 and #4 can be done either in one thread or in multiple threads - anyway you want. Google Mock takes care of the locking, so you don't have to do any - unless required by your test logic. If you violate the rules (for example, if you set expectations on a mock while another thread is calling its methods), you get undefined behavior. That's not fun, so don't do it. Google Mock guarantees that the action for a mock function is done in the same thread that called the mock function. For example, in ``` EXPECT_CALL(mock, Foo(1)) .WillOnce(action1); EXPECT_CALL(mock, Foo(2)) .WillOnce(action2); ``` if `Foo(1)` is called in thread 1 and `Foo(2)` is called in thread 2, Google Mock will execute `action1` in thread 1 and `action2` in thread 2. Google Mock does _not_ impose a sequence on actions performed in different threads (doing so may create deadlocks as the actions may need to cooperate). This means that the execution of `action1` and `action2` in the above example _may_ interleave. If this is a problem, you should add proper synchronization logic to `action1` and `action2` to make the test thread-safe. Also, remember that `DefaultValue` is a global resource that potentially affects _all_ living mock objects in your program. Naturally, you won't want to mess with it from multiple threads or when there still are mocks in action. ## Controlling How Much Information Google Mock Prints ## When Google Mock sees something that has the potential of being an error (e.g. a mock function with no expectation is called, a.k.a. an uninteresting call, which is allowed but perhaps you forgot to explicitly ban the call), it prints some warning messages, including the arguments of the function and the return value. Hopefully this will remind you to take a look and see if there is indeed a problem. Sometimes you are confident that your tests are correct and may not appreciate such friendly messages. Some other times, you are debugging your tests or learning about the behavior of the code you are testing, and wish you could observe every mock call that happens (including argument values and the return value). Clearly, one size doesn't fit all. You can control how much Google Mock tells you using the `--gmock_verbose=LEVEL` command-line flag, where `LEVEL` is a string with three possible values: * `info`: Google Mock will print all informational messages, warnings, and errors (most verbose). At this setting, Google Mock will also log any calls to the `ON_CALL/EXPECT_CALL` macros. * `warning`: Google Mock will print both warnings and errors (less verbose). This is the default. * `error`: Google Mock will print errors only (least verbose). Alternatively, you can adjust the value of that flag from within your tests like so: ``` ::testing::FLAGS_gmock_verbose = "error"; ``` Now, judiciously use the right flag to enable Google Mock serve you better! ## Running Tests in Emacs ## If you build and run your tests in Emacs, the source file locations of Google Mock and [Google Test](http://code.google.com/p/googletest/) errors will be highlighted. Just press `` on one of them and you'll be taken to the offending line. Or, you can just type `C-x `` to jump to the next error. To make it even easier, you can add the following lines to your `~/.emacs` file: ``` (global-set-key "\M-m" 'compile) ; m is for make (global-set-key [M-down] 'next-error) (global-set-key [M-up] '(lambda () (interactive) (next-error -1))) ``` Then you can type `M-m` to start a build, or `M-up`/`M-down` to move back and forth between errors. ## Fusing Google Mock Source Files ## Google Mock's implementation consists of dozens of files (excluding its own tests). Sometimes you may want them to be packaged up in fewer files instead, such that you can easily copy them to a new machine and start hacking there. For this we provide an experimental Python script `fuse_gmock_files.py` in the `scripts/` directory (starting with release 1.2.0). Assuming you have Python 2.4 or above installed on your machine, just go to that directory and run ``` python fuse_gmock_files.py OUTPUT_DIR ``` and you should see an `OUTPUT_DIR` directory being created with files `gtest/gtest.h`, `gmock/gmock.h`, and `gmock-gtest-all.cc` in it. These three files contain everything you need to use Google Mock (and Google Test). Just copy them to anywhere you want and you are ready to write tests and use mocks. You can use the [scrpts/test/Makefile](http://code.google.com/p/googlemock/source/browse/trunk/scripts/test/Makefile) file as an example on how to compile your tests against them. # Extending Google Mock # ## Writing New Matchers Quickly ## The `MATCHER*` family of macros can be used to define custom matchers easily. The syntax: ``` MATCHER(name, description_string_expression) { statements; } ``` will define a matcher with the given name that executes the statements, which must return a `bool` to indicate if the match succeeds. Inside the statements, you can refer to the value being matched by `arg`, and refer to its type by `arg_type`. The description string is a `string`-typed expression that documents what the matcher does, and is used to generate the failure message when the match fails. It can (and should) reference the special `bool` variable `negation`, and should evaluate to the description of the matcher when `negation` is `false`, or that of the matcher's negation when `negation` is `true`. For convenience, we allow the description string to be empty (`""`), in which case Google Mock will use the sequence of words in the matcher name as the description. For example: ``` MATCHER(IsDivisibleBy7, "") { return (arg % 7) == 0; } ``` allows you to write ``` // Expects mock_foo.Bar(n) to be called where n is divisible by 7. EXPECT_CALL(mock_foo, Bar(IsDivisibleBy7())); ``` or, ``` using ::testing::Not; ... EXPECT_THAT(some_expression, IsDivisibleBy7()); EXPECT_THAT(some_other_expression, Not(IsDivisibleBy7())); ``` If the above assertions fail, they will print something like: ``` Value of: some_expression Expected: is divisible by 7 Actual: 27 ... Value of: some_other_expression Expected: not (is divisible by 7) Actual: 21 ``` where the descriptions `"is divisible by 7"` and `"not (is divisible by 7)"` are automatically calculated from the matcher name `IsDivisibleBy7`. As you may have noticed, the auto-generated descriptions (especially those for the negation) may not be so great. You can always override them with a string expression of your own: ``` MATCHER(IsDivisibleBy7, std::string(negation ? "isn't" : "is") + " divisible by 7") { return (arg % 7) == 0; } ``` Optionally, you can stream additional information to a hidden argument named `result_listener` to explain the match result. For example, a better definition of `IsDivisibleBy7` is: ``` MATCHER(IsDivisibleBy7, "") { if ((arg % 7) == 0) return true; *result_listener << "the remainder is " << (arg % 7); return false; } ``` With this definition, the above assertion will give a better message: ``` Value of: some_expression Expected: is divisible by 7 Actual: 27 (the remainder is 6) ``` You should let `MatchAndExplain()` print _any additional information_ that can help a user understand the match result. Note that it should explain why the match succeeds in case of a success (unless it's obvious) - this is useful when the matcher is used inside `Not()`. There is no need to print the argument value itself, as Google Mock already prints it for you. **Notes:** 1. The type of the value being matched (`arg_type`) is determined by the context in which you use the matcher and is supplied to you by the compiler, so you don't need to worry about declaring it (nor can you). This allows the matcher to be polymorphic. For example, `IsDivisibleBy7()` can be used to match any type where the value of `(arg % 7) == 0` can be implicitly converted to a `bool`. In the `Bar(IsDivisibleBy7())` example above, if method `Bar()` takes an `int`, `arg_type` will be `int`; if it takes an `unsigned long`, `arg_type` will be `unsigned long`; and so on. 1. Google Mock doesn't guarantee when or how many times a matcher will be invoked. Therefore the matcher logic must be _purely functional_ (i.e. it cannot have any side effect, and the result must not depend on anything other than the value being matched and the matcher parameters). This requirement must be satisfied no matter how you define the matcher (e.g. using one of the methods described in the following recipes). In particular, a matcher can never call a mock function, as that will affect the state of the mock object and Google Mock. ## Writing New Parameterized Matchers Quickly ## Sometimes you'll want to define a matcher that has parameters. For that you can use the macro: ``` MATCHER_P(name, param_name, description_string) { statements; } ``` where the description string can be either `""` or a string expression that references `negation` and `param_name`. For example: ``` MATCHER_P(HasAbsoluteValue, value, "") { return abs(arg) == value; } ``` will allow you to write: ``` EXPECT_THAT(Blah("a"), HasAbsoluteValue(n)); ``` which may lead to this message (assuming `n` is 10): ``` Value of: Blah("a") Expected: has absolute value 10 Actual: -9 ``` Note that both the matcher description and its parameter are printed, making the message human-friendly. In the matcher definition body, you can write `foo_type` to reference the type of a parameter named `foo`. For example, in the body of `MATCHER_P(HasAbsoluteValue, value)` above, you can write `value_type` to refer to the type of `value`. Google Mock also provides `MATCHER_P2`, `MATCHER_P3`, ..., up to `MATCHER_P10` to support multi-parameter matchers: ``` MATCHER_Pk(name, param_1, ..., param_k, description_string) { statements; } ``` Please note that the custom description string is for a particular **instance** of the matcher, where the parameters have been bound to actual values. Therefore usually you'll want the parameter values to be part of the description. Google Mock lets you do that by referencing the matcher parameters in the description string expression. For example, ``` using ::testing::PrintToString; MATCHER_P2(InClosedRange, low, hi, std::string(negation ? "isn't" : "is") + " in range [" + PrintToString(low) + ", " + PrintToString(hi) + "]") { return low <= arg && arg <= hi; } ... EXPECT_THAT(3, InClosedRange(4, 6)); ``` would generate a failure that contains the message: ``` Expected: is in range [4, 6] ``` If you specify `""` as the description, the failure message will contain the sequence of words in the matcher name followed by the parameter values printed as a tuple. For example, ``` MATCHER_P2(InClosedRange, low, hi, "") { ... } ... EXPECT_THAT(3, InClosedRange(4, 6)); ``` would generate a failure that contains the text: ``` Expected: in closed range (4, 6) ``` For the purpose of typing, you can view ``` MATCHER_Pk(Foo, p1, ..., pk, description_string) { ... } ``` as shorthand for ``` template FooMatcherPk Foo(p1_type p1, ..., pk_type pk) { ... } ``` When you write `Foo(v1, ..., vk)`, the compiler infers the types of the parameters `v1`, ..., and `vk` for you. If you are not happy with the result of the type inference, you can specify the types by explicitly instantiating the template, as in `Foo(5, false)`. As said earlier, you don't get to (or need to) specify `arg_type` as that's determined by the context in which the matcher is used. You can assign the result of expression `Foo(p1, ..., pk)` to a variable of type `FooMatcherPk`. This can be useful when composing matchers. Matchers that don't have a parameter or have only one parameter have special types: you can assign `Foo()` to a `FooMatcher`-typed variable, and assign `Foo(p)` to a `FooMatcherP`-typed variable. While you can instantiate a matcher template with reference types, passing the parameters by pointer usually makes your code more readable. If, however, you still want to pass a parameter by reference, be aware that in the failure message generated by the matcher you will see the value of the referenced object but not its address. You can overload matchers with different numbers of parameters: ``` MATCHER_P(Blah, a, description_string_1) { ... } MATCHER_P2(Blah, a, b, description_string_2) { ... } ``` While it's tempting to always use the `MATCHER*` macros when defining a new matcher, you should also consider implementing `MatcherInterface` or using `MakePolymorphicMatcher()` instead (see the recipes that follow), especially if you need to use the matcher a lot. While these approaches require more work, they give you more control on the types of the value being matched and the matcher parameters, which in general leads to better compiler error messages that pay off in the long run. They also allow overloading matchers based on parameter types (as opposed to just based on the number of parameters). ## Writing New Monomorphic Matchers ## A matcher of argument type `T` implements `::testing::MatcherInterface` and does two things: it tests whether a value of type `T` matches the matcher, and can describe what kind of values it matches. The latter ability is used for generating readable error messages when expectations are violated. The interface looks like this: ``` class MatchResultListener { public: ... // Streams x to the underlying ostream; does nothing if the ostream // is NULL. template MatchResultListener& operator<<(const T& x); // Returns the underlying ostream. ::std::ostream* stream(); }; template class MatcherInterface { public: virtual ~MatcherInterface(); // Returns true iff the matcher matches x; also explains the match // result to 'listener'. virtual bool MatchAndExplain(T x, MatchResultListener* listener) const = 0; // Describes this matcher to an ostream. virtual void DescribeTo(::std::ostream* os) const = 0; // Describes the negation of this matcher to an ostream. virtual void DescribeNegationTo(::std::ostream* os) const; }; ``` If you need a custom matcher but `Truly()` is not a good option (for example, you may not be happy with the way `Truly(predicate)` describes itself, or you may want your matcher to be polymorphic as `Eq(value)` is), you can define a matcher to do whatever you want in two steps: first implement the matcher interface, and then define a factory function to create a matcher instance. The second step is not strictly needed but it makes the syntax of using the matcher nicer. For example, you can define a matcher to test whether an `int` is divisible by 7 and then use it like this: ``` using ::testing::MakeMatcher; using ::testing::Matcher; using ::testing::MatcherInterface; using ::testing::MatchResultListener; class DivisibleBy7Matcher : public MatcherInterface { public: virtual bool MatchAndExplain(int n, MatchResultListener* listener) const { return (n % 7) == 0; } virtual void DescribeTo(::std::ostream* os) const { *os << "is divisible by 7"; } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "is not divisible by 7"; } }; inline Matcher DivisibleBy7() { return MakeMatcher(new DivisibleBy7Matcher); } ... EXPECT_CALL(foo, Bar(DivisibleBy7())); ``` You may improve the matcher message by streaming additional information to the `listener` argument in `MatchAndExplain()`: ``` class DivisibleBy7Matcher : public MatcherInterface { public: virtual bool MatchAndExplain(int n, MatchResultListener* listener) const { const int remainder = n % 7; if (remainder != 0) { *listener << "the remainder is " << remainder; } return remainder == 0; } ... }; ``` Then, `EXPECT_THAT(x, DivisibleBy7());` may general a message like this: ``` Value of: x Expected: is divisible by 7 Actual: 23 (the remainder is 2) ``` ## Writing New Polymorphic Matchers ## You've learned how to write your own matchers in the previous recipe. Just one problem: a matcher created using `MakeMatcher()` only works for one particular type of arguments. If you want a _polymorphic_ matcher that works with arguments of several types (for instance, `Eq(x)` can be used to match a `value` as long as `value` == `x` compiles -- `value` and `x` don't have to share the same type), you can learn the trick from `"gmock/gmock-matchers.h"` but it's a bit involved. Fortunately, most of the time you can define a polymorphic matcher easily with the help of `MakePolymorphicMatcher()`. Here's how you can define `NotNull()` as an example: ``` using ::testing::MakePolymorphicMatcher; using ::testing::MatchResultListener; using ::testing::NotNull; using ::testing::PolymorphicMatcher; class NotNullMatcher { public: // To implement a polymorphic matcher, first define a COPYABLE class // that has three members MatchAndExplain(), DescribeTo(), and // DescribeNegationTo(), like the following. // In this example, we want to use NotNull() with any pointer, so // MatchAndExplain() accepts a pointer of any type as its first argument. // In general, you can define MatchAndExplain() as an ordinary method or // a method template, or even overload it. template bool MatchAndExplain(T* p, MatchResultListener* /* listener */) const { return p != NULL; } // Describes the property of a value matching this matcher. void DescribeTo(::std::ostream* os) const { *os << "is not NULL"; } // Describes the property of a value NOT matching this matcher. void DescribeNegationTo(::std::ostream* os) const { *os << "is NULL"; } }; // To construct a polymorphic matcher, pass an instance of the class // to MakePolymorphicMatcher(). Note the return type. inline PolymorphicMatcher NotNull() { return MakePolymorphicMatcher(NotNullMatcher()); } ... EXPECT_CALL(foo, Bar(NotNull())); // The argument must be a non-NULL pointer. ``` **Note:** Your polymorphic matcher class does **not** need to inherit from `MatcherInterface` or any other class, and its methods do **not** need to be virtual. Like in a monomorphic matcher, you may explain the match result by streaming additional information to the `listener` argument in `MatchAndExplain()`. ## Writing New Cardinalities ## A cardinality is used in `Times()` to tell Google Mock how many times you expect a call to occur. It doesn't have to be exact. For example, you can say `AtLeast(5)` or `Between(2, 4)`. If the built-in set of cardinalities doesn't suit you, you are free to define your own by implementing the following interface (in namespace `testing`): ``` class CardinalityInterface { public: virtual ~CardinalityInterface(); // Returns true iff call_count calls will satisfy this cardinality. virtual bool IsSatisfiedByCallCount(int call_count) const = 0; // Returns true iff call_count calls will saturate this cardinality. virtual bool IsSaturatedByCallCount(int call_count) const = 0; // Describes self to an ostream. virtual void DescribeTo(::std::ostream* os) const = 0; }; ``` For example, to specify that a call must occur even number of times, you can write ``` using ::testing::Cardinality; using ::testing::CardinalityInterface; using ::testing::MakeCardinality; class EvenNumberCardinality : public CardinalityInterface { public: virtual bool IsSatisfiedByCallCount(int call_count) const { return (call_count % 2) == 0; } virtual bool IsSaturatedByCallCount(int call_count) const { return false; } virtual void DescribeTo(::std::ostream* os) const { *os << "called even number of times"; } }; Cardinality EvenNumber() { return MakeCardinality(new EvenNumberCardinality); } ... EXPECT_CALL(foo, Bar(3)) .Times(EvenNumber()); ``` ## Writing New Actions Quickly ## If the built-in actions don't work for you, and you find it inconvenient to use `Invoke()`, you can use a macro from the `ACTION*` family to quickly define a new action that can be used in your code as if it's a built-in action. By writing ``` ACTION(name) { statements; } ``` in a namespace scope (i.e. not inside a class or function), you will define an action with the given name that executes the statements. The value returned by `statements` will be used as the return value of the action. Inside the statements, you can refer to the K-th (0-based) argument of the mock function as `argK`. For example: ``` ACTION(IncrementArg1) { return ++(*arg1); } ``` allows you to write ``` ... WillOnce(IncrementArg1()); ``` Note that you don't need to specify the types of the mock function arguments. Rest assured that your code is type-safe though: you'll get a compiler error if `*arg1` doesn't support the `++` operator, or if the type of `++(*arg1)` isn't compatible with the mock function's return type. Another example: ``` ACTION(Foo) { (*arg2)(5); Blah(); *arg1 = 0; return arg0; } ``` defines an action `Foo()` that invokes argument #2 (a function pointer) with 5, calls function `Blah()`, sets the value pointed to by argument #1 to 0, and returns argument #0. For more convenience and flexibility, you can also use the following pre-defined symbols in the body of `ACTION`: | `argK_type` | The type of the K-th (0-based) argument of the mock function | |:------------|:-------------------------------------------------------------| | `args` | All arguments of the mock function as a tuple | | `args_type` | The type of all arguments of the mock function as a tuple | | `return_type` | The return type of the mock function | | `function_type` | The type of the mock function | For example, when using an `ACTION` as a stub action for mock function: ``` int DoSomething(bool flag, int* ptr); ``` we have: | **Pre-defined Symbol** | **Is Bound To** | |:-----------------------|:----------------| | `arg0` | the value of `flag` | | `arg0_type` | the type `bool` | | `arg1` | the value of `ptr` | | `arg1_type` | the type `int*` | | `args` | the tuple `(flag, ptr)` | | `args_type` | the type `std::tr1::tuple` | | `return_type` | the type `int` | | `function_type` | the type `int(bool, int*)` | ## Writing New Parameterized Actions Quickly ## Sometimes you'll want to parameterize an action you define. For that we have another macro ``` ACTION_P(name, param) { statements; } ``` For example, ``` ACTION_P(Add, n) { return arg0 + n; } ``` will allow you to write ``` // Returns argument #0 + 5. ... WillOnce(Add(5)); ``` For convenience, we use the term _arguments_ for the values used to invoke the mock function, and the term _parameters_ for the values used to instantiate an action. Note that you don't need to provide the type of the parameter either. Suppose the parameter is named `param`, you can also use the Google-Mock-defined symbol `param_type` to refer to the type of the parameter as inferred by the compiler. For example, in the body of `ACTION_P(Add, n)` above, you can write `n_type` for the type of `n`. Google Mock also provides `ACTION_P2`, `ACTION_P3`, and etc to support multi-parameter actions. For example, ``` ACTION_P2(ReturnDistanceTo, x, y) { double dx = arg0 - x; double dy = arg1 - y; return sqrt(dx*dx + dy*dy); } ``` lets you write ``` ... WillOnce(ReturnDistanceTo(5.0, 26.5)); ``` You can view `ACTION` as a degenerated parameterized action where the number of parameters is 0. You can also easily define actions overloaded on the number of parameters: ``` ACTION_P(Plus, a) { ... } ACTION_P2(Plus, a, b) { ... } ``` ## Restricting the Type of an Argument or Parameter in an ACTION ## For maximum brevity and reusability, the `ACTION*` macros don't ask you to provide the types of the mock function arguments and the action parameters. Instead, we let the compiler infer the types for us. Sometimes, however, we may want to be more explicit about the types. There are several tricks to do that. For example: ``` ACTION(Foo) { // Makes sure arg0 can be converted to int. int n = arg0; ... use n instead of arg0 here ... } ACTION_P(Bar, param) { // Makes sure the type of arg1 is const char*. ::testing::StaticAssertTypeEq(); // Makes sure param can be converted to bool. bool flag = param; } ``` where `StaticAssertTypeEq` is a compile-time assertion in Google Test that verifies two types are the same. ## Writing New Action Templates Quickly ## Sometimes you want to give an action explicit template parameters that cannot be inferred from its value parameters. `ACTION_TEMPLATE()` supports that and can be viewed as an extension to `ACTION()` and `ACTION_P*()`. The syntax: ``` ACTION_TEMPLATE(ActionName, HAS_m_TEMPLATE_PARAMS(kind1, name1, ..., kind_m, name_m), AND_n_VALUE_PARAMS(p1, ..., p_n)) { statements; } ``` defines an action template that takes _m_ explicit template parameters and _n_ value parameters, where _m_ is between 1 and 10, and _n_ is between 0 and 10. `name_i` is the name of the i-th template parameter, and `kind_i` specifies whether it's a `typename`, an integral constant, or a template. `p_i` is the name of the i-th value parameter. Example: ``` // DuplicateArg(output) converts the k-th argument of the mock // function to type T and copies it to *output. ACTION_TEMPLATE(DuplicateArg, // Note the comma between int and k: HAS_2_TEMPLATE_PARAMS(int, k, typename, T), AND_1_VALUE_PARAMS(output)) { *output = T(std::tr1::get(args)); } ``` To create an instance of an action template, write: ``` ActionName(v1, ..., v_n) ``` where the `t`s are the template arguments and the `v`s are the value arguments. The value argument types are inferred by the compiler. For example: ``` using ::testing::_; ... int n; EXPECT_CALL(mock, Foo(_, _)) .WillOnce(DuplicateArg<1, unsigned char>(&n)); ``` If you want to explicitly specify the value argument types, you can provide additional template arguments: ``` ActionName(v1, ..., v_n) ``` where `u_i` is the desired type of `v_i`. `ACTION_TEMPLATE` and `ACTION`/`ACTION_P*` can be overloaded on the number of value parameters, but not on the number of template parameters. Without the restriction, the meaning of the following is unclear: ``` OverloadedAction(x); ``` Are we using a single-template-parameter action where `bool` refers to the type of `x`, or a two-template-parameter action where the compiler is asked to infer the type of `x`? ## Using the ACTION Object's Type ## If you are writing a function that returns an `ACTION` object, you'll need to know its type. The type depends on the macro used to define the action and the parameter types. The rule is relatively simple: | **Given Definition** | **Expression** | **Has Type** | |:---------------------|:---------------|:-------------| | `ACTION(Foo)` | `Foo()` | `FooAction` | | `ACTION_TEMPLATE(Foo, HAS_m_TEMPLATE_PARAMS(...), AND_0_VALUE_PARAMS())` | `Foo()` | `FooAction` | | `ACTION_P(Bar, param)` | `Bar(int_value)` | `BarActionP` | | `ACTION_TEMPLATE(Bar, HAS_m_TEMPLATE_PARAMS(...), AND_1_VALUE_PARAMS(p1))` | `Bar(int_value)` | `FooActionP` | | `ACTION_P2(Baz, p1, p2)` | `Baz(bool_value, int_value)` | `BazActionP2` | | `ACTION_TEMPLATE(Baz, HAS_m_TEMPLATE_PARAMS(...), AND_2_VALUE_PARAMS(p1, p2))` | `Baz(bool_value, int_value)` | `FooActionP2` | | ... | ... | ... | Note that we have to pick different suffixes (`Action`, `ActionP`, `ActionP2`, and etc) for actions with different numbers of value parameters, or the action definitions cannot be overloaded on the number of them. ## Writing New Monomorphic Actions ## While the `ACTION*` macros are very convenient, sometimes they are inappropriate. For example, despite the tricks shown in the previous recipes, they don't let you directly specify the types of the mock function arguments and the action parameters, which in general leads to unoptimized compiler error messages that can baffle unfamiliar users. They also don't allow overloading actions based on parameter types without jumping through some hoops. An alternative to the `ACTION*` macros is to implement `::testing::ActionInterface`, where `F` is the type of the mock function in which the action will be used. For example: ``` template class ActionInterface { public: virtual ~ActionInterface(); // Performs the action. Result is the return type of function type // F, and ArgumentTuple is the tuple of arguments of F. // // For example, if F is int(bool, const string&), then Result would // be int, and ArgumentTuple would be tr1::tuple. virtual Result Perform(const ArgumentTuple& args) = 0; }; using ::testing::_; using ::testing::Action; using ::testing::ActionInterface; using ::testing::MakeAction; typedef int IncrementMethod(int*); class IncrementArgumentAction : public ActionInterface { public: virtual int Perform(const tr1::tuple& args) { int* p = tr1::get<0>(args); // Grabs the first argument. return *p++; } }; Action IncrementArgument() { return MakeAction(new IncrementArgumentAction); } ... EXPECT_CALL(foo, Baz(_)) .WillOnce(IncrementArgument()); int n = 5; foo.Baz(&n); // Should return 5 and change n to 6. ``` ## Writing New Polymorphic Actions ## The previous recipe showed you how to define your own action. This is all good, except that you need to know the type of the function in which the action will be used. Sometimes that can be a problem. For example, if you want to use the action in functions with _different_ types (e.g. like `Return()` and `SetArgPointee()`). If an action can be used in several types of mock functions, we say it's _polymorphic_. The `MakePolymorphicAction()` function template makes it easy to define such an action: ``` namespace testing { template PolymorphicAction MakePolymorphicAction(const Impl& impl); } // namespace testing ``` As an example, let's define an action that returns the second argument in the mock function's argument list. The first step is to define an implementation class: ``` class ReturnSecondArgumentAction { public: template Result Perform(const ArgumentTuple& args) const { // To get the i-th (0-based) argument, use tr1::get(args). return tr1::get<1>(args); } }; ``` This implementation class does _not_ need to inherit from any particular class. What matters is that it must have a `Perform()` method template. This method template takes the mock function's arguments as a tuple in a **single** argument, and returns the result of the action. It can be either `const` or not, but must be invokable with exactly one template argument, which is the result type. In other words, you must be able to call `Perform(args)` where `R` is the mock function's return type and `args` is its arguments in a tuple. Next, we use `MakePolymorphicAction()` to turn an instance of the implementation class into the polymorphic action we need. It will be convenient to have a wrapper for this: ``` using ::testing::MakePolymorphicAction; using ::testing::PolymorphicAction; PolymorphicAction ReturnSecondArgument() { return MakePolymorphicAction(ReturnSecondArgumentAction()); } ``` Now, you can use this polymorphic action the same way you use the built-in ones: ``` using ::testing::_; class MockFoo : public Foo { public: MOCK_METHOD2(DoThis, int(bool flag, int n)); MOCK_METHOD3(DoThat, string(int x, const char* str1, const char* str2)); }; ... MockFoo foo; EXPECT_CALL(foo, DoThis(_, _)) .WillOnce(ReturnSecondArgument()); EXPECT_CALL(foo, DoThat(_, _, _)) .WillOnce(ReturnSecondArgument()); ... foo.DoThis(true, 5); // Will return 5. foo.DoThat(1, "Hi", "Bye"); // Will return "Hi". ``` ## Teaching Google Mock How to Print Your Values ## When an uninteresting or unexpected call occurs, Google Mock prints the argument values and the stack trace to help you debug. Assertion macros like `EXPECT_THAT` and `EXPECT_EQ` also print the values in question when the assertion fails. Google Mock and Google Test do this using Google Test's user-extensible value printer. This printer knows how to print built-in C++ types, native arrays, STL containers, and any type that supports the `<<` operator. For other types, it prints the raw bytes in the value and hopes that you the user can figure it out. [Google Test's advanced guide](http://code.google.com/p/googletest/wiki/V1_6_AdvancedGuide#Teaching_Google_Test_How_to_Print_Your_Values) explains how to extend the printer to do a better job at printing your particular type than to dump the bytes.vendor/googletest/gtest-1.7.0/googlemock/docs/v1_6/Documentation.md000066400000000000000000000014251300002025200252640ustar00rootroot00000000000000This page lists all documentation wiki pages for Google Mock **1.6** - **if you use a released version of Google Mock, please read the documentation for that specific version instead.** * [ForDummies](V1_6_ForDummies.md) -- start here if you are new to Google Mock. * [CheatSheet](V1_6_CheatSheet.md) -- a quick reference. * [CookBook](V1_6_CookBook.md) -- recipes for doing various tasks using Google Mock. * [FrequentlyAskedQuestions](V1_6_FrequentlyAskedQuestions.md) -- check here before asking a question on the mailing list. To contribute code to Google Mock, read: * [DevGuide](DevGuide.md) -- read this _before_ writing your first patch. * [Pump Manual](http://code.google.com/p/googletest/wiki/V1_6_PumpManual) -- how we generate some of Google Mock's source files.vendor/googletest/gtest-1.7.0/googlemock/docs/v1_6/ForDummies.md000066400000000000000000000726321300002025200245350ustar00rootroot00000000000000 (**Note:** If you get compiler errors that you don't understand, be sure to consult [Google Mock Doctor](http://code.google.com/p/googlemock/wiki/V1_6_FrequentlyAskedQuestions#How_am_I_supposed_to_make_sense_of_these_horrible_template_error).) # What Is Google C++ Mocking Framework? # When you write a prototype or test, often it's not feasible or wise to rely on real objects entirely. A **mock object** implements the same interface as a real object (so it can be used as one), but lets you specify at run time how it will be used and what it should do (which methods will be called? in which order? how many times? with what arguments? what will they return? etc). **Note:** It is easy to confuse the term _fake objects_ with mock objects. Fakes and mocks actually mean very different things in the Test-Driven Development (TDD) community: * **Fake** objects have working implementations, but usually take some shortcut (perhaps to make the operations less expensive), which makes them not suitable for production. An in-memory file system would be an example of a fake. * **Mocks** are objects pre-programmed with _expectations_, which form a specification of the calls they are expected to receive. If all this seems too abstract for you, don't worry - the most important thing to remember is that a mock allows you to check the _interaction_ between itself and code that uses it. The difference between fakes and mocks will become much clearer once you start to use mocks. **Google C++ Mocking Framework** (or **Google Mock** for short) is a library (sometimes we also call it a "framework" to make it sound cool) for creating mock classes and using them. It does to C++ what [jMock](http://www.jmock.org/) and [EasyMock](http://www.easymock.org/) do to Java. Using Google Mock involves three basic steps: 1. Use some simple macros to describe the interface you want to mock, and they will expand to the implementation of your mock class; 1. Create some mock objects and specify its expectations and behavior using an intuitive syntax; 1. Exercise code that uses the mock objects. Google Mock will catch any violation of the expectations as soon as it arises. # Why Google Mock? # While mock objects help you remove unnecessary dependencies in tests and make them fast and reliable, using mocks manually in C++ is _hard_: * Someone has to implement the mocks. The job is usually tedious and error-prone. No wonder people go great distance to avoid it. * The quality of those manually written mocks is a bit, uh, unpredictable. You may see some really polished ones, but you may also see some that were hacked up in a hurry and have all sorts of ad hoc restrictions. * The knowledge you gained from using one mock doesn't transfer to the next. In contrast, Java and Python programmers have some fine mock frameworks, which automate the creation of mocks. As a result, mocking is a proven effective technique and widely adopted practice in those communities. Having the right tool absolutely makes the difference. Google Mock was built to help C++ programmers. It was inspired by [jMock](http://www.jmock.org/) and [EasyMock](http://www.easymock.org/), but designed with C++'s specifics in mind. It is your friend if any of the following problems is bothering you: * You are stuck with a sub-optimal design and wish you had done more prototyping before it was too late, but prototyping in C++ is by no means "rapid". * Your tests are slow as they depend on too many libraries or use expensive resources (e.g. a database). * Your tests are brittle as some resources they use are unreliable (e.g. the network). * You want to test how your code handles a failure (e.g. a file checksum error), but it's not easy to cause one. * You need to make sure that your module interacts with other modules in the right way, but it's hard to observe the interaction; therefore you resort to observing the side effects at the end of the action, which is awkward at best. * You want to "mock out" your dependencies, except that they don't have mock implementations yet; and, frankly, you aren't thrilled by some of those hand-written mocks. We encourage you to use Google Mock as: * a _design_ tool, for it lets you experiment with your interface design early and often. More iterations lead to better designs! * a _testing_ tool to cut your tests' outbound dependencies and probe the interaction between your module and its collaborators. # Getting Started # Using Google Mock is easy! Inside your C++ source file, just #include `"gtest/gtest.h"` and `"gmock/gmock.h"`, and you are ready to go. # A Case for Mock Turtles # Let's look at an example. Suppose you are developing a graphics program that relies on a LOGO-like API for drawing. How would you test that it does the right thing? Well, you can run it and compare the screen with a golden screen snapshot, but let's admit it: tests like this are expensive to run and fragile (What if you just upgraded to a shiny new graphics card that has better anti-aliasing? Suddenly you have to update all your golden images.). It would be too painful if all your tests are like this. Fortunately, you learned about Dependency Injection and know the right thing to do: instead of having your application talk to the drawing API directly, wrap the API in an interface (say, `Turtle`) and code to that interface: ``` class Turtle { ... virtual ~Turtle() {} virtual void PenUp() = 0; virtual void PenDown() = 0; virtual void Forward(int distance) = 0; virtual void Turn(int degrees) = 0; virtual void GoTo(int x, int y) = 0; virtual int GetX() const = 0; virtual int GetY() const = 0; }; ``` (Note that the destructor of `Turtle` **must** be virtual, as is the case for **all** classes you intend to inherit from - otherwise the destructor of the derived class will not be called when you delete an object through a base pointer, and you'll get corrupted program states like memory leaks.) You can control whether the turtle's movement will leave a trace using `PenUp()` and `PenDown()`, and control its movement using `Forward()`, `Turn()`, and `GoTo()`. Finally, `GetX()` and `GetY()` tell you the current position of the turtle. Your program will normally use a real implementation of this interface. In tests, you can use a mock implementation instead. This allows you to easily check what drawing primitives your program is calling, with what arguments, and in which order. Tests written this way are much more robust (they won't break because your new machine does anti-aliasing differently), easier to read and maintain (the intent of a test is expressed in the code, not in some binary images), and run _much, much faster_. # Writing the Mock Class # If you are lucky, the mocks you need to use have already been implemented by some nice people. If, however, you find yourself in the position to write a mock class, relax - Google Mock turns this task into a fun game! (Well, almost.) ## How to Define It ## Using the `Turtle` interface as example, here are the simple steps you need to follow: 1. Derive a class `MockTurtle` from `Turtle`. 1. Take a _virtual_ function of `Turtle` (while it's possible to [mock non-virtual methods using templates](http://code.google.com/p/googlemock/wiki/V1_6_CookBook#Mocking_Nonvirtual_Methods), it's much more involved). Count how many arguments it has. 1. In the `public:` section of the child class, write `MOCK_METHODn();` (or `MOCK_CONST_METHODn();` if you are mocking a `const` method), where `n` is the number of the arguments; if you counted wrong, shame on you, and a compiler error will tell you so. 1. Now comes the fun part: you take the function signature, cut-and-paste the _function name_ as the _first_ argument to the macro, and leave what's left as the _second_ argument (in case you're curious, this is the _type of the function_). 1. Repeat until all virtual functions you want to mock are done. After the process, you should have something like: ``` #include "gmock/gmock.h" // Brings in Google Mock. class MockTurtle : public Turtle { public: ... MOCK_METHOD0(PenUp, void()); MOCK_METHOD0(PenDown, void()); MOCK_METHOD1(Forward, void(int distance)); MOCK_METHOD1(Turn, void(int degrees)); MOCK_METHOD2(GoTo, void(int x, int y)); MOCK_CONST_METHOD0(GetX, int()); MOCK_CONST_METHOD0(GetY, int()); }; ``` You don't need to define these mock methods somewhere else - the `MOCK_METHOD*` macros will generate the definitions for you. It's that simple! Once you get the hang of it, you can pump out mock classes faster than your source-control system can handle your check-ins. **Tip:** If even this is too much work for you, you'll find the `gmock_gen.py` tool in Google Mock's `scripts/generator/` directory (courtesy of the [cppclean](http://code.google.com/p/cppclean/) project) useful. This command-line tool requires that you have Python 2.4 installed. You give it a C++ file and the name of an abstract class defined in it, and it will print the definition of the mock class for you. Due to the complexity of the C++ language, this script may not always work, but it can be quite handy when it does. For more details, read the [user documentation](http://code.google.com/p/googlemock/source/browse/trunk/scripts/generator/README). ## Where to Put It ## When you define a mock class, you need to decide where to put its definition. Some people put it in a `*_test.cc`. This is fine when the interface being mocked (say, `Foo`) is owned by the same person or team. Otherwise, when the owner of `Foo` changes it, your test could break. (You can't really expect `Foo`'s maintainer to fix every test that uses `Foo`, can you?) So, the rule of thumb is: if you need to mock `Foo` and it's owned by others, define the mock class in `Foo`'s package (better, in a `testing` sub-package such that you can clearly separate production code and testing utilities), and put it in a `mock_foo.h`. Then everyone can reference `mock_foo.h` from their tests. If `Foo` ever changes, there is only one copy of `MockFoo` to change, and only tests that depend on the changed methods need to be fixed. Another way to do it: you can introduce a thin layer `FooAdaptor` on top of `Foo` and code to this new interface. Since you own `FooAdaptor`, you can absorb changes in `Foo` much more easily. While this is more work initially, carefully choosing the adaptor interface can make your code easier to write and more readable (a net win in the long run), as you can choose `FooAdaptor` to fit your specific domain much better than `Foo` does. # Using Mocks in Tests # Once you have a mock class, using it is easy. The typical work flow is: 1. Import the Google Mock names from the `testing` namespace such that you can use them unqualified (You only have to do it once per file. Remember that namespaces are a good idea and good for your health.). 1. Create some mock objects. 1. Specify your expectations on them (How many times will a method be called? With what arguments? What should it do? etc.). 1. Exercise some code that uses the mocks; optionally, check the result using Google Test assertions. If a mock method is called more than expected or with wrong arguments, you'll get an error immediately. 1. When a mock is destructed, Google Mock will automatically check whether all expectations on it have been satisfied. Here's an example: ``` #include "path/to/mock-turtle.h" #include "gmock/gmock.h" #include "gtest/gtest.h" using ::testing::AtLeast; // #1 TEST(PainterTest, CanDrawSomething) { MockTurtle turtle; // #2 EXPECT_CALL(turtle, PenDown()) // #3 .Times(AtLeast(1)); Painter painter(&turtle); // #4 EXPECT_TRUE(painter.DrawCircle(0, 0, 10)); } // #5 int main(int argc, char** argv) { // The following line must be executed to initialize Google Mock // (and Google Test) before running the tests. ::testing::InitGoogleMock(&argc, argv); return RUN_ALL_TESTS(); } ``` As you might have guessed, this test checks that `PenDown()` is called at least once. If the `painter` object didn't call this method, your test will fail with a message like this: ``` path/to/my_test.cc:119: Failure Actual function call count doesn't match this expectation: Actually: never called; Expected: called at least once. ``` **Tip 1:** If you run the test from an Emacs buffer, you can hit `` on the line number displayed in the error message to jump right to the failed expectation. **Tip 2:** If your mock objects are never deleted, the final verification won't happen. Therefore it's a good idea to use a heap leak checker in your tests when you allocate mocks on the heap. **Important note:** Google Mock requires expectations to be set **before** the mock functions are called, otherwise the behavior is **undefined**. In particular, you mustn't interleave `EXPECT_CALL()`s and calls to the mock functions. This means `EXPECT_CALL()` should be read as expecting that a call will occur _in the future_, not that a call has occurred. Why does Google Mock work like that? Well, specifying the expectation beforehand allows Google Mock to report a violation as soon as it arises, when the context (stack trace, etc) is still available. This makes debugging much easier. Admittedly, this test is contrived and doesn't do much. You can easily achieve the same effect without using Google Mock. However, as we shall reveal soon, Google Mock allows you to do _much more_ with the mocks. ## Using Google Mock with Any Testing Framework ## If you want to use something other than Google Test (e.g. [CppUnit](http://apps.sourceforge.net/mediawiki/cppunit/index.php?title=Main_Page) or [CxxTest](http://cxxtest.tigris.org/)) as your testing framework, just change the `main()` function in the previous section to: ``` int main(int argc, char** argv) { // The following line causes Google Mock to throw an exception on failure, // which will be interpreted by your testing framework as a test failure. ::testing::GTEST_FLAG(throw_on_failure) = true; ::testing::InitGoogleMock(&argc, argv); ... whatever your testing framework requires ... } ``` This approach has a catch: it makes Google Mock throw an exception from a mock object's destructor sometimes. With some compilers, this sometimes causes the test program to crash. You'll still be able to notice that the test has failed, but it's not a graceful failure. A better solution is to use Google Test's [event listener API](http://code.google.com/p/googletest/wiki/V1_6_AdvancedGuide#Extending_Google_Test_by_Handling_Test_Events) to report a test failure to your testing framework properly. You'll need to implement the `OnTestPartResult()` method of the event listener interface, but it should be straightforward. If this turns out to be too much work, we suggest that you stick with Google Test, which works with Google Mock seamlessly (in fact, it is technically part of Google Mock.). If there is a reason that you cannot use Google Test, please let us know. # Setting Expectations # The key to using a mock object successfully is to set the _right expectations_ on it. If you set the expectations too strict, your test will fail as the result of unrelated changes. If you set them too loose, bugs can slip through. You want to do it just right such that your test can catch exactly the kind of bugs you intend it to catch. Google Mock provides the necessary means for you to do it "just right." ## General Syntax ## In Google Mock we use the `EXPECT_CALL()` macro to set an expectation on a mock method. The general syntax is: ``` EXPECT_CALL(mock_object, method(matchers)) .Times(cardinality) .WillOnce(action) .WillRepeatedly(action); ``` The macro has two arguments: first the mock object, and then the method and its arguments. Note that the two are separated by a comma (`,`), not a period (`.`). (Why using a comma? The answer is that it was necessary for technical reasons.) The macro can be followed by some optional _clauses_ that provide more information about the expectation. We'll discuss how each clause works in the coming sections. This syntax is designed to make an expectation read like English. For example, you can probably guess that ``` using ::testing::Return;... EXPECT_CALL(turtle, GetX()) .Times(5) .WillOnce(Return(100)) .WillOnce(Return(150)) .WillRepeatedly(Return(200)); ``` says that the `turtle` object's `GetX()` method will be called five times, it will return 100 the first time, 150 the second time, and then 200 every time. Some people like to call this style of syntax a Domain-Specific Language (DSL). **Note:** Why do we use a macro to do this? It serves two purposes: first it makes expectations easily identifiable (either by `grep` or by a human reader), and second it allows Google Mock to include the source file location of a failed expectation in messages, making debugging easier. ## Matchers: What Arguments Do We Expect? ## When a mock function takes arguments, we must specify what arguments we are expecting; for example: ``` // Expects the turtle to move forward by 100 units. EXPECT_CALL(turtle, Forward(100)); ``` Sometimes you may not want to be too specific (Remember that talk about tests being too rigid? Over specification leads to brittle tests and obscures the intent of tests. Therefore we encourage you to specify only what's necessary - no more, no less.). If you care to check that `Forward()` will be called but aren't interested in its actual argument, write `_` as the argument, which means "anything goes": ``` using ::testing::_; ... // Expects the turtle to move forward. EXPECT_CALL(turtle, Forward(_)); ``` `_` is an instance of what we call **matchers**. A matcher is like a predicate and can test whether an argument is what we'd expect. You can use a matcher inside `EXPECT_CALL()` wherever a function argument is expected. A list of built-in matchers can be found in the [CheatSheet](V1_6_CheatSheet.md). For example, here's the `Ge` (greater than or equal) matcher: ``` using ::testing::Ge;... EXPECT_CALL(turtle, Forward(Ge(100))); ``` This checks that the turtle will be told to go forward by at least 100 units. ## Cardinalities: How Many Times Will It Be Called? ## The first clause we can specify following an `EXPECT_CALL()` is `Times()`. We call its argument a **cardinality** as it tells _how many times_ the call should occur. It allows us to repeat an expectation many times without actually writing it as many times. More importantly, a cardinality can be "fuzzy", just like a matcher can be. This allows a user to express the intent of a test exactly. An interesting special case is when we say `Times(0)`. You may have guessed - it means that the function shouldn't be called with the given arguments at all, and Google Mock will report a Google Test failure whenever the function is (wrongfully) called. We've seen `AtLeast(n)` as an example of fuzzy cardinalities earlier. For the list of built-in cardinalities you can use, see the [CheatSheet](V1_6_CheatSheet.md). The `Times()` clause can be omitted. **If you omit `Times()`, Google Mock will infer the cardinality for you.** The rules are easy to remember: * If **neither** `WillOnce()` **nor** `WillRepeatedly()` is in the `EXPECT_CALL()`, the inferred cardinality is `Times(1)`. * If there are `n WillOnce()`'s but **no** `WillRepeatedly()`, where `n` >= 1, the cardinality is `Times(n)`. * If there are `n WillOnce()`'s and **one** `WillRepeatedly()`, where `n` >= 0, the cardinality is `Times(AtLeast(n))`. **Quick quiz:** what do you think will happen if a function is expected to be called twice but actually called four times? ## Actions: What Should It Do? ## Remember that a mock object doesn't really have a working implementation? We as users have to tell it what to do when a method is invoked. This is easy in Google Mock. First, if the return type of a mock function is a built-in type or a pointer, the function has a **default action** (a `void` function will just return, a `bool` function will return `false`, and other functions will return 0). If you don't say anything, this behavior will be used. Second, if a mock function doesn't have a default action, or the default action doesn't suit you, you can specify the action to be taken each time the expectation matches using a series of `WillOnce()` clauses followed by an optional `WillRepeatedly()`. For example, ``` using ::testing::Return;... EXPECT_CALL(turtle, GetX()) .WillOnce(Return(100)) .WillOnce(Return(200)) .WillOnce(Return(300)); ``` This says that `turtle.GetX()` will be called _exactly three times_ (Google Mock inferred this from how many `WillOnce()` clauses we've written, since we didn't explicitly write `Times()`), and will return 100, 200, and 300 respectively. ``` using ::testing::Return;... EXPECT_CALL(turtle, GetY()) .WillOnce(Return(100)) .WillOnce(Return(200)) .WillRepeatedly(Return(300)); ``` says that `turtle.GetY()` will be called _at least twice_ (Google Mock knows this as we've written two `WillOnce()` clauses and a `WillRepeatedly()` while having no explicit `Times()`), will return 100 the first time, 200 the second time, and 300 from the third time on. Of course, if you explicitly write a `Times()`, Google Mock will not try to infer the cardinality itself. What if the number you specified is larger than there are `WillOnce()` clauses? Well, after all `WillOnce()`s are used up, Google Mock will do the _default_ action for the function every time (unless, of course, you have a `WillRepeatedly()`.). What can we do inside `WillOnce()` besides `Return()`? You can return a reference using `ReturnRef(variable)`, or invoke a pre-defined function, among [others](http://code.google.com/p/googlemock/wiki/V1_6_CheatSheet#Actions). **Important note:** The `EXPECT_CALL()` statement evaluates the action clause only once, even though the action may be performed many times. Therefore you must be careful about side effects. The following may not do what you want: ``` int n = 100; EXPECT_CALL(turtle, GetX()) .Times(4) .WillRepeatedly(Return(n++)); ``` Instead of returning 100, 101, 102, ..., consecutively, this mock function will always return 100 as `n++` is only evaluated once. Similarly, `Return(new Foo)` will create a new `Foo` object when the `EXPECT_CALL()` is executed, and will return the same pointer every time. If you want the side effect to happen every time, you need to define a custom action, which we'll teach in the [CookBook](V1_6_CookBook.md). Time for another quiz! What do you think the following means? ``` using ::testing::Return;... EXPECT_CALL(turtle, GetY()) .Times(4) .WillOnce(Return(100)); ``` Obviously `turtle.GetY()` is expected to be called four times. But if you think it will return 100 every time, think twice! Remember that one `WillOnce()` clause will be consumed each time the function is invoked and the default action will be taken afterwards. So the right answer is that `turtle.GetY()` will return 100 the first time, but **return 0 from the second time on**, as returning 0 is the default action for `int` functions. ## Using Multiple Expectations ## So far we've only shown examples where you have a single expectation. More realistically, you're going to specify expectations on multiple mock methods, which may be from multiple mock objects. By default, when a mock method is invoked, Google Mock will search the expectations in the **reverse order** they are defined, and stop when an active expectation that matches the arguments is found (you can think of it as "newer rules override older ones."). If the matching expectation cannot take any more calls, you will get an upper-bound-violated failure. Here's an example: ``` using ::testing::_;... EXPECT_CALL(turtle, Forward(_)); // #1 EXPECT_CALL(turtle, Forward(10)) // #2 .Times(2); ``` If `Forward(10)` is called three times in a row, the third time it will be an error, as the last matching expectation (#2) has been saturated. If, however, the third `Forward(10)` call is replaced by `Forward(20)`, then it would be OK, as now #1 will be the matching expectation. **Side note:** Why does Google Mock search for a match in the _reverse_ order of the expectations? The reason is that this allows a user to set up the default expectations in a mock object's constructor or the test fixture's set-up phase and then customize the mock by writing more specific expectations in the test body. So, if you have two expectations on the same method, you want to put the one with more specific matchers **after** the other, or the more specific rule would be shadowed by the more general one that comes after it. ## Ordered vs Unordered Calls ## By default, an expectation can match a call even though an earlier expectation hasn't been satisfied. In other words, the calls don't have to occur in the order the expectations are specified. Sometimes, you may want all the expected calls to occur in a strict order. To say this in Google Mock is easy: ``` using ::testing::InSequence;... TEST(FooTest, DrawsLineSegment) { ... { InSequence dummy; EXPECT_CALL(turtle, PenDown()); EXPECT_CALL(turtle, Forward(100)); EXPECT_CALL(turtle, PenUp()); } Foo(); } ``` By creating an object of type `InSequence`, all expectations in its scope are put into a _sequence_ and have to occur _sequentially_. Since we are just relying on the constructor and destructor of this object to do the actual work, its name is really irrelevant. In this example, we test that `Foo()` calls the three expected functions in the order as written. If a call is made out-of-order, it will be an error. (What if you care about the relative order of some of the calls, but not all of them? Can you specify an arbitrary partial order? The answer is ... yes! If you are impatient, the details can be found in the [CookBook](V1_6_CookBook.md).) ## All Expectations Are Sticky (Unless Said Otherwise) ## Now let's do a quick quiz to see how well you can use this mock stuff already. How would you test that the turtle is asked to go to the origin _exactly twice_ (you want to ignore any other instructions it receives)? After you've come up with your answer, take a look at ours and compare notes (solve it yourself first - don't cheat!): ``` using ::testing::_;... EXPECT_CALL(turtle, GoTo(_, _)) // #1 .Times(AnyNumber()); EXPECT_CALL(turtle, GoTo(0, 0)) // #2 .Times(2); ``` Suppose `turtle.GoTo(0, 0)` is called three times. In the third time, Google Mock will see that the arguments match expectation #2 (remember that we always pick the last matching expectation). Now, since we said that there should be only two such calls, Google Mock will report an error immediately. This is basically what we've told you in the "Using Multiple Expectations" section above. This example shows that **expectations in Google Mock are "sticky" by default**, in the sense that they remain active even after we have reached their invocation upper bounds. This is an important rule to remember, as it affects the meaning of the spec, and is **different** to how it's done in many other mocking frameworks (Why'd we do that? Because we think our rule makes the common cases easier to express and understand.). Simple? Let's see if you've really understood it: what does the following code say? ``` using ::testing::Return; ... for (int i = n; i > 0; i--) { EXPECT_CALL(turtle, GetX()) .WillOnce(Return(10*i)); } ``` If you think it says that `turtle.GetX()` will be called `n` times and will return 10, 20, 30, ..., consecutively, think twice! The problem is that, as we said, expectations are sticky. So, the second time `turtle.GetX()` is called, the last (latest) `EXPECT_CALL()` statement will match, and will immediately lead to an "upper bound exceeded" error - this piece of code is not very useful! One correct way of saying that `turtle.GetX()` will return 10, 20, 30, ..., is to explicitly say that the expectations are _not_ sticky. In other words, they should _retire_ as soon as they are saturated: ``` using ::testing::Return; ... for (int i = n; i > 0; i--) { EXPECT_CALL(turtle, GetX()) .WillOnce(Return(10*i)) .RetiresOnSaturation(); } ``` And, there's a better way to do it: in this case, we expect the calls to occur in a specific order, and we line up the actions to match the order. Since the order is important here, we should make it explicit using a sequence: ``` using ::testing::InSequence; using ::testing::Return; ... { InSequence s; for (int i = 1; i <= n; i++) { EXPECT_CALL(turtle, GetX()) .WillOnce(Return(10*i)) .RetiresOnSaturation(); } } ``` By the way, the other situation where an expectation may _not_ be sticky is when it's in a sequence - as soon as another expectation that comes after it in the sequence has been used, it automatically retires (and will never be used to match any call). ## Uninteresting Calls ## A mock object may have many methods, and not all of them are that interesting. For example, in some tests we may not care about how many times `GetX()` and `GetY()` get called. In Google Mock, if you are not interested in a method, just don't say anything about it. If a call to this method occurs, you'll see a warning in the test output, but it won't be a failure. # What Now? # Congratulations! You've learned enough about Google Mock to start using it. Now, you might want to join the [googlemock](http://groups.google.com/group/googlemock) discussion group and actually write some tests using Google Mock - it will be fun. Hey, it may even be addictive - you've been warned. Then, if you feel like increasing your mock quotient, you should move on to the [CookBook](V1_6_CookBook.md). You can learn many advanced features of Google Mock there -- and advance your level of enjoyment and testing bliss.vendor/googletest/gtest-1.7.0/googlemock/docs/v1_6/FrequentlyAskedQuestions.md000066400000000000000000000563041300002025200275020ustar00rootroot00000000000000 Please send your questions to the [googlemock](http://groups.google.com/group/googlemock) discussion group. If you need help with compiler errors, make sure you have tried [Google Mock Doctor](#How_am_I_supposed_to_make_sense_of_these_horrible_template_error.md) first. ## When I call a method on my mock object, the method for the real object is invoked instead. What's the problem? ## In order for a method to be mocked, it must be _virtual_, unless you use the [high-perf dependency injection technique](http://code.google.com/p/googlemock/wiki/V1_6_CookBook#Mocking_Nonvirtual_Methods). ## I wrote some matchers. After I upgraded to a new version of Google Mock, they no longer compile. What's going on? ## After version 1.4.0 of Google Mock was released, we had an idea on how to make it easier to write matchers that can generate informative messages efficiently. We experimented with this idea and liked what we saw. Therefore we decided to implement it. Unfortunately, this means that if you have defined your own matchers by implementing `MatcherInterface` or using `MakePolymorphicMatcher()`, your definitions will no longer compile. Matchers defined using the `MATCHER*` family of macros are not affected. Sorry for the hassle if your matchers are affected. We believe it's in everyone's long-term interest to make this change sooner than later. Fortunately, it's usually not hard to migrate an existing matcher to the new API. Here's what you need to do: If you wrote your matcher like this: ``` // Old matcher definition that doesn't work with the latest // Google Mock. using ::testing::MatcherInterface; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool Matches(MyType value) const { // Returns true if value matches. return value.GetFoo() > 5; } ... }; ``` you'll need to change it to: ``` // New matcher definition that works with the latest Google Mock. using ::testing::MatcherInterface; using ::testing::MatchResultListener; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. return value.GetFoo() > 5; } ... }; ``` (i.e. rename `Matches()` to `MatchAndExplain()` and give it a second argument of type `MatchResultListener*`.) If you were also using `ExplainMatchResultTo()` to improve the matcher message: ``` // Old matcher definition that doesn't work with the lastest // Google Mock. using ::testing::MatcherInterface; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool Matches(MyType value) const { // Returns true if value matches. return value.GetFoo() > 5; } virtual void ExplainMatchResultTo(MyType value, ::std::ostream* os) const { // Prints some helpful information to os to help // a user understand why value matches (or doesn't match). *os << "the Foo property is " << value.GetFoo(); } ... }; ``` you should move the logic of `ExplainMatchResultTo()` into `MatchAndExplain()`, using the `MatchResultListener` argument where the `::std::ostream` was used: ``` // New matcher definition that works with the latest Google Mock. using ::testing::MatcherInterface; using ::testing::MatchResultListener; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. *listener << "the Foo property is " << value.GetFoo(); return value.GetFoo() > 5; } ... }; ``` If your matcher is defined using `MakePolymorphicMatcher()`: ``` // Old matcher definition that doesn't work with the latest // Google Mock. using ::testing::MakePolymorphicMatcher; ... class MyGreatMatcher { public: ... bool Matches(MyType value) const { // Returns true if value matches. return value.GetBar() < 42; } ... }; ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` you should rename the `Matches()` method to `MatchAndExplain()` and add a `MatchResultListener*` argument (the same as what you need to do for matchers defined by implementing `MatcherInterface`): ``` // New matcher definition that works with the latest Google Mock. using ::testing::MakePolymorphicMatcher; using ::testing::MatchResultListener; ... class MyGreatMatcher { public: ... bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. return value.GetBar() < 42; } ... }; ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` If your polymorphic matcher uses `ExplainMatchResultTo()` for better failure messages: ``` // Old matcher definition that doesn't work with the latest // Google Mock. using ::testing::MakePolymorphicMatcher; ... class MyGreatMatcher { public: ... bool Matches(MyType value) const { // Returns true if value matches. return value.GetBar() < 42; } ... }; void ExplainMatchResultTo(const MyGreatMatcher& matcher, MyType value, ::std::ostream* os) { // Prints some helpful information to os to help // a user understand why value matches (or doesn't match). *os << "the Bar property is " << value.GetBar(); } ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` you'll need to move the logic inside `ExplainMatchResultTo()` to `MatchAndExplain()`: ``` // New matcher definition that works with the latest Google Mock. using ::testing::MakePolymorphicMatcher; using ::testing::MatchResultListener; ... class MyGreatMatcher { public: ... bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. *listener << "the Bar property is " << value.GetBar(); return value.GetBar() < 42; } ... }; ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` For more information, you can read these [two](http://code.google.com/p/googlemock/wiki/V1_6_CookBook#Writing_New_Monomorphic_Matchers) [recipes](http://code.google.com/p/googlemock/wiki/V1_6_CookBook#Writing_New_Polymorphic_Matchers) from the cookbook. As always, you are welcome to post questions on `googlemock@googlegroups.com` if you need any help. ## When using Google Mock, do I have to use Google Test as the testing framework? I have my favorite testing framework and don't want to switch. ## Google Mock works out of the box with Google Test. However, it's easy to configure it to work with any testing framework of your choice. [Here](http://code.google.com/p/googlemock/wiki/V1_6_ForDummies#Using_Google_Mock_with_Any_Testing_Framework) is how. ## How am I supposed to make sense of these horrible template errors? ## If you are confused by the compiler errors gcc threw at you, try consulting the _Google Mock Doctor_ tool first. What it does is to scan stdin for gcc error messages, and spit out diagnoses on the problems (we call them diseases) your code has. To "install", run command: ``` alias gmd='/scripts/gmock_doctor.py' ``` To use it, do: ``` 2>&1 | gmd ``` For example: ``` make my_test 2>&1 | gmd ``` Or you can run `gmd` and copy-n-paste gcc's error messages to it. ## Can I mock a variadic function? ## You cannot mock a variadic function (i.e. a function taking ellipsis (`...`) arguments) directly in Google Mock. The problem is that in general, there is _no way_ for a mock object to know how many arguments are passed to the variadic method, and what the arguments' types are. Only the _author of the base class_ knows the protocol, and we cannot look into his head. Therefore, to mock such a function, the _user_ must teach the mock object how to figure out the number of arguments and their types. One way to do it is to provide overloaded versions of the function. Ellipsis arguments are inherited from C and not really a C++ feature. They are unsafe to use and don't work with arguments that have constructors or destructors. Therefore we recommend to avoid them in C++ as much as possible. ## MSVC gives me warning C4301 or C4373 when I define a mock method with a const parameter. Why? ## If you compile this using Microsoft Visual C++ 2005 SP1: ``` class Foo { ... virtual void Bar(const int i) = 0; }; class MockFoo : public Foo { ... MOCK_METHOD1(Bar, void(const int i)); }; ``` You may get the following warning: ``` warning C4301: 'MockFoo::Bar': overriding virtual function only differs from 'Foo::Bar' by const/volatile qualifier ``` This is a MSVC bug. The same code compiles fine with gcc ,for example. If you use Visual C++ 2008 SP1, you would get the warning: ``` warning C4373: 'MockFoo::Bar': virtual function overrides 'Foo::Bar', previous versions of the compiler did not override when parameters only differed by const/volatile qualifiers ``` In C++, if you _declare_ a function with a `const` parameter, the `const` modifier is _ignored_. Therefore, the `Foo` base class above is equivalent to: ``` class Foo { ... virtual void Bar(int i) = 0; // int or const int? Makes no difference. }; ``` In fact, you can _declare_ Bar() with an `int` parameter, and _define_ it with a `const int` parameter. The compiler will still match them up. Since making a parameter `const` is meaningless in the method _declaration_, we recommend to remove it in both `Foo` and `MockFoo`. That should workaround the VC bug. Note that we are talking about the _top-level_ `const` modifier here. If the function parameter is passed by pointer or reference, declaring the _pointee_ or _referee_ as `const` is still meaningful. For example, the following two declarations are _not_ equivalent: ``` void Bar(int* p); // Neither p nor *p is const. void Bar(const int* p); // p is not const, but *p is. ``` ## I have a huge mock class, and Microsoft Visual C++ runs out of memory when compiling it. What can I do? ## We've noticed that when the `/clr` compiler flag is used, Visual C++ uses 5~6 times as much memory when compiling a mock class. We suggest to avoid `/clr` when compiling native C++ mocks. ## I can't figure out why Google Mock thinks my expectations are not satisfied. What should I do? ## You might want to run your test with `--gmock_verbose=info`. This flag lets Google Mock print a trace of every mock function call it receives. By studying the trace, you'll gain insights on why the expectations you set are not met. ## How can I assert that a function is NEVER called? ## ``` EXPECT_CALL(foo, Bar(_)) .Times(0); ``` ## I have a failed test where Google Mock tells me TWICE that a particular expectation is not satisfied. Isn't this redundant? ## When Google Mock detects a failure, it prints relevant information (the mock function arguments, the state of relevant expectations, and etc) to help the user debug. If another failure is detected, Google Mock will do the same, including printing the state of relevant expectations. Sometimes an expectation's state didn't change between two failures, and you'll see the same description of the state twice. They are however _not_ redundant, as they refer to _different points in time_. The fact they are the same _is_ interesting information. ## I get a heap check failure when using a mock object, but using a real object is fine. What can be wrong? ## Does the class (hopefully a pure interface) you are mocking have a virtual destructor? Whenever you derive from a base class, make sure its destructor is virtual. Otherwise Bad Things will happen. Consider the following code: ``` class Base { public: // Not virtual, but should be. ~Base() { ... } ... }; class Derived : public Base { public: ... private: std::string value_; }; ... Base* p = new Derived; ... delete p; // Surprise! ~Base() will be called, but ~Derived() will not // - value_ is leaked. ``` By changing `~Base()` to virtual, `~Derived()` will be correctly called when `delete p` is executed, and the heap checker will be happy. ## The "newer expectations override older ones" rule makes writing expectations awkward. Why does Google Mock do that? ## When people complain about this, often they are referring to code like: ``` // foo.Bar() should be called twice, return 1 the first time, and return // 2 the second time. However, I have to write the expectations in the // reverse order. This sucks big time!!! EXPECT_CALL(foo, Bar()) .WillOnce(Return(2)) .RetiresOnSaturation(); EXPECT_CALL(foo, Bar()) .WillOnce(Return(1)) .RetiresOnSaturation(); ``` The problem is that they didn't pick the **best** way to express the test's intent. By default, expectations don't have to be matched in _any_ particular order. If you want them to match in a certain order, you need to be explicit. This is Google Mock's (and jMock's) fundamental philosophy: it's easy to accidentally over-specify your tests, and we want to make it harder to do so. There are two better ways to write the test spec. You could either put the expectations in sequence: ``` // foo.Bar() should be called twice, return 1 the first time, and return // 2 the second time. Using a sequence, we can write the expectations // in their natural order. { InSequence s; EXPECT_CALL(foo, Bar()) .WillOnce(Return(1)) .RetiresOnSaturation(); EXPECT_CALL(foo, Bar()) .WillOnce(Return(2)) .RetiresOnSaturation(); } ``` or you can put the sequence of actions in the same expectation: ``` // foo.Bar() should be called twice, return 1 the first time, and return // 2 the second time. EXPECT_CALL(foo, Bar()) .WillOnce(Return(1)) .WillOnce(Return(2)) .RetiresOnSaturation(); ``` Back to the original questions: why does Google Mock search the expectations (and `ON_CALL`s) from back to front? Because this allows a user to set up a mock's behavior for the common case early (e.g. in the mock's constructor or the test fixture's set-up phase) and customize it with more specific rules later. If Google Mock searches from front to back, this very useful pattern won't be possible. ## Google Mock prints a warning when a function without EXPECT\_CALL is called, even if I have set its behavior using ON\_CALL. Would it be reasonable not to show the warning in this case? ## When choosing between being neat and being safe, we lean toward the latter. So the answer is that we think it's better to show the warning. Often people write `ON_CALL`s in the mock object's constructor or `SetUp()`, as the default behavior rarely changes from test to test. Then in the test body they set the expectations, which are often different for each test. Having an `ON_CALL` in the set-up part of a test doesn't mean that the calls are expected. If there's no `EXPECT_CALL` and the method is called, it's possibly an error. If we quietly let the call go through without notifying the user, bugs may creep in unnoticed. If, however, you are sure that the calls are OK, you can write ``` EXPECT_CALL(foo, Bar(_)) .WillRepeatedly(...); ``` instead of ``` ON_CALL(foo, Bar(_)) .WillByDefault(...); ``` This tells Google Mock that you do expect the calls and no warning should be printed. Also, you can control the verbosity using the `--gmock_verbose` flag. If you find the output too noisy when debugging, just choose a less verbose level. ## How can I delete the mock function's argument in an action? ## If you find yourself needing to perform some action that's not supported by Google Mock directly, remember that you can define your own actions using [MakeAction()](http://code.google.com/p/googlemock/wiki/V1_6_CookBook#Writing_New_Actions) or [MakePolymorphicAction()](http://code.google.com/p/googlemock/wiki/V1_6_CookBook#Writing_New_Polymorphic_Actions), or you can write a stub function and invoke it using [Invoke()](http://code.google.com/p/googlemock/wiki/V1_6_CookBook#Using_Functions_Methods_Functors). ## MOCK\_METHODn()'s second argument looks funny. Why don't you use the MOCK\_METHODn(Method, return\_type, arg\_1, ..., arg\_n) syntax? ## What?! I think it's beautiful. :-) While which syntax looks more natural is a subjective matter to some extent, Google Mock's syntax was chosen for several practical advantages it has. Try to mock a function that takes a map as an argument: ``` virtual int GetSize(const map& m); ``` Using the proposed syntax, it would be: ``` MOCK_METHOD1(GetSize, int, const map& m); ``` Guess what? You'll get a compiler error as the compiler thinks that `const map& m` are **two**, not one, arguments. To work around this you can use `typedef` to give the map type a name, but that gets in the way of your work. Google Mock's syntax avoids this problem as the function's argument types are protected inside a pair of parentheses: ``` // This compiles fine. MOCK_METHOD1(GetSize, int(const map& m)); ``` You still need a `typedef` if the return type contains an unprotected comma, but that's much rarer. Other advantages include: 1. `MOCK_METHOD1(Foo, int, bool)` can leave a reader wonder whether the method returns `int` or `bool`, while there won't be such confusion using Google Mock's syntax. 1. The way Google Mock describes a function type is nothing new, although many people may not be familiar with it. The same syntax was used in C, and the `function` library in `tr1` uses this syntax extensively. Since `tr1` will become a part of the new version of STL, we feel very comfortable to be consistent with it. 1. The function type syntax is also used in other parts of Google Mock's API (e.g. the action interface) in order to make the implementation tractable. A user needs to learn it anyway in order to utilize Google Mock's more advanced features. We'd as well stick to the same syntax in `MOCK_METHOD*`! ## My code calls a static/global function. Can I mock it? ## You can, but you need to make some changes. In general, if you find yourself needing to mock a static function, it's a sign that your modules are too tightly coupled (and less flexible, less reusable, less testable, etc). You are probably better off defining a small interface and call the function through that interface, which then can be easily mocked. It's a bit of work initially, but usually pays for itself quickly. This Google Testing Blog [post](http://googletesting.blogspot.com/2008/06/defeat-static-cling.html) says it excellently. Check it out. ## My mock object needs to do complex stuff. It's a lot of pain to specify the actions. Google Mock sucks! ## I know it's not a question, but you get an answer for free any way. :-) With Google Mock, you can create mocks in C++ easily. And people might be tempted to use them everywhere. Sometimes they work great, and sometimes you may find them, well, a pain to use. So, what's wrong in the latter case? When you write a test without using mocks, you exercise the code and assert that it returns the correct value or that the system is in an expected state. This is sometimes called "state-based testing". Mocks are great for what some call "interaction-based" testing: instead of checking the system state at the very end, mock objects verify that they are invoked the right way and report an error as soon as it arises, giving you a handle on the precise context in which the error was triggered. This is often more effective and economical to do than state-based testing. If you are doing state-based testing and using a test double just to simulate the real object, you are probably better off using a fake. Using a mock in this case causes pain, as it's not a strong point for mocks to perform complex actions. If you experience this and think that mocks suck, you are just not using the right tool for your problem. Or, you might be trying to solve the wrong problem. :-) ## I got a warning "Uninteresting function call encountered - default action taken.." Should I panic? ## By all means, NO! It's just an FYI. What it means is that you have a mock function, you haven't set any expectations on it (by Google Mock's rule this means that you are not interested in calls to this function and therefore it can be called any number of times), and it is called. That's OK - you didn't say it's not OK to call the function! What if you actually meant to disallow this function to be called, but forgot to write `EXPECT_CALL(foo, Bar()).Times(0)`? While one can argue that it's the user's fault, Google Mock tries to be nice and prints you a note. So, when you see the message and believe that there shouldn't be any uninteresting calls, you should investigate what's going on. To make your life easier, Google Mock prints the function name and arguments when an uninteresting call is encountered. ## I want to define a custom action. Should I use Invoke() or implement the action interface? ## Either way is fine - you want to choose the one that's more convenient for your circumstance. Usually, if your action is for a particular function type, defining it using `Invoke()` should be easier; if your action can be used in functions of different types (e.g. if you are defining `Return(value)`), `MakePolymorphicAction()` is easiest. Sometimes you want precise control on what types of functions the action can be used in, and implementing `ActionInterface` is the way to go here. See the implementation of `Return()` in `include/gmock/gmock-actions.h` for an example. ## I'm using the set-argument-pointee action, and the compiler complains about "conflicting return type specified". What does it mean? ## You got this error as Google Mock has no idea what value it should return when the mock method is called. `SetArgPointee()` says what the side effect is, but doesn't say what the return value should be. You need `DoAll()` to chain a `SetArgPointee()` with a `Return()`. See this [recipe](http://code.google.com/p/googlemock/wiki/V1_6_CookBook#Mocking_Side_Effects) for more details and an example. ## My question is not in your FAQ! ## If you cannot find the answer to your question in this FAQ, there are some other resources you can use: 1. read other [wiki pages](http://code.google.com/p/googlemock/w/list), 1. search the mailing list [archive](http://groups.google.com/group/googlemock/topics), 1. ask it on [googlemock@googlegroups.com](mailto:googlemock@googlegroups.com) and someone will answer it (to prevent spam, we require you to join the [discussion group](http://groups.google.com/group/googlemock) before you can post.). Please note that creating an issue in the [issue tracker](http://code.google.com/p/googlemock/issues/list) is _not_ a good way to get your answer, as it is monitored infrequently by a very small number of people. When asking a question, it's helpful to provide as much of the following information as possible (people cannot help you if there's not enough information in your question): * the version (or the revision number if you check out from SVN directly) of Google Mock you use (Google Mock is under active development, so it's possible that your problem has been solved in a later version), * your operating system, * the name and version of your compiler, * the complete command line flags you give to your compiler, * the complete compiler error messages (if the question is about compilation), * the _actual_ code (ideally, a minimal but complete program) that has the problem you encounter.vendor/googletest/gtest-1.7.0/googlemock/docs/v1_7/000077500000000000000000000000001300002025200221305ustar00rootroot00000000000000vendor/googletest/gtest-1.7.0/googlemock/docs/v1_7/CheatSheet.md000066400000000000000000000665621300002025200245060ustar00rootroot00000000000000 # Defining a Mock Class # ## Mocking a Normal Class ## Given ``` class Foo { ... virtual ~Foo(); virtual int GetSize() const = 0; virtual string Describe(const char* name) = 0; virtual string Describe(int type) = 0; virtual bool Process(Bar elem, int count) = 0; }; ``` (note that `~Foo()` **must** be virtual) we can define its mock as ``` #include "gmock/gmock.h" class MockFoo : public Foo { MOCK_CONST_METHOD0(GetSize, int()); MOCK_METHOD1(Describe, string(const char* name)); MOCK_METHOD1(Describe, string(int type)); MOCK_METHOD2(Process, bool(Bar elem, int count)); }; ``` To create a "nice" mock object which ignores all uninteresting calls, or a "strict" mock object, which treats them as failures: ``` NiceMock nice_foo; // The type is a subclass of MockFoo. StrictMock strict_foo; // The type is a subclass of MockFoo. ``` ## Mocking a Class Template ## To mock ``` template class StackInterface { public: ... virtual ~StackInterface(); virtual int GetSize() const = 0; virtual void Push(const Elem& x) = 0; }; ``` (note that `~StackInterface()` **must** be virtual) just append `_T` to the `MOCK_*` macros: ``` template class MockStack : public StackInterface { public: ... MOCK_CONST_METHOD0_T(GetSize, int()); MOCK_METHOD1_T(Push, void(const Elem& x)); }; ``` ## Specifying Calling Conventions for Mock Functions ## If your mock function doesn't use the default calling convention, you can specify it by appending `_WITH_CALLTYPE` to any of the macros described in the previous two sections and supplying the calling convention as the first argument to the macro. For example, ``` MOCK_METHOD_1_WITH_CALLTYPE(STDMETHODCALLTYPE, Foo, bool(int n)); MOCK_CONST_METHOD2_WITH_CALLTYPE(STDMETHODCALLTYPE, Bar, int(double x, double y)); ``` where `STDMETHODCALLTYPE` is defined by `` on Windows. # Using Mocks in Tests # The typical flow is: 1. Import the Google Mock names you need to use. All Google Mock names are in the `testing` namespace unless they are macros or otherwise noted. 1. Create the mock objects. 1. Optionally, set the default actions of the mock objects. 1. Set your expectations on the mock objects (How will they be called? What wil they do?). 1. Exercise code that uses the mock objects; if necessary, check the result using [Google Test](http://code.google.com/p/googletest/) assertions. 1. When a mock objects is destructed, Google Mock automatically verifies that all expectations on it have been satisfied. Here is an example: ``` using ::testing::Return; // #1 TEST(BarTest, DoesThis) { MockFoo foo; // #2 ON_CALL(foo, GetSize()) // #3 .WillByDefault(Return(1)); // ... other default actions ... EXPECT_CALL(foo, Describe(5)) // #4 .Times(3) .WillRepeatedly(Return("Category 5")); // ... other expectations ... EXPECT_EQ("good", MyProductionFunction(&foo)); // #5 } // #6 ``` # Setting Default Actions # Google Mock has a **built-in default action** for any function that returns `void`, `bool`, a numeric value, or a pointer. To customize the default action for functions with return type `T` globally: ``` using ::testing::DefaultValue; DefaultValue::Set(value); // Sets the default value to be returned. // ... use the mocks ... DefaultValue::Clear(); // Resets the default value. ``` To customize the default action for a particular method, use `ON_CALL()`: ``` ON_CALL(mock_object, method(matchers)) .With(multi_argument_matcher) ? .WillByDefault(action); ``` # Setting Expectations # `EXPECT_CALL()` sets **expectations** on a mock method (How will it be called? What will it do?): ``` EXPECT_CALL(mock_object, method(matchers)) .With(multi_argument_matcher) ? .Times(cardinality) ? .InSequence(sequences) * .After(expectations) * .WillOnce(action) * .WillRepeatedly(action) ? .RetiresOnSaturation(); ? ``` If `Times()` is omitted, the cardinality is assumed to be: * `Times(1)` when there is neither `WillOnce()` nor `WillRepeatedly()`; * `Times(n)` when there are `n WillOnce()`s but no `WillRepeatedly()`, where `n` >= 1; or * `Times(AtLeast(n))` when there are `n WillOnce()`s and a `WillRepeatedly()`, where `n` >= 0. A method with no `EXPECT_CALL()` is free to be invoked _any number of times_, and the default action will be taken each time. # Matchers # A **matcher** matches a _single_ argument. You can use it inside `ON_CALL()` or `EXPECT_CALL()`, or use it to validate a value directly: | `EXPECT_THAT(value, matcher)` | Asserts that `value` matches `matcher`. | |:------------------------------|:----------------------------------------| | `ASSERT_THAT(value, matcher)` | The same as `EXPECT_THAT(value, matcher)`, except that it generates a **fatal** failure. | Built-in matchers (where `argument` is the function argument) are divided into several categories: ## Wildcard ## |`_`|`argument` can be any value of the correct type.| |:--|:-----------------------------------------------| |`A()` or `An()`|`argument` can be any value of type `type`. | ## Generic Comparison ## |`Eq(value)` or `value`|`argument == value`| |:---------------------|:------------------| |`Ge(value)` |`argument >= value`| |`Gt(value)` |`argument > value` | |`Le(value)` |`argument <= value`| |`Lt(value)` |`argument < value` | |`Ne(value)` |`argument != value`| |`IsNull()` |`argument` is a `NULL` pointer (raw or smart).| |`NotNull()` |`argument` is a non-null pointer (raw or smart).| |`Ref(variable)` |`argument` is a reference to `variable`.| |`TypedEq(value)`|`argument` has type `type` and is equal to `value`. You may need to use this instead of `Eq(value)` when the mock function is overloaded.| Except `Ref()`, these matchers make a _copy_ of `value` in case it's modified or destructed later. If the compiler complains that `value` doesn't have a public copy constructor, try wrap it in `ByRef()`, e.g. `Eq(ByRef(non_copyable_value))`. If you do that, make sure `non_copyable_value` is not changed afterwards, or the meaning of your matcher will be changed. ## Floating-Point Matchers ## |`DoubleEq(a_double)`|`argument` is a `double` value approximately equal to `a_double`, treating two NaNs as unequal.| |:-------------------|:----------------------------------------------------------------------------------------------| |`FloatEq(a_float)` |`argument` is a `float` value approximately equal to `a_float`, treating two NaNs as unequal. | |`NanSensitiveDoubleEq(a_double)`|`argument` is a `double` value approximately equal to `a_double`, treating two NaNs as equal. | |`NanSensitiveFloatEq(a_float)`|`argument` is a `float` value approximately equal to `a_float`, treating two NaNs as equal. | The above matchers use ULP-based comparison (the same as used in [Google Test](http://code.google.com/p/googletest/)). They automatically pick a reasonable error bound based on the absolute value of the expected value. `DoubleEq()` and `FloatEq()` conform to the IEEE standard, which requires comparing two NaNs for equality to return false. The `NanSensitive*` version instead treats two NaNs as equal, which is often what a user wants. |`DoubleNear(a_double, max_abs_error)`|`argument` is a `double` value close to `a_double` (absolute error <= `max_abs_error`), treating two NaNs as unequal.| |:------------------------------------|:--------------------------------------------------------------------------------------------------------------------| |`FloatNear(a_float, max_abs_error)` |`argument` is a `float` value close to `a_float` (absolute error <= `max_abs_error`), treating two NaNs as unequal. | |`NanSensitiveDoubleNear(a_double, max_abs_error)`|`argument` is a `double` value close to `a_double` (absolute error <= `max_abs_error`), treating two NaNs as equal. | |`NanSensitiveFloatNear(a_float, max_abs_error)`|`argument` is a `float` value close to `a_float` (absolute error <= `max_abs_error`), treating two NaNs as equal. | ## String Matchers ## The `argument` can be either a C string or a C++ string object: |`ContainsRegex(string)`|`argument` matches the given regular expression.| |:----------------------|:-----------------------------------------------| |`EndsWith(suffix)` |`argument` ends with string `suffix`. | |`HasSubstr(string)` |`argument` contains `string` as a sub-string. | |`MatchesRegex(string)` |`argument` matches the given regular expression with the match starting at the first character and ending at the last character.| |`StartsWith(prefix)` |`argument` starts with string `prefix`. | |`StrCaseEq(string)` |`argument` is equal to `string`, ignoring case. | |`StrCaseNe(string)` |`argument` is not equal to `string`, ignoring case.| |`StrEq(string)` |`argument` is equal to `string`. | |`StrNe(string)` |`argument` is not equal to `string`. | `ContainsRegex()` and `MatchesRegex()` use the regular expression syntax defined [here](http://code.google.com/p/googletest/wiki/AdvancedGuide#Regular_Expression_Syntax). `StrCaseEq()`, `StrCaseNe()`, `StrEq()`, and `StrNe()` work for wide strings as well. ## Container Matchers ## Most STL-style containers support `==`, so you can use `Eq(expected_container)` or simply `expected_container` to match a container exactly. If you want to write the elements in-line, match them more flexibly, or get more informative messages, you can use: | `ContainerEq(container)` | The same as `Eq(container)` except that the failure message also includes which elements are in one container but not the other. | |:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------| | `Contains(e)` | `argument` contains an element that matches `e`, which can be either a value or a matcher. | | `Each(e)` | `argument` is a container where _every_ element matches `e`, which can be either a value or a matcher. | | `ElementsAre(e0, e1, ..., en)` | `argument` has `n + 1` elements, where the i-th element matches `ei`, which can be a value or a matcher. 0 to 10 arguments are allowed. | | `ElementsAreArray({ e0, e1, ..., en })`, `ElementsAreArray(array)`, or `ElementsAreArray(array, count)` | The same as `ElementsAre()` except that the expected element values/matchers come from an initializer list, vector, or C-style array. | | `IsEmpty()` | `argument` is an empty container (`container.empty()`). | | `Pointwise(m, container)` | `argument` contains the same number of elements as in `container`, and for all i, (the i-th element in `argument`, the i-th element in `container`) match `m`, which is a matcher on 2-tuples. E.g. `Pointwise(Le(), upper_bounds)` verifies that each element in `argument` doesn't exceed the corresponding element in `upper_bounds`. See more detail below. | | `SizeIs(m)` | `argument` is a container whose size matches `m`. E.g. `SizeIs(2)` or `SizeIs(Lt(2))`. | | `UnorderedElementsAre(e0, e1, ..., en)` | `argument` has `n + 1` elements, and under some permutation each element matches an `ei` (for a different `i`), which can be a value or a matcher. 0 to 10 arguments are allowed. | | `UnorderedElementsAreArray({ e0, e1, ..., en })`, `UnorderedElementsAreArray(array)`, or `UnorderedElementsAreArray(array, count)` | The same as `UnorderedElementsAre()` except that the expected element values/matchers come from an initializer list, vector, or C-style array. | | `WhenSorted(m)` | When `argument` is sorted using the `<` operator, it matches container matcher `m`. E.g. `WhenSorted(UnorderedElementsAre(1, 2, 3))` verifies that `argument` contains elements `1`, `2`, and `3`, ignoring order. | | `WhenSortedBy(comparator, m)` | The same as `WhenSorted(m)`, except that the given comparator instead of `<` is used to sort `argument`. E.g. `WhenSortedBy(std::greater(), ElementsAre(3, 2, 1))`. | Notes: * These matchers can also match: 1. a native array passed by reference (e.g. in `Foo(const int (&a)[5])`), and 1. an array passed as a pointer and a count (e.g. in `Bar(const T* buffer, int len)` -- see [Multi-argument Matchers](#Multiargument_Matchers.md)). * The array being matched may be multi-dimensional (i.e. its elements can be arrays). * `m` in `Pointwise(m, ...)` should be a matcher for `std::tr1::tuple` where `T` and `U` are the element type of the actual container and the expected container, respectively. For example, to compare two `Foo` containers where `Foo` doesn't support `operator==` but has an `Equals()` method, one might write: ``` using ::std::tr1::get; MATCHER(FooEq, "") { return get<0>(arg).Equals(get<1>(arg)); } ... EXPECT_THAT(actual_foos, Pointwise(FooEq(), expected_foos)); ``` ## Member Matchers ## |`Field(&class::field, m)`|`argument.field` (or `argument->field` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _class_.| |:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------| |`Key(e)` |`argument.first` matches `e`, which can be either a value or a matcher. E.g. `Contains(Key(Le(5)))` can verify that a `map` contains a key `<= 5`.| |`Pair(m1, m2)` |`argument` is an `std::pair` whose `first` field matches `m1` and `second` field matches `m2`. | |`Property(&class::property, m)`|`argument.property()` (or `argument->property()` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _class_.| ## Matching the Result of a Function or Functor ## |`ResultOf(f, m)`|`f(argument)` matches matcher `m`, where `f` is a function or functor.| |:---------------|:---------------------------------------------------------------------| ## Pointer Matchers ## |`Pointee(m)`|`argument` (either a smart pointer or a raw pointer) points to a value that matches matcher `m`.| |:-----------|:-----------------------------------------------------------------------------------------------| ## Multiargument Matchers ## Technically, all matchers match a _single_ value. A "multi-argument" matcher is just one that matches a _tuple_. The following matchers can be used to match a tuple `(x, y)`: |`Eq()`|`x == y`| |:-----|:-------| |`Ge()`|`x >= y`| |`Gt()`|`x > y` | |`Le()`|`x <= y`| |`Lt()`|`x < y` | |`Ne()`|`x != y`| You can use the following selectors to pick a subset of the arguments (or reorder them) to participate in the matching: |`AllArgs(m)`|Equivalent to `m`. Useful as syntactic sugar in `.With(AllArgs(m))`.| |:-----------|:-------------------------------------------------------------------| |`Args(m)`|The tuple of the `k` selected (using 0-based indices) arguments matches `m`, e.g. `Args<1, 2>(Eq())`.| ## Composite Matchers ## You can make a matcher from one or more other matchers: |`AllOf(m1, m2, ..., mn)`|`argument` matches all of the matchers `m1` to `mn`.| |:-----------------------|:---------------------------------------------------| |`AnyOf(m1, m2, ..., mn)`|`argument` matches at least one of the matchers `m1` to `mn`.| |`Not(m)` |`argument` doesn't match matcher `m`. | ## Adapters for Matchers ## |`MatcherCast(m)`|casts matcher `m` to type `Matcher`.| |:------------------|:--------------------------------------| |`SafeMatcherCast(m)`| [safely casts](http://code.google.com/p/googlemock/wiki/V1_7_CookBook#Casting_Matchers) matcher `m` to type `Matcher`. | |`Truly(predicate)` |`predicate(argument)` returns something considered by C++ to be true, where `predicate` is a function or functor.| ## Matchers as Predicates ## |`Matches(m)(value)`|evaluates to `true` if `value` matches `m`. You can use `Matches(m)` alone as a unary functor.| |:------------------|:---------------------------------------------------------------------------------------------| |`ExplainMatchResult(m, value, result_listener)`|evaluates to `true` if `value` matches `m`, explaining the result to `result_listener`. | |`Value(value, m)` |evaluates to `true` if `value` matches `m`. | ## Defining Matchers ## | `MATCHER(IsEven, "") { return (arg % 2) == 0; }` | Defines a matcher `IsEven()` to match an even number. | |:-------------------------------------------------|:------------------------------------------------------| | `MATCHER_P(IsDivisibleBy, n, "") { *result_listener << "where the remainder is " << (arg % n); return (arg % n) == 0; }` | Defines a macher `IsDivisibleBy(n)` to match a number divisible by `n`. | | `MATCHER_P2(IsBetween, a, b, std::string(negation ? "isn't" : "is") + " between " + PrintToString(a) + " and " + PrintToString(b)) { return a <= arg && arg <= b; }` | Defines a matcher `IsBetween(a, b)` to match a value in the range [`a`, `b`]. | **Notes:** 1. The `MATCHER*` macros cannot be used inside a function or class. 1. The matcher body must be _purely functional_ (i.e. it cannot have any side effect, and the result must not depend on anything other than the value being matched and the matcher parameters). 1. You can use `PrintToString(x)` to convert a value `x` of any type to a string. ## Matchers as Test Assertions ## |`ASSERT_THAT(expression, m)`|Generates a [fatal failure](http://code.google.com/p/googletest/wiki/Primer#Assertions) if the value of `expression` doesn't match matcher `m`.| |:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------| |`EXPECT_THAT(expression, m)`|Generates a non-fatal failure if the value of `expression` doesn't match matcher `m`. | # Actions # **Actions** specify what a mock function should do when invoked. ## Returning a Value ## |`Return()`|Return from a `void` mock function.| |:---------|:----------------------------------| |`Return(value)`|Return `value`. If the type of `value` is different to the mock function's return type, `value` is converted to the latter type at the time the expectation is set, not when the action is executed.| |`ReturnArg()`|Return the `N`-th (0-based) argument.| |`ReturnNew(a1, ..., ak)`|Return `new T(a1, ..., ak)`; a different object is created each time.| |`ReturnNull()`|Return a null pointer. | |`ReturnPointee(ptr)`|Return the value pointed to by `ptr`.| |`ReturnRef(variable)`|Return a reference to `variable`. | |`ReturnRefOfCopy(value)`|Return a reference to a copy of `value`; the copy lives as long as the action.| ## Side Effects ## |`Assign(&variable, value)`|Assign `value` to variable.| |:-------------------------|:--------------------------| | `DeleteArg()` | Delete the `N`-th (0-based) argument, which must be a pointer. | | `SaveArg(pointer)` | Save the `N`-th (0-based) argument to `*pointer`. | | `SaveArgPointee(pointer)` | Save the value pointed to by the `N`-th (0-based) argument to `*pointer`. | | `SetArgReferee(value)` | Assign value to the variable referenced by the `N`-th (0-based) argument. | |`SetArgPointee(value)` |Assign `value` to the variable pointed by the `N`-th (0-based) argument.| |`SetArgumentPointee(value)`|Same as `SetArgPointee(value)`. Deprecated. Will be removed in v1.7.0.| |`SetArrayArgument(first, last)`|Copies the elements in source range [`first`, `last`) to the array pointed to by the `N`-th (0-based) argument, which can be either a pointer or an iterator. The action does not take ownership of the elements in the source range.| |`SetErrnoAndReturn(error, value)`|Set `errno` to `error` and return `value`.| |`Throw(exception)` |Throws the given exception, which can be any copyable value. Available since v1.1.0.| ## Using a Function or a Functor as an Action ## |`Invoke(f)`|Invoke `f` with the arguments passed to the mock function, where `f` can be a global/static function or a functor.| |:----------|:-----------------------------------------------------------------------------------------------------------------| |`Invoke(object_pointer, &class::method)`|Invoke the {method on the object with the arguments passed to the mock function. | |`InvokeWithoutArgs(f)`|Invoke `f`, which can be a global/static function or a functor. `f` must take no arguments. | |`InvokeWithoutArgs(object_pointer, &class::method)`|Invoke the method on the object, which takes no arguments. | |`InvokeArgument(arg1, arg2, ..., argk)`|Invoke the mock function's `N`-th (0-based) argument, which must be a function or a functor, with the `k` arguments.| The return value of the invoked function is used as the return value of the action. When defining a function or functor to be used with `Invoke*()`, you can declare any unused parameters as `Unused`: ``` double Distance(Unused, double x, double y) { return sqrt(x*x + y*y); } ... EXPECT_CALL(mock, Foo("Hi", _, _)).WillOnce(Invoke(Distance)); ``` In `InvokeArgument(...)`, if an argument needs to be passed by reference, wrap it inside `ByRef()`. For example, ``` InvokeArgument<2>(5, string("Hi"), ByRef(foo)) ``` calls the mock function's #2 argument, passing to it `5` and `string("Hi")` by value, and `foo` by reference. ## Default Action ## |`DoDefault()`|Do the default action (specified by `ON_CALL()` or the built-in one).| |:------------|:--------------------------------------------------------------------| **Note:** due to technical reasons, `DoDefault()` cannot be used inside a composite action - trying to do so will result in a run-time error. ## Composite Actions ## |`DoAll(a1, a2, ..., an)`|Do all actions `a1` to `an` and return the result of `an` in each invocation. The first `n - 1` sub-actions must return void. | |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------| |`IgnoreResult(a)` |Perform action `a` and ignore its result. `a` must not return void. | |`WithArg(a)` |Pass the `N`-th (0-based) argument of the mock function to action `a` and perform it. | |`WithArgs(a)`|Pass the selected (0-based) arguments of the mock function to action `a` and perform it. | |`WithoutArgs(a)` |Perform action `a` without any arguments. | ## Defining Actions ## | `ACTION(Sum) { return arg0 + arg1; }` | Defines an action `Sum()` to return the sum of the mock function's argument #0 and #1. | |:--------------------------------------|:---------------------------------------------------------------------------------------| | `ACTION_P(Plus, n) { return arg0 + n; }` | Defines an action `Plus(n)` to return the sum of the mock function's argument #0 and `n`. | | `ACTION_Pk(Foo, p1, ..., pk) { statements; }` | Defines a parameterized action `Foo(p1, ..., pk)` to execute the given `statements`. | The `ACTION*` macros cannot be used inside a function or class. # Cardinalities # These are used in `Times()` to specify how many times a mock function will be called: |`AnyNumber()`|The function can be called any number of times.| |:------------|:----------------------------------------------| |`AtLeast(n)` |The call is expected at least `n` times. | |`AtMost(n)` |The call is expected at most `n` times. | |`Between(m, n)`|The call is expected between `m` and `n` (inclusive) times.| |`Exactly(n) or n`|The call is expected exactly `n` times. In particular, the call should never happen when `n` is 0.| # Expectation Order # By default, the expectations can be matched in _any_ order. If some or all expectations must be matched in a given order, there are two ways to specify it. They can be used either independently or together. ## The After Clause ## ``` using ::testing::Expectation; ... Expectation init_x = EXPECT_CALL(foo, InitX()); Expectation init_y = EXPECT_CALL(foo, InitY()); EXPECT_CALL(foo, Bar()) .After(init_x, init_y); ``` says that `Bar()` can be called only after both `InitX()` and `InitY()` have been called. If you don't know how many pre-requisites an expectation has when you write it, you can use an `ExpectationSet` to collect them: ``` using ::testing::ExpectationSet; ... ExpectationSet all_inits; for (int i = 0; i < element_count; i++) { all_inits += EXPECT_CALL(foo, InitElement(i)); } EXPECT_CALL(foo, Bar()) .After(all_inits); ``` says that `Bar()` can be called only after all elements have been initialized (but we don't care about which elements get initialized before the others). Modifying an `ExpectationSet` after using it in an `.After()` doesn't affect the meaning of the `.After()`. ## Sequences ## When you have a long chain of sequential expectations, it's easier to specify the order using **sequences**, which don't require you to given each expectation in the chain a different name. All expected
calls in the same sequence must occur in the order they are specified. ``` using ::testing::Sequence; Sequence s1, s2; ... EXPECT_CALL(foo, Reset()) .InSequence(s1, s2) .WillOnce(Return(true)); EXPECT_CALL(foo, GetSize()) .InSequence(s1) .WillOnce(Return(1)); EXPECT_CALL(foo, Describe(A())) .InSequence(s2) .WillOnce(Return("dummy")); ``` says that `Reset()` must be called before _both_ `GetSize()` _and_ `Describe()`, and the latter two can occur in any order. To put many expectations in a sequence conveniently: ``` using ::testing::InSequence; { InSequence dummy; EXPECT_CALL(...)...; EXPECT_CALL(...)...; ... EXPECT_CALL(...)...; } ``` says that all expected calls in the scope of `dummy` must occur in strict order. The name `dummy` is irrelevant.) # Verifying and Resetting a Mock # Google Mock will verify the expectations on a mock object when it is destructed, or you can do it earlier: ``` using ::testing::Mock; ... // Verifies and removes the expectations on mock_obj; // returns true iff successful. Mock::VerifyAndClearExpectations(&mock_obj); ... // Verifies and removes the expectations on mock_obj; // also removes the default actions set by ON_CALL(); // returns true iff successful. Mock::VerifyAndClear(&mock_obj); ``` You can also tell Google Mock that a mock object can be leaked and doesn't need to be verified: ``` Mock::AllowLeak(&mock_obj); ``` # Mock Classes # Google Mock defines a convenient mock class template ``` class MockFunction { public: MOCK_METHODn(Call, R(A1, ..., An)); }; ``` See this [recipe](http://code.google.com/p/googlemock/wiki/V1_7_CookBook#Using_Check_Points) for one application of it. # Flags # | `--gmock_catch_leaked_mocks=0` | Don't report leaked mock objects as failures. | |:-------------------------------|:----------------------------------------------| | `--gmock_verbose=LEVEL` | Sets the default verbosity level (`info`, `warning`, or `error`) of Google Mock messages. |vendor/googletest/gtest-1.7.0/googlemock/docs/v1_7/CookBook.md000066400000000000000000003463461300002025200242000ustar00rootroot00000000000000 You can find recipes for using Google Mock here. If you haven't yet, please read the [ForDummies](V1_7_ForDummies.md) document first to make sure you understand the basics. **Note:** Google Mock lives in the `testing` name space. For readability, it is recommended to write `using ::testing::Foo;` once in your file before using the name `Foo` defined by Google Mock. We omit such `using` statements in this page for brevity, but you should do it in your own code. # Creating Mock Classes # ## Mocking Private or Protected Methods ## You must always put a mock method definition (`MOCK_METHOD*`) in a `public:` section of the mock class, regardless of the method being mocked being `public`, `protected`, or `private` in the base class. This allows `ON_CALL` and `EXPECT_CALL` to reference the mock function from outside of the mock class. (Yes, C++ allows a subclass to change the access level of a virtual function in the base class.) Example: ``` class Foo { public: ... virtual bool Transform(Gadget* g) = 0; protected: virtual void Resume(); private: virtual int GetTimeOut(); }; class MockFoo : public Foo { public: ... MOCK_METHOD1(Transform, bool(Gadget* g)); // The following must be in the public section, even though the // methods are protected or private in the base class. MOCK_METHOD0(Resume, void()); MOCK_METHOD0(GetTimeOut, int()); }; ``` ## Mocking Overloaded Methods ## You can mock overloaded functions as usual. No special attention is required: ``` class Foo { ... // Must be virtual as we'll inherit from Foo. virtual ~Foo(); // Overloaded on the types and/or numbers of arguments. virtual int Add(Element x); virtual int Add(int times, Element x); // Overloaded on the const-ness of this object. virtual Bar& GetBar(); virtual const Bar& GetBar() const; }; class MockFoo : public Foo { ... MOCK_METHOD1(Add, int(Element x)); MOCK_METHOD2(Add, int(int times, Element x); MOCK_METHOD0(GetBar, Bar&()); MOCK_CONST_METHOD0(GetBar, const Bar&()); }; ``` **Note:** if you don't mock all versions of the overloaded method, the compiler will give you a warning about some methods in the base class being hidden. To fix that, use `using` to bring them in scope: ``` class MockFoo : public Foo { ... using Foo::Add; MOCK_METHOD1(Add, int(Element x)); // We don't want to mock int Add(int times, Element x); ... }; ``` ## Mocking Class Templates ## To mock a class template, append `_T` to the `MOCK_*` macros: ``` template class StackInterface { ... // Must be virtual as we'll inherit from StackInterface. virtual ~StackInterface(); virtual int GetSize() const = 0; virtual void Push(const Elem& x) = 0; }; template class MockStack : public StackInterface { ... MOCK_CONST_METHOD0_T(GetSize, int()); MOCK_METHOD1_T(Push, void(const Elem& x)); }; ``` ## Mocking Nonvirtual Methods ## Google Mock can mock non-virtual functions to be used in what we call _hi-perf dependency injection_. In this case, instead of sharing a common base class with the real class, your mock class will be _unrelated_ to the real class, but contain methods with the same signatures. The syntax for mocking non-virtual methods is the _same_ as mocking virtual methods: ``` // A simple packet stream class. None of its members is virtual. class ConcretePacketStream { public: void AppendPacket(Packet* new_packet); const Packet* GetPacket(size_t packet_number) const; size_t NumberOfPackets() const; ... }; // A mock packet stream class. It inherits from no other, but defines // GetPacket() and NumberOfPackets(). class MockPacketStream { public: MOCK_CONST_METHOD1(GetPacket, const Packet*(size_t packet_number)); MOCK_CONST_METHOD0(NumberOfPackets, size_t()); ... }; ``` Note that the mock class doesn't define `AppendPacket()`, unlike the real class. That's fine as long as the test doesn't need to call it. Next, you need a way to say that you want to use `ConcretePacketStream` in production code, and use `MockPacketStream` in tests. Since the functions are not virtual and the two classes are unrelated, you must specify your choice at _compile time_ (as opposed to run time). One way to do it is to templatize your code that needs to use a packet stream. More specifically, you will give your code a template type argument for the type of the packet stream. In production, you will instantiate your template with `ConcretePacketStream` as the type argument. In tests, you will instantiate the same template with `MockPacketStream`. For example, you may write: ``` template void CreateConnection(PacketStream* stream) { ... } template class PacketReader { public: void ReadPackets(PacketStream* stream, size_t packet_num); }; ``` Then you can use `CreateConnection()` and `PacketReader` in production code, and use `CreateConnection()` and `PacketReader` in tests. ``` MockPacketStream mock_stream; EXPECT_CALL(mock_stream, ...)...; .. set more expectations on mock_stream ... PacketReader reader(&mock_stream); ... exercise reader ... ``` ## Mocking Free Functions ## It's possible to use Google Mock to mock a free function (i.e. a C-style function or a static method). You just need to rewrite your code to use an interface (abstract class). Instead of calling a free function (say, `OpenFile`) directly, introduce an interface for it and have a concrete subclass that calls the free function: ``` class FileInterface { public: ... virtual bool Open(const char* path, const char* mode) = 0; }; class File : public FileInterface { public: ... virtual bool Open(const char* path, const char* mode) { return OpenFile(path, mode); } }; ``` Your code should talk to `FileInterface` to open a file. Now it's easy to mock out the function. This may seem much hassle, but in practice you often have multiple related functions that you can put in the same interface, so the per-function syntactic overhead will be much lower. If you are concerned about the performance overhead incurred by virtual functions, and profiling confirms your concern, you can combine this with the recipe for [mocking non-virtual methods](#Mocking_Nonvirtual_Methods.md). ## The Nice, the Strict, and the Naggy ## If a mock method has no `EXPECT_CALL` spec but is called, Google Mock will print a warning about the "uninteresting call". The rationale is: * New methods may be added to an interface after a test is written. We shouldn't fail a test just because a method it doesn't know about is called. * However, this may also mean there's a bug in the test, so Google Mock shouldn't be silent either. If the user believes these calls are harmless, he can add an `EXPECT_CALL()` to suppress the warning. However, sometimes you may want to suppress all "uninteresting call" warnings, while sometimes you may want the opposite, i.e. to treat all of them as errors. Google Mock lets you make the decision on a per-mock-object basis. Suppose your test uses a mock class `MockFoo`: ``` TEST(...) { MockFoo mock_foo; EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... } ``` If a method of `mock_foo` other than `DoThis()` is called, it will be reported by Google Mock as a warning. However, if you rewrite your test to use `NiceMock` instead, the warning will be gone, resulting in a cleaner test output: ``` using ::testing::NiceMock; TEST(...) { NiceMock mock_foo; EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... } ``` `NiceMock` is a subclass of `MockFoo`, so it can be used wherever `MockFoo` is accepted. It also works if `MockFoo`'s constructor takes some arguments, as `NiceMock` "inherits" `MockFoo`'s constructors: ``` using ::testing::NiceMock; TEST(...) { NiceMock mock_foo(5, "hi"); // Calls MockFoo(5, "hi"). EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... } ``` The usage of `StrictMock` is similar, except that it makes all uninteresting calls failures: ``` using ::testing::StrictMock; TEST(...) { StrictMock mock_foo; EXPECT_CALL(mock_foo, DoThis()); ... code that uses mock_foo ... // The test will fail if a method of mock_foo other than DoThis() // is called. } ``` There are some caveats though (I don't like them just as much as the next guy, but sadly they are side effects of C++'s limitations): 1. `NiceMock` and `StrictMock` only work for mock methods defined using the `MOCK_METHOD*` family of macros **directly** in the `MockFoo` class. If a mock method is defined in a **base class** of `MockFoo`, the "nice" or "strict" modifier may not affect it, depending on the compiler. In particular, nesting `NiceMock` and `StrictMock` (e.g. `NiceMock >`) is **not** supported. 1. The constructors of the base mock (`MockFoo`) cannot have arguments passed by non-const reference, which happens to be banned by the [Google C++ style guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml). 1. During the constructor or destructor of `MockFoo`, the mock object is _not_ nice or strict. This may cause surprises if the constructor or destructor calls a mock method on `this` object. (This behavior, however, is consistent with C++'s general rule: if a constructor or destructor calls a virtual method of `this` object, that method is treated as non-virtual. In other words, to the base class's constructor or destructor, `this` object behaves like an instance of the base class, not the derived class. This rule is required for safety. Otherwise a base constructor may use members of a derived class before they are initialized, or a base destructor may use members of a derived class after they have been destroyed.) Finally, you should be **very cautious** about when to use naggy or strict mocks, as they tend to make tests more brittle and harder to maintain. When you refactor your code without changing its externally visible behavior, ideally you should't need to update any tests. If your code interacts with a naggy mock, however, you may start to get spammed with warnings as the result of your change. Worse, if your code interacts with a strict mock, your tests may start to fail and you'll be forced to fix them. Our general recommendation is to use nice mocks (not yet the default) most of the time, use naggy mocks (the current default) when developing or debugging tests, and use strict mocks only as the last resort. ## Simplifying the Interface without Breaking Existing Code ## Sometimes a method has a long list of arguments that is mostly uninteresting. For example, ``` class LogSink { public: ... virtual void send(LogSeverity severity, const char* full_filename, const char* base_filename, int line, const struct tm* tm_time, const char* message, size_t message_len) = 0; }; ``` This method's argument list is lengthy and hard to work with (let's say that the `message` argument is not even 0-terminated). If we mock it as is, using the mock will be awkward. If, however, we try to simplify this interface, we'll need to fix all clients depending on it, which is often infeasible. The trick is to re-dispatch the method in the mock class: ``` class ScopedMockLog : public LogSink { public: ... virtual void send(LogSeverity severity, const char* full_filename, const char* base_filename, int line, const tm* tm_time, const char* message, size_t message_len) { // We are only interested in the log severity, full file name, and // log message. Log(severity, full_filename, std::string(message, message_len)); } // Implements the mock method: // // void Log(LogSeverity severity, // const string& file_path, // const string& message); MOCK_METHOD3(Log, void(LogSeverity severity, const string& file_path, const string& message)); }; ``` By defining a new mock method with a trimmed argument list, we make the mock class much more user-friendly. ## Alternative to Mocking Concrete Classes ## Often you may find yourself using classes that don't implement interfaces. In order to test your code that uses such a class (let's call it `Concrete`), you may be tempted to make the methods of `Concrete` virtual and then mock it. Try not to do that. Making a non-virtual function virtual is a big decision. It creates an extension point where subclasses can tweak your class' behavior. This weakens your control on the class because now it's harder to maintain the class' invariants. You should make a function virtual only when there is a valid reason for a subclass to override it. Mocking concrete classes directly is problematic as it creates a tight coupling between the class and the tests - any small change in the class may invalidate your tests and make test maintenance a pain. To avoid such problems, many programmers have been practicing "coding to interfaces": instead of talking to the `Concrete` class, your code would define an interface and talk to it. Then you implement that interface as an adaptor on top of `Concrete`. In tests, you can easily mock that interface to observe how your code is doing. This technique incurs some overhead: * You pay the cost of virtual function calls (usually not a problem). * There is more abstraction for the programmers to learn. However, it can also bring significant benefits in addition to better testability: * `Concrete`'s API may not fit your problem domain very well, as you may not be the only client it tries to serve. By designing your own interface, you have a chance to tailor it to your need - you may add higher-level functionalities, rename stuff, etc instead of just trimming the class. This allows you to write your code (user of the interface) in a more natural way, which means it will be more readable, more maintainable, and you'll be more productive. * If `Concrete`'s implementation ever has to change, you don't have to rewrite everywhere it is used. Instead, you can absorb the change in your implementation of the interface, and your other code and tests will be insulated from this change. Some people worry that if everyone is practicing this technique, they will end up writing lots of redundant code. This concern is totally understandable. However, there are two reasons why it may not be the case: * Different projects may need to use `Concrete` in different ways, so the best interfaces for them will be different. Therefore, each of them will have its own domain-specific interface on top of `Concrete`, and they will not be the same code. * If enough projects want to use the same interface, they can always share it, just like they have been sharing `Concrete`. You can check in the interface and the adaptor somewhere near `Concrete` (perhaps in a `contrib` sub-directory) and let many projects use it. You need to weigh the pros and cons carefully for your particular problem, but I'd like to assure you that the Java community has been practicing this for a long time and it's a proven effective technique applicable in a wide variety of situations. :-) ## Delegating Calls to a Fake ## Some times you have a non-trivial fake implementation of an interface. For example: ``` class Foo { public: virtual ~Foo() {} virtual char DoThis(int n) = 0; virtual void DoThat(const char* s, int* p) = 0; }; class FakeFoo : public Foo { public: virtual char DoThis(int n) { return (n > 0) ? '+' : (n < 0) ? '-' : '0'; } virtual void DoThat(const char* s, int* p) { *p = strlen(s); } }; ``` Now you want to mock this interface such that you can set expectations on it. However, you also want to use `FakeFoo` for the default behavior, as duplicating it in the mock object is, well, a lot of work. When you define the mock class using Google Mock, you can have it delegate its default action to a fake class you already have, using this pattern: ``` using ::testing::_; using ::testing::Invoke; class MockFoo : public Foo { public: // Normal mock method definitions using Google Mock. MOCK_METHOD1(DoThis, char(int n)); MOCK_METHOD2(DoThat, void(const char* s, int* p)); // Delegates the default actions of the methods to a FakeFoo object. // This must be called *before* the custom ON_CALL() statements. void DelegateToFake() { ON_CALL(*this, DoThis(_)) .WillByDefault(Invoke(&fake_, &FakeFoo::DoThis)); ON_CALL(*this, DoThat(_, _)) .WillByDefault(Invoke(&fake_, &FakeFoo::DoThat)); } private: FakeFoo fake_; // Keeps an instance of the fake in the mock. }; ``` With that, you can use `MockFoo` in your tests as usual. Just remember that if you don't explicitly set an action in an `ON_CALL()` or `EXPECT_CALL()`, the fake will be called upon to do it: ``` using ::testing::_; TEST(AbcTest, Xyz) { MockFoo foo; foo.DelegateToFake(); // Enables the fake for delegation. // Put your ON_CALL(foo, ...)s here, if any. // No action specified, meaning to use the default action. EXPECT_CALL(foo, DoThis(5)); EXPECT_CALL(foo, DoThat(_, _)); int n = 0; EXPECT_EQ('+', foo.DoThis(5)); // FakeFoo::DoThis() is invoked. foo.DoThat("Hi", &n); // FakeFoo::DoThat() is invoked. EXPECT_EQ(2, n); } ``` **Some tips:** * If you want, you can still override the default action by providing your own `ON_CALL()` or using `.WillOnce()` / `.WillRepeatedly()` in `EXPECT_CALL()`. * In `DelegateToFake()`, you only need to delegate the methods whose fake implementation you intend to use. * The general technique discussed here works for overloaded methods, but you'll need to tell the compiler which version you mean. To disambiguate a mock function (the one you specify inside the parentheses of `ON_CALL()`), see the "Selecting Between Overloaded Functions" section on this page; to disambiguate a fake function (the one you place inside `Invoke()`), use a `static_cast` to specify the function's type. For instance, if class `Foo` has methods `char DoThis(int n)` and `bool DoThis(double x) const`, and you want to invoke the latter, you need to write `Invoke(&fake_, static_cast(&FakeFoo::DoThis))` instead of `Invoke(&fake_, &FakeFoo::DoThis)` (The strange-looking thing inside the angled brackets of `static_cast` is the type of a function pointer to the second `DoThis()` method.). * Having to mix a mock and a fake is often a sign of something gone wrong. Perhaps you haven't got used to the interaction-based way of testing yet. Or perhaps your interface is taking on too many roles and should be split up. Therefore, **don't abuse this**. We would only recommend to do it as an intermediate step when you are refactoring your code. Regarding the tip on mixing a mock and a fake, here's an example on why it may be a bad sign: Suppose you have a class `System` for low-level system operations. In particular, it does file and I/O operations. And suppose you want to test how your code uses `System` to do I/O, and you just want the file operations to work normally. If you mock out the entire `System` class, you'll have to provide a fake implementation for the file operation part, which suggests that `System` is taking on too many roles. Instead, you can define a `FileOps` interface and an `IOOps` interface and split `System`'s functionalities into the two. Then you can mock `IOOps` without mocking `FileOps`. ## Delegating Calls to a Real Object ## When using testing doubles (mocks, fakes, stubs, and etc), sometimes their behaviors will differ from those of the real objects. This difference could be either intentional (as in simulating an error such that you can test the error handling code) or unintentional. If your mocks have different behaviors than the real objects by mistake, you could end up with code that passes the tests but fails in production. You can use the _delegating-to-real_ technique to ensure that your mock has the same behavior as the real object while retaining the ability to validate calls. This technique is very similar to the delegating-to-fake technique, the difference being that we use a real object instead of a fake. Here's an example: ``` using ::testing::_; using ::testing::AtLeast; using ::testing::Invoke; class MockFoo : public Foo { public: MockFoo() { // By default, all calls are delegated to the real object. ON_CALL(*this, DoThis()) .WillByDefault(Invoke(&real_, &Foo::DoThis)); ON_CALL(*this, DoThat(_)) .WillByDefault(Invoke(&real_, &Foo::DoThat)); ... } MOCK_METHOD0(DoThis, ...); MOCK_METHOD1(DoThat, ...); ... private: Foo real_; }; ... MockFoo mock; EXPECT_CALL(mock, DoThis()) .Times(3); EXPECT_CALL(mock, DoThat("Hi")) .Times(AtLeast(1)); ... use mock in test ... ``` With this, Google Mock will verify that your code made the right calls (with the right arguments, in the right order, called the right number of times, etc), and a real object will answer the calls (so the behavior will be the same as in production). This gives you the best of both worlds. ## Delegating Calls to a Parent Class ## Ideally, you should code to interfaces, whose methods are all pure virtual. In reality, sometimes you do need to mock a virtual method that is not pure (i.e, it already has an implementation). For example: ``` class Foo { public: virtual ~Foo(); virtual void Pure(int n) = 0; virtual int Concrete(const char* str) { ... } }; class MockFoo : public Foo { public: // Mocking a pure method. MOCK_METHOD1(Pure, void(int n)); // Mocking a concrete method. Foo::Concrete() is shadowed. MOCK_METHOD1(Concrete, int(const char* str)); }; ``` Sometimes you may want to call `Foo::Concrete()` instead of `MockFoo::Concrete()`. Perhaps you want to do it as part of a stub action, or perhaps your test doesn't need to mock `Concrete()` at all (but it would be oh-so painful to have to define a new mock class whenever you don't need to mock one of its methods). The trick is to leave a back door in your mock class for accessing the real methods in the base class: ``` class MockFoo : public Foo { public: // Mocking a pure method. MOCK_METHOD1(Pure, void(int n)); // Mocking a concrete method. Foo::Concrete() is shadowed. MOCK_METHOD1(Concrete, int(const char* str)); // Use this to call Concrete() defined in Foo. int FooConcrete(const char* str) { return Foo::Concrete(str); } }; ``` Now, you can call `Foo::Concrete()` inside an action by: ``` using ::testing::_; using ::testing::Invoke; ... EXPECT_CALL(foo, Concrete(_)) .WillOnce(Invoke(&foo, &MockFoo::FooConcrete)); ``` or tell the mock object that you don't want to mock `Concrete()`: ``` using ::testing::Invoke; ... ON_CALL(foo, Concrete(_)) .WillByDefault(Invoke(&foo, &MockFoo::FooConcrete)); ``` (Why don't we just write `Invoke(&foo, &Foo::Concrete)`? If you do that, `MockFoo::Concrete()` will be called (and cause an infinite recursion) since `Foo::Concrete()` is virtual. That's just how C++ works.) # Using Matchers # ## Matching Argument Values Exactly ## You can specify exactly which arguments a mock method is expecting: ``` using ::testing::Return; ... EXPECT_CALL(foo, DoThis(5)) .WillOnce(Return('a')); EXPECT_CALL(foo, DoThat("Hello", bar)); ``` ## Using Simple Matchers ## You can use matchers to match arguments that have a certain property: ``` using ::testing::Ge; using ::testing::NotNull; using ::testing::Return; ... EXPECT_CALL(foo, DoThis(Ge(5))) // The argument must be >= 5. .WillOnce(Return('a')); EXPECT_CALL(foo, DoThat("Hello", NotNull())); // The second argument must not be NULL. ``` A frequently used matcher is `_`, which matches anything: ``` using ::testing::_; using ::testing::NotNull; ... EXPECT_CALL(foo, DoThat(_, NotNull())); ``` ## Combining Matchers ## You can build complex matchers from existing ones using `AllOf()`, `AnyOf()`, and `Not()`: ``` using ::testing::AllOf; using ::testing::Gt; using ::testing::HasSubstr; using ::testing::Ne; using ::testing::Not; ... // The argument must be > 5 and != 10. EXPECT_CALL(foo, DoThis(AllOf(Gt(5), Ne(10)))); // The first argument must not contain sub-string "blah". EXPECT_CALL(foo, DoThat(Not(HasSubstr("blah")), NULL)); ``` ## Casting Matchers ## Google Mock matchers are statically typed, meaning that the compiler can catch your mistake if you use a matcher of the wrong type (for example, if you use `Eq(5)` to match a `string` argument). Good for you! Sometimes, however, you know what you're doing and want the compiler to give you some slack. One example is that you have a matcher for `long` and the argument you want to match is `int`. While the two types aren't exactly the same, there is nothing really wrong with using a `Matcher` to match an `int` - after all, we can first convert the `int` argument to a `long` before giving it to the matcher. To support this need, Google Mock gives you the `SafeMatcherCast(m)` function. It casts a matcher `m` to type `Matcher`. To ensure safety, Google Mock checks that (let `U` be the type `m` accepts): 1. Type `T` can be implicitly cast to type `U`; 1. When both `T` and `U` are built-in arithmetic types (`bool`, integers, and floating-point numbers), the conversion from `T` to `U` is not lossy (in other words, any value representable by `T` can also be represented by `U`); and 1. When `U` is a reference, `T` must also be a reference (as the underlying matcher may be interested in the address of the `U` value). The code won't compile if any of these conditions isn't met. Here's one example: ``` using ::testing::SafeMatcherCast; // A base class and a child class. class Base { ... }; class Derived : public Base { ... }; class MockFoo : public Foo { public: MOCK_METHOD1(DoThis, void(Derived* derived)); }; ... MockFoo foo; // m is a Matcher we got from somewhere. EXPECT_CALL(foo, DoThis(SafeMatcherCast(m))); ``` If you find `SafeMatcherCast(m)` too limiting, you can use a similar function `MatcherCast(m)`. The difference is that `MatcherCast` works as long as you can `static_cast` type `T` to type `U`. `MatcherCast` essentially lets you bypass C++'s type system (`static_cast` isn't always safe as it could throw away information, for example), so be careful not to misuse/abuse it. ## Selecting Between Overloaded Functions ## If you expect an overloaded function to be called, the compiler may need some help on which overloaded version it is. To disambiguate functions overloaded on the const-ness of this object, use the `Const()` argument wrapper. ``` using ::testing::ReturnRef; class MockFoo : public Foo { ... MOCK_METHOD0(GetBar, Bar&()); MOCK_CONST_METHOD0(GetBar, const Bar&()); }; ... MockFoo foo; Bar bar1, bar2; EXPECT_CALL(foo, GetBar()) // The non-const GetBar(). .WillOnce(ReturnRef(bar1)); EXPECT_CALL(Const(foo), GetBar()) // The const GetBar(). .WillOnce(ReturnRef(bar2)); ``` (`Const()` is defined by Google Mock and returns a `const` reference to its argument.) To disambiguate overloaded functions with the same number of arguments but different argument types, you may need to specify the exact type of a matcher, either by wrapping your matcher in `Matcher()`, or using a matcher whose type is fixed (`TypedEq`, `An()`, etc): ``` using ::testing::An; using ::testing::Lt; using ::testing::Matcher; using ::testing::TypedEq; class MockPrinter : public Printer { public: MOCK_METHOD1(Print, void(int n)); MOCK_METHOD1(Print, void(char c)); }; TEST(PrinterTest, Print) { MockPrinter printer; EXPECT_CALL(printer, Print(An())); // void Print(int); EXPECT_CALL(printer, Print(Matcher(Lt(5)))); // void Print(int); EXPECT_CALL(printer, Print(TypedEq('a'))); // void Print(char); printer.Print(3); printer.Print(6); printer.Print('a'); } ``` ## Performing Different Actions Based on the Arguments ## When a mock method is called, the _last_ matching expectation that's still active will be selected (think "newer overrides older"). So, you can make a method do different things depending on its argument values like this: ``` using ::testing::_; using ::testing::Lt; using ::testing::Return; ... // The default case. EXPECT_CALL(foo, DoThis(_)) .WillRepeatedly(Return('b')); // The more specific case. EXPECT_CALL(foo, DoThis(Lt(5))) .WillRepeatedly(Return('a')); ``` Now, if `foo.DoThis()` is called with a value less than 5, `'a'` will be returned; otherwise `'b'` will be returned. ## Matching Multiple Arguments as a Whole ## Sometimes it's not enough to match the arguments individually. For example, we may want to say that the first argument must be less than the second argument. The `With()` clause allows us to match all arguments of a mock function as a whole. For example, ``` using ::testing::_; using ::testing::Lt; using ::testing::Ne; ... EXPECT_CALL(foo, InRange(Ne(0), _)) .With(Lt()); ``` says that the first argument of `InRange()` must not be 0, and must be less than the second argument. The expression inside `With()` must be a matcher of type `Matcher >`, where `A1`, ..., `An` are the types of the function arguments. You can also write `AllArgs(m)` instead of `m` inside `.With()`. The two forms are equivalent, but `.With(AllArgs(Lt()))` is more readable than `.With(Lt())`. You can use `Args(m)` to match the `n` selected arguments (as a tuple) against `m`. For example, ``` using ::testing::_; using ::testing::AllOf; using ::testing::Args; using ::testing::Lt; ... EXPECT_CALL(foo, Blah(_, _, _)) .With(AllOf(Args<0, 1>(Lt()), Args<1, 2>(Lt()))); ``` says that `Blah()` will be called with arguments `x`, `y`, and `z` where `x < y < z`. As a convenience and example, Google Mock provides some matchers for 2-tuples, including the `Lt()` matcher above. See the [CheatSheet](V1_7_CheatSheet.md) for the complete list. Note that if you want to pass the arguments to a predicate of your own (e.g. `.With(Args<0, 1>(Truly(&MyPredicate)))`), that predicate MUST be written to take a `tr1::tuple` as its argument; Google Mock will pass the `n` selected arguments as _one_ single tuple to the predicate. ## Using Matchers as Predicates ## Have you noticed that a matcher is just a fancy predicate that also knows how to describe itself? Many existing algorithms take predicates as arguments (e.g. those defined in STL's `` header), and it would be a shame if Google Mock matchers are not allowed to participate. Luckily, you can use a matcher where a unary predicate functor is expected by wrapping it inside the `Matches()` function. For example, ``` #include #include std::vector v; ... // How many elements in v are >= 10? const int count = count_if(v.begin(), v.end(), Matches(Ge(10))); ``` Since you can build complex matchers from simpler ones easily using Google Mock, this gives you a way to conveniently construct composite predicates (doing the same using STL's `` header is just painful). For example, here's a predicate that's satisfied by any number that is >= 0, <= 100, and != 50: ``` Matches(AllOf(Ge(0), Le(100), Ne(50))) ``` ## Using Matchers in Google Test Assertions ## Since matchers are basically predicates that also know how to describe themselves, there is a way to take advantage of them in [Google Test](http://code.google.com/p/googletest/) assertions. It's called `ASSERT_THAT` and `EXPECT_THAT`: ``` ASSERT_THAT(value, matcher); // Asserts that value matches matcher. EXPECT_THAT(value, matcher); // The non-fatal version. ``` For example, in a Google Test test you can write: ``` #include "gmock/gmock.h" using ::testing::AllOf; using ::testing::Ge; using ::testing::Le; using ::testing::MatchesRegex; using ::testing::StartsWith; ... EXPECT_THAT(Foo(), StartsWith("Hello")); EXPECT_THAT(Bar(), MatchesRegex("Line \\d+")); ASSERT_THAT(Baz(), AllOf(Ge(5), Le(10))); ``` which (as you can probably guess) executes `Foo()`, `Bar()`, and `Baz()`, and verifies that: * `Foo()` returns a string that starts with `"Hello"`. * `Bar()` returns a string that matches regular expression `"Line \\d+"`. * `Baz()` returns a number in the range [5, 10]. The nice thing about these macros is that _they read like English_. They generate informative messages too. For example, if the first `EXPECT_THAT()` above fails, the message will be something like: ``` Value of: Foo() Actual: "Hi, world!" Expected: starts with "Hello" ``` **Credit:** The idea of `(ASSERT|EXPECT)_THAT` was stolen from the [Hamcrest](http://code.google.com/p/hamcrest/) project, which adds `assertThat()` to JUnit. ## Using Predicates as Matchers ## Google Mock provides a built-in set of matchers. In case you find them lacking, you can use an arbitray unary predicate function or functor as a matcher - as long as the predicate accepts a value of the type you want. You do this by wrapping the predicate inside the `Truly()` function, for example: ``` using ::testing::Truly; int IsEven(int n) { return (n % 2) == 0 ? 1 : 0; } ... // Bar() must be called with an even number. EXPECT_CALL(foo, Bar(Truly(IsEven))); ``` Note that the predicate function / functor doesn't have to return `bool`. It works as long as the return value can be used as the condition in statement `if (condition) ...`. ## Matching Arguments that Are Not Copyable ## When you do an `EXPECT_CALL(mock_obj, Foo(bar))`, Google Mock saves away a copy of `bar`. When `Foo()` is called later, Google Mock compares the argument to `Foo()` with the saved copy of `bar`. This way, you don't need to worry about `bar` being modified or destroyed after the `EXPECT_CALL()` is executed. The same is true when you use matchers like `Eq(bar)`, `Le(bar)`, and so on. But what if `bar` cannot be copied (i.e. has no copy constructor)? You could define your own matcher function and use it with `Truly()`, as the previous couple of recipes have shown. Or, you may be able to get away from it if you can guarantee that `bar` won't be changed after the `EXPECT_CALL()` is executed. Just tell Google Mock that it should save a reference to `bar`, instead of a copy of it. Here's how: ``` using ::testing::Eq; using ::testing::ByRef; using ::testing::Lt; ... // Expects that Foo()'s argument == bar. EXPECT_CALL(mock_obj, Foo(Eq(ByRef(bar)))); // Expects that Foo()'s argument < bar. EXPECT_CALL(mock_obj, Foo(Lt(ByRef(bar)))); ``` Remember: if you do this, don't change `bar` after the `EXPECT_CALL()`, or the result is undefined. ## Validating a Member of an Object ## Often a mock function takes a reference to object as an argument. When matching the argument, you may not want to compare the entire object against a fixed object, as that may be over-specification. Instead, you may need to validate a certain member variable or the result of a certain getter method of the object. You can do this with `Field()` and `Property()`. More specifically, ``` Field(&Foo::bar, m) ``` is a matcher that matches a `Foo` object whose `bar` member variable satisfies matcher `m`. ``` Property(&Foo::baz, m) ``` is a matcher that matches a `Foo` object whose `baz()` method returns a value that satisfies matcher `m`. For example: > | `Field(&Foo::number, Ge(3))` | Matches `x` where `x.number >= 3`. | |:-----------------------------|:-----------------------------------| > | `Property(&Foo::name, StartsWith("John "))` | Matches `x` where `x.name()` starts with `"John "`. | Note that in `Property(&Foo::baz, ...)`, method `baz()` must take no argument and be declared as `const`. BTW, `Field()` and `Property()` can also match plain pointers to objects. For instance, ``` Field(&Foo::number, Ge(3)) ``` matches a plain pointer `p` where `p->number >= 3`. If `p` is `NULL`, the match will always fail regardless of the inner matcher. What if you want to validate more than one members at the same time? Remember that there is `AllOf()`. ## Validating the Value Pointed to by a Pointer Argument ## C++ functions often take pointers as arguments. You can use matchers like `IsNull()`, `NotNull()`, and other comparison matchers to match a pointer, but what if you want to make sure the value _pointed to_ by the pointer, instead of the pointer itself, has a certain property? Well, you can use the `Pointee(m)` matcher. `Pointee(m)` matches a pointer iff `m` matches the value the pointer points to. For example: ``` using ::testing::Ge; using ::testing::Pointee; ... EXPECT_CALL(foo, Bar(Pointee(Ge(3)))); ``` expects `foo.Bar()` to be called with a pointer that points to a value greater than or equal to 3. One nice thing about `Pointee()` is that it treats a `NULL` pointer as a match failure, so you can write `Pointee(m)` instead of ``` AllOf(NotNull(), Pointee(m)) ``` without worrying that a `NULL` pointer will crash your test. Also, did we tell you that `Pointee()` works with both raw pointers **and** smart pointers (`linked_ptr`, `shared_ptr`, `scoped_ptr`, and etc)? What if you have a pointer to pointer? You guessed it - you can use nested `Pointee()` to probe deeper inside the value. For example, `Pointee(Pointee(Lt(3)))` matches a pointer that points to a pointer that points to a number less than 3 (what a mouthful...). ## Testing a Certain Property of an Object ## Sometimes you want to specify that an object argument has a certain property, but there is no existing matcher that does this. If you want good error messages, you should define a matcher. If you want to do it quick and dirty, you could get away with writing an ordinary function. Let's say you have a mock function that takes an object of type `Foo`, which has an `int bar()` method and an `int baz()` method, and you want to constrain that the argument's `bar()` value plus its `baz()` value is a given number. Here's how you can define a matcher to do it: ``` using ::testing::MatcherInterface; using ::testing::MatchResultListener; class BarPlusBazEqMatcher : public MatcherInterface { public: explicit BarPlusBazEqMatcher(int expected_sum) : expected_sum_(expected_sum) {} virtual bool MatchAndExplain(const Foo& foo, MatchResultListener* listener) const { return (foo.bar() + foo.baz()) == expected_sum_; } virtual void DescribeTo(::std::ostream* os) const { *os << "bar() + baz() equals " << expected_sum_; } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "bar() + baz() does not equal " << expected_sum_; } private: const int expected_sum_; }; inline Matcher BarPlusBazEq(int expected_sum) { return MakeMatcher(new BarPlusBazEqMatcher(expected_sum)); } ... EXPECT_CALL(..., DoThis(BarPlusBazEq(5)))...; ``` ## Matching Containers ## Sometimes an STL container (e.g. list, vector, map, ...) is passed to a mock function and you may want to validate it. Since most STL containers support the `==` operator, you can write `Eq(expected_container)` or simply `expected_container` to match a container exactly. Sometimes, though, you may want to be more flexible (for example, the first element must be an exact match, but the second element can be any positive number, and so on). Also, containers used in tests often have a small number of elements, and having to define the expected container out-of-line is a bit of a hassle. You can use the `ElementsAre()` or `UnorderedElementsAre()` matcher in such cases: ``` using ::testing::_; using ::testing::ElementsAre; using ::testing::Gt; ... MOCK_METHOD1(Foo, void(const vector& numbers)); ... EXPECT_CALL(mock, Foo(ElementsAre(1, Gt(0), _, 5))); ``` The above matcher says that the container must have 4 elements, which must be 1, greater than 0, anything, and 5 respectively. If you instead write: ``` using ::testing::_; using ::testing::Gt; using ::testing::UnorderedElementsAre; ... MOCK_METHOD1(Foo, void(const vector& numbers)); ... EXPECT_CALL(mock, Foo(UnorderedElementsAre(1, Gt(0), _, 5))); ``` It means that the container must have 4 elements, which under some permutation must be 1, greater than 0, anything, and 5 respectively. `ElementsAre()` and `UnorderedElementsAre()` are overloaded to take 0 to 10 arguments. If more are needed, you can place them in a C-style array and use `ElementsAreArray()` or `UnorderedElementsAreArray()` instead: ``` using ::testing::ElementsAreArray; ... // ElementsAreArray accepts an array of element values. const int expected_vector1[] = { 1, 5, 2, 4, ... }; EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector1))); // Or, an array of element matchers. Matcher expected_vector2 = { 1, Gt(2), _, 3, ... }; EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector2))); ``` In case the array needs to be dynamically created (and therefore the array size cannot be inferred by the compiler), you can give `ElementsAreArray()` an additional argument to specify the array size: ``` using ::testing::ElementsAreArray; ... int* const expected_vector3 = new int[count]; ... fill expected_vector3 with values ... EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector3, count))); ``` **Tips:** * `ElementsAre*()` can be used to match _any_ container that implements the STL iterator pattern (i.e. it has a `const_iterator` type and supports `begin()/end()`), not just the ones defined in STL. It will even work with container types yet to be written - as long as they follows the above pattern. * You can use nested `ElementsAre*()` to match nested (multi-dimensional) containers. * If the container is passed by pointer instead of by reference, just write `Pointee(ElementsAre*(...))`. * The order of elements _matters_ for `ElementsAre*()`. Therefore don't use it with containers whose element order is undefined (e.g. `hash_map`). ## Sharing Matchers ## Under the hood, a Google Mock matcher object consists of a pointer to a ref-counted implementation object. Copying matchers is allowed and very efficient, as only the pointer is copied. When the last matcher that references the implementation object dies, the implementation object will be deleted. Therefore, if you have some complex matcher that you want to use again and again, there is no need to build it everytime. Just assign it to a matcher variable and use that variable repeatedly! For example, ``` Matcher in_range = AllOf(Gt(5), Le(10)); ... use in_range as a matcher in multiple EXPECT_CALLs ... ``` # Setting Expectations # ## Knowing When to Expect ## `ON_CALL` is likely the single most under-utilized construct in Google Mock. There are basically two constructs for defining the behavior of a mock object: `ON_CALL` and `EXPECT_CALL`. The difference? `ON_CALL` defines what happens when a mock method is called, but _doesn't imply any expectation on the method being called._ `EXPECT_CALL` not only defines the behavior, but also sets an expectation that _the method will be called with the given arguments, for the given number of times_ (and _in the given order_ when you specify the order too). Since `EXPECT_CALL` does more, isn't it better than `ON_CALL`? Not really. Every `EXPECT_CALL` adds a constraint on the behavior of the code under test. Having more constraints than necessary is _baaad_ - even worse than not having enough constraints. This may be counter-intuitive. How could tests that verify more be worse than tests that verify less? Isn't verification the whole point of tests? The answer, lies in _what_ a test should verify. **A good test verifies the contract of the code.** If a test over-specifies, it doesn't leave enough freedom to the implementation. As a result, changing the implementation without breaking the contract (e.g. refactoring and optimization), which should be perfectly fine to do, can break such tests. Then you have to spend time fixing them, only to see them broken again the next time the implementation is changed. Keep in mind that one doesn't have to verify more than one property in one test. In fact, **it's a good style to verify only one thing in one test.** If you do that, a bug will likely break only one or two tests instead of dozens (which case would you rather debug?). If you are also in the habit of giving tests descriptive names that tell what they verify, you can often easily guess what's wrong just from the test log itself. So use `ON_CALL` by default, and only use `EXPECT_CALL` when you actually intend to verify that the call is made. For example, you may have a bunch of `ON_CALL`s in your test fixture to set the common mock behavior shared by all tests in the same group, and write (scarcely) different `EXPECT_CALL`s in different `TEST_F`s to verify different aspects of the code's behavior. Compared with the style where each `TEST` has many `EXPECT_CALL`s, this leads to tests that are more resilient to implementational changes (and thus less likely to require maintenance) and makes the intent of the tests more obvious (so they are easier to maintain when you do need to maintain them). ## Ignoring Uninteresting Calls ## If you are not interested in how a mock method is called, just don't say anything about it. In this case, if the method is ever called, Google Mock will perform its default action to allow the test program to continue. If you are not happy with the default action taken by Google Mock, you can override it using `DefaultValue::Set()` (described later in this document) or `ON_CALL()`. Please note that once you expressed interest in a particular mock method (via `EXPECT_CALL()`), all invocations to it must match some expectation. If this function is called but the arguments don't match any `EXPECT_CALL()` statement, it will be an error. ## Disallowing Unexpected Calls ## If a mock method shouldn't be called at all, explicitly say so: ``` using ::testing::_; ... EXPECT_CALL(foo, Bar(_)) .Times(0); ``` If some calls to the method are allowed, but the rest are not, just list all the expected calls: ``` using ::testing::AnyNumber; using ::testing::Gt; ... EXPECT_CALL(foo, Bar(5)); EXPECT_CALL(foo, Bar(Gt(10))) .Times(AnyNumber()); ``` A call to `foo.Bar()` that doesn't match any of the `EXPECT_CALL()` statements will be an error. ## Expecting Ordered Calls ## Although an `EXPECT_CALL()` statement defined earlier takes precedence when Google Mock tries to match a function call with an expectation, by default calls don't have to happen in the order `EXPECT_CALL()` statements are written. For example, if the arguments match the matchers in the third `EXPECT_CALL()`, but not those in the first two, then the third expectation will be used. If you would rather have all calls occur in the order of the expectations, put the `EXPECT_CALL()` statements in a block where you define a variable of type `InSequence`: ``` using ::testing::_; using ::testing::InSequence; { InSequence s; EXPECT_CALL(foo, DoThis(5)); EXPECT_CALL(bar, DoThat(_)) .Times(2); EXPECT_CALL(foo, DoThis(6)); } ``` In this example, we expect a call to `foo.DoThis(5)`, followed by two calls to `bar.DoThat()` where the argument can be anything, which are in turn followed by a call to `foo.DoThis(6)`. If a call occurred out-of-order, Google Mock will report an error. ## Expecting Partially Ordered Calls ## Sometimes requiring everything to occur in a predetermined order can lead to brittle tests. For example, we may care about `A` occurring before both `B` and `C`, but aren't interested in the relative order of `B` and `C`. In this case, the test should reflect our real intent, instead of being overly constraining. Google Mock allows you to impose an arbitrary DAG (directed acyclic graph) on the calls. One way to express the DAG is to use the [After](http://code.google.com/p/googlemock/wiki/V1_7_CheatSheet#The_After_Clause) clause of `EXPECT_CALL`. Another way is via the `InSequence()` clause (not the same as the `InSequence` class), which we borrowed from jMock 2. It's less flexible than `After()`, but more convenient when you have long chains of sequential calls, as it doesn't require you to come up with different names for the expectations in the chains. Here's how it works: If we view `EXPECT_CALL()` statements as nodes in a graph, and add an edge from node A to node B wherever A must occur before B, we can get a DAG. We use the term "sequence" to mean a directed path in this DAG. Now, if we decompose the DAG into sequences, we just need to know which sequences each `EXPECT_CALL()` belongs to in order to be able to reconstruct the orginal DAG. So, to specify the partial order on the expectations we need to do two things: first to define some `Sequence` objects, and then for each `EXPECT_CALL()` say which `Sequence` objects it is part of. Expectations in the same sequence must occur in the order they are written. For example, ``` using ::testing::Sequence; Sequence s1, s2; EXPECT_CALL(foo, A()) .InSequence(s1, s2); EXPECT_CALL(bar, B()) .InSequence(s1); EXPECT_CALL(bar, C()) .InSequence(s2); EXPECT_CALL(foo, D()) .InSequence(s2); ``` specifies the following DAG (where `s1` is `A -> B`, and `s2` is `A -> C -> D`): ``` +---> B | A ---| | +---> C ---> D ``` This means that A must occur before B and C, and C must occur before D. There's no restriction about the order other than these. ## Controlling When an Expectation Retires ## When a mock method is called, Google Mock only consider expectations that are still active. An expectation is active when created, and becomes inactive (aka _retires_) when a call that has to occur later has occurred. For example, in ``` using ::testing::_; using ::testing::Sequence; Sequence s1, s2; EXPECT_CALL(log, Log(WARNING, _, "File too large.")) // #1 .Times(AnyNumber()) .InSequence(s1, s2); EXPECT_CALL(log, Log(WARNING, _, "Data set is empty.")) // #2 .InSequence(s1); EXPECT_CALL(log, Log(WARNING, _, "User not found.")) // #3 .InSequence(s2); ``` as soon as either #2 or #3 is matched, #1 will retire. If a warning `"File too large."` is logged after this, it will be an error. Note that an expectation doesn't retire automatically when it's saturated. For example, ``` using ::testing::_; ... EXPECT_CALL(log, Log(WARNING, _, _)); // #1 EXPECT_CALL(log, Log(WARNING, _, "File too large.")); // #2 ``` says that there will be exactly one warning with the message `"File too large."`. If the second warning contains this message too, #2 will match again and result in an upper-bound-violated error. If this is not what you want, you can ask an expectation to retire as soon as it becomes saturated: ``` using ::testing::_; ... EXPECT_CALL(log, Log(WARNING, _, _)); // #1 EXPECT_CALL(log, Log(WARNING, _, "File too large.")) // #2 .RetiresOnSaturation(); ``` Here #2 can be used only once, so if you have two warnings with the message `"File too large."`, the first will match #2 and the second will match #1 - there will be no error. # Using Actions # ## Returning References from Mock Methods ## If a mock function's return type is a reference, you need to use `ReturnRef()` instead of `Return()` to return a result: ``` using ::testing::ReturnRef; class MockFoo : public Foo { public: MOCK_METHOD0(GetBar, Bar&()); }; ... MockFoo foo; Bar bar; EXPECT_CALL(foo, GetBar()) .WillOnce(ReturnRef(bar)); ``` ## Returning Live Values from Mock Methods ## The `Return(x)` action saves a copy of `x` when the action is _created_, and always returns the same value whenever it's executed. Sometimes you may want to instead return the _live_ value of `x` (i.e. its value at the time when the action is _executed_.). If the mock function's return type is a reference, you can do it using `ReturnRef(x)`, as shown in the previous recipe ("Returning References from Mock Methods"). However, Google Mock doesn't let you use `ReturnRef()` in a mock function whose return type is not a reference, as doing that usually indicates a user error. So, what shall you do? You may be tempted to try `ByRef()`: ``` using testing::ByRef; using testing::Return; class MockFoo : public Foo { public: MOCK_METHOD0(GetValue, int()); }; ... int x = 0; MockFoo foo; EXPECT_CALL(foo, GetValue()) .WillRepeatedly(Return(ByRef(x))); x = 42; EXPECT_EQ(42, foo.GetValue()); ``` Unfortunately, it doesn't work here. The above code will fail with error: ``` Value of: foo.GetValue() Actual: 0 Expected: 42 ``` The reason is that `Return(value)` converts `value` to the actual return type of the mock function at the time when the action is _created_, not when it is _executed_. (This behavior was chosen for the action to be safe when `value` is a proxy object that references some temporary objects.) As a result, `ByRef(x)` is converted to an `int` value (instead of a `const int&`) when the expectation is set, and `Return(ByRef(x))` will always return 0. `ReturnPointee(pointer)` was provided to solve this problem specifically. It returns the value pointed to by `pointer` at the time the action is _executed_: ``` using testing::ReturnPointee; ... int x = 0; MockFoo foo; EXPECT_CALL(foo, GetValue()) .WillRepeatedly(ReturnPointee(&x)); // Note the & here. x = 42; EXPECT_EQ(42, foo.GetValue()); // This will succeed now. ``` ## Combining Actions ## Want to do more than one thing when a function is called? That's fine. `DoAll()` allow you to do sequence of actions every time. Only the return value of the last action in the sequence will be used. ``` using ::testing::DoAll; class MockFoo : public Foo { public: MOCK_METHOD1(Bar, bool(int n)); }; ... EXPECT_CALL(foo, Bar(_)) .WillOnce(DoAll(action_1, action_2, ... action_n)); ``` ## Mocking Side Effects ## Sometimes a method exhibits its effect not via returning a value but via side effects. For example, it may change some global state or modify an output argument. To mock side effects, in general you can define your own action by implementing `::testing::ActionInterface`. If all you need to do is to change an output argument, the built-in `SetArgPointee()` action is convenient: ``` using ::testing::SetArgPointee; class MockMutator : public Mutator { public: MOCK_METHOD2(Mutate, void(bool mutate, int* value)); ... }; ... MockMutator mutator; EXPECT_CALL(mutator, Mutate(true, _)) .WillOnce(SetArgPointee<1>(5)); ``` In this example, when `mutator.Mutate()` is called, we will assign 5 to the `int` variable pointed to by argument #1 (0-based). `SetArgPointee()` conveniently makes an internal copy of the value you pass to it, removing the need to keep the value in scope and alive. The implication however is that the value must have a copy constructor and assignment operator. If the mock method also needs to return a value as well, you can chain `SetArgPointee()` with `Return()` using `DoAll()`: ``` using ::testing::_; using ::testing::Return; using ::testing::SetArgPointee; class MockMutator : public Mutator { public: ... MOCK_METHOD1(MutateInt, bool(int* value)); }; ... MockMutator mutator; EXPECT_CALL(mutator, MutateInt(_)) .WillOnce(DoAll(SetArgPointee<0>(5), Return(true))); ``` If the output argument is an array, use the `SetArrayArgument(first, last)` action instead. It copies the elements in source range `[first, last)` to the array pointed to by the `N`-th (0-based) argument: ``` using ::testing::NotNull; using ::testing::SetArrayArgument; class MockArrayMutator : public ArrayMutator { public: MOCK_METHOD2(Mutate, void(int* values, int num_values)); ... }; ... MockArrayMutator mutator; int values[5] = { 1, 2, 3, 4, 5 }; EXPECT_CALL(mutator, Mutate(NotNull(), 5)) .WillOnce(SetArrayArgument<0>(values, values + 5)); ``` This also works when the argument is an output iterator: ``` using ::testing::_; using ::testing::SeArrayArgument; class MockRolodex : public Rolodex { public: MOCK_METHOD1(GetNames, void(std::back_insert_iterator >)); ... }; ... MockRolodex rolodex; vector names; names.push_back("George"); names.push_back("John"); names.push_back("Thomas"); EXPECT_CALL(rolodex, GetNames(_)) .WillOnce(SetArrayArgument<0>(names.begin(), names.end())); ``` ## Changing a Mock Object's Behavior Based on the State ## If you expect a call to change the behavior of a mock object, you can use `::testing::InSequence` to specify different behaviors before and after the call: ``` using ::testing::InSequence; using ::testing::Return; ... { InSequence seq; EXPECT_CALL(my_mock, IsDirty()) .WillRepeatedly(Return(true)); EXPECT_CALL(my_mock, Flush()); EXPECT_CALL(my_mock, IsDirty()) .WillRepeatedly(Return(false)); } my_mock.FlushIfDirty(); ``` This makes `my_mock.IsDirty()` return `true` before `my_mock.Flush()` is called and return `false` afterwards. If the behavior change is more complex, you can store the effects in a variable and make a mock method get its return value from that variable: ``` using ::testing::_; using ::testing::SaveArg; using ::testing::Return; ACTION_P(ReturnPointee, p) { return *p; } ... int previous_value = 0; EXPECT_CALL(my_mock, GetPrevValue()) .WillRepeatedly(ReturnPointee(&previous_value)); EXPECT_CALL(my_mock, UpdateValue(_)) .WillRepeatedly(SaveArg<0>(&previous_value)); my_mock.DoSomethingToUpdateValue(); ``` Here `my_mock.GetPrevValue()` will always return the argument of the last `UpdateValue()` call. ## Setting the Default Value for a Return Type ## If a mock method's return type is a built-in C++ type or pointer, by default it will return 0 when invoked. You only need to specify an action if this default value doesn't work for you. Sometimes, you may want to change this default value, or you may want to specify a default value for types Google Mock doesn't know about. You can do this using the `::testing::DefaultValue` class template: ``` class MockFoo : public Foo { public: MOCK_METHOD0(CalculateBar, Bar()); }; ... Bar default_bar; // Sets the default return value for type Bar. DefaultValue::Set(default_bar); MockFoo foo; // We don't need to specify an action here, as the default // return value works for us. EXPECT_CALL(foo, CalculateBar()); foo.CalculateBar(); // This should return default_bar. // Unsets the default return value. DefaultValue::Clear(); ``` Please note that changing the default value for a type can make you tests hard to understand. We recommend you to use this feature judiciously. For example, you may want to make sure the `Set()` and `Clear()` calls are right next to the code that uses your mock. ## Setting the Default Actions for a Mock Method ## You've learned how to change the default value of a given type. However, this may be too coarse for your purpose: perhaps you have two mock methods with the same return type and you want them to have different behaviors. The `ON_CALL()` macro allows you to customize your mock's behavior at the method level: ``` using ::testing::_; using ::testing::AnyNumber; using ::testing::Gt; using ::testing::Return; ... ON_CALL(foo, Sign(_)) .WillByDefault(Return(-1)); ON_CALL(foo, Sign(0)) .WillByDefault(Return(0)); ON_CALL(foo, Sign(Gt(0))) .WillByDefault(Return(1)); EXPECT_CALL(foo, Sign(_)) .Times(AnyNumber()); foo.Sign(5); // This should return 1. foo.Sign(-9); // This should return -1. foo.Sign(0); // This should return 0. ``` As you may have guessed, when there are more than one `ON_CALL()` statements, the news order take precedence over the older ones. In other words, the **last** one that matches the function arguments will be used. This matching order allows you to set up the common behavior in a mock object's constructor or the test fixture's set-up phase and specialize the mock's behavior later. ## Using Functions/Methods/Functors as Actions ## If the built-in actions don't suit you, you can easily use an existing function, method, or functor as an action: ``` using ::testing::_; using ::testing::Invoke; class MockFoo : public Foo { public: MOCK_METHOD2(Sum, int(int x, int y)); MOCK_METHOD1(ComplexJob, bool(int x)); }; int CalculateSum(int x, int y) { return x + y; } class Helper { public: bool ComplexJob(int x); }; ... MockFoo foo; Helper helper; EXPECT_CALL(foo, Sum(_, _)) .WillOnce(Invoke(CalculateSum)); EXPECT_CALL(foo, ComplexJob(_)) .WillOnce(Invoke(&helper, &Helper::ComplexJob)); foo.Sum(5, 6); // Invokes CalculateSum(5, 6). foo.ComplexJob(10); // Invokes helper.ComplexJob(10); ``` The only requirement is that the type of the function, etc must be _compatible_ with the signature of the mock function, meaning that the latter's arguments can be implicitly converted to the corresponding arguments of the former, and the former's return type can be implicitly converted to that of the latter. So, you can invoke something whose type is _not_ exactly the same as the mock function, as long as it's safe to do so - nice, huh? ## Invoking a Function/Method/Functor Without Arguments ## `Invoke()` is very useful for doing actions that are more complex. It passes the mock function's arguments to the function or functor being invoked such that the callee has the full context of the call to work with. If the invoked function is not interested in some or all of the arguments, it can simply ignore them. Yet, a common pattern is that a test author wants to invoke a function without the arguments of the mock function. `Invoke()` allows her to do that using a wrapper function that throws away the arguments before invoking an underlining nullary function. Needless to say, this can be tedious and obscures the intent of the test. `InvokeWithoutArgs()` solves this problem. It's like `Invoke()` except that it doesn't pass the mock function's arguments to the callee. Here's an example: ``` using ::testing::_; using ::testing::InvokeWithoutArgs; class MockFoo : public Foo { public: MOCK_METHOD1(ComplexJob, bool(int n)); }; bool Job1() { ... } ... MockFoo foo; EXPECT_CALL(foo, ComplexJob(_)) .WillOnce(InvokeWithoutArgs(Job1)); foo.ComplexJob(10); // Invokes Job1(). ``` ## Invoking an Argument of the Mock Function ## Sometimes a mock function will receive a function pointer or a functor (in other words, a "callable") as an argument, e.g. ``` class MockFoo : public Foo { public: MOCK_METHOD2(DoThis, bool(int n, bool (*fp)(int))); }; ``` and you may want to invoke this callable argument: ``` using ::testing::_; ... MockFoo foo; EXPECT_CALL(foo, DoThis(_, _)) .WillOnce(...); // Will execute (*fp)(5), where fp is the // second argument DoThis() receives. ``` Arghh, you need to refer to a mock function argument but C++ has no lambda (yet), so you have to define your own action. :-( Or do you really? Well, Google Mock has an action to solve _exactly_ this problem: ``` InvokeArgument(arg_1, arg_2, ..., arg_m) ``` will invoke the `N`-th (0-based) argument the mock function receives, with `arg_1`, `arg_2`, ..., and `arg_m`. No matter if the argument is a function pointer or a functor, Google Mock handles them both. With that, you could write: ``` using ::testing::_; using ::testing::InvokeArgument; ... EXPECT_CALL(foo, DoThis(_, _)) .WillOnce(InvokeArgument<1>(5)); // Will execute (*fp)(5), where fp is the // second argument DoThis() receives. ``` What if the callable takes an argument by reference? No problem - just wrap it inside `ByRef()`: ``` ... MOCK_METHOD1(Bar, bool(bool (*fp)(int, const Helper&))); ... using ::testing::_; using ::testing::ByRef; using ::testing::InvokeArgument; ... MockFoo foo; Helper helper; ... EXPECT_CALL(foo, Bar(_)) .WillOnce(InvokeArgument<0>(5, ByRef(helper))); // ByRef(helper) guarantees that a reference to helper, not a copy of it, // will be passed to the callable. ``` What if the callable takes an argument by reference and we do **not** wrap the argument in `ByRef()`? Then `InvokeArgument()` will _make a copy_ of the argument, and pass a _reference to the copy_, instead of a reference to the original value, to the callable. This is especially handy when the argument is a temporary value: ``` ... MOCK_METHOD1(DoThat, bool(bool (*f)(const double& x, const string& s))); ... using ::testing::_; using ::testing::InvokeArgument; ... MockFoo foo; ... EXPECT_CALL(foo, DoThat(_)) .WillOnce(InvokeArgument<0>(5.0, string("Hi"))); // Will execute (*f)(5.0, string("Hi")), where f is the function pointer // DoThat() receives. Note that the values 5.0 and string("Hi") are // temporary and dead once the EXPECT_CALL() statement finishes. Yet // it's fine to perform this action later, since a copy of the values // are kept inside the InvokeArgument action. ``` ## Ignoring an Action's Result ## Sometimes you have an action that returns _something_, but you need an action that returns `void` (perhaps you want to use it in a mock function that returns `void`, or perhaps it needs to be used in `DoAll()` and it's not the last in the list). `IgnoreResult()` lets you do that. For example: ``` using ::testing::_; using ::testing::Invoke; using ::testing::Return; int Process(const MyData& data); string DoSomething(); class MockFoo : public Foo { public: MOCK_METHOD1(Abc, void(const MyData& data)); MOCK_METHOD0(Xyz, bool()); }; ... MockFoo foo; EXPECT_CALL(foo, Abc(_)) // .WillOnce(Invoke(Process)); // The above line won't compile as Process() returns int but Abc() needs // to return void. .WillOnce(IgnoreResult(Invoke(Process))); EXPECT_CALL(foo, Xyz()) .WillOnce(DoAll(IgnoreResult(Invoke(DoSomething)), // Ignores the string DoSomething() returns. Return(true))); ``` Note that you **cannot** use `IgnoreResult()` on an action that already returns `void`. Doing so will lead to ugly compiler errors. ## Selecting an Action's Arguments ## Say you have a mock function `Foo()` that takes seven arguments, and you have a custom action that you want to invoke when `Foo()` is called. Trouble is, the custom action only wants three arguments: ``` using ::testing::_; using ::testing::Invoke; ... MOCK_METHOD7(Foo, bool(bool visible, const string& name, int x, int y, const map, double>& weight, double min_weight, double max_wight)); ... bool IsVisibleInQuadrant1(bool visible, int x, int y) { return visible && x >= 0 && y >= 0; } ... EXPECT_CALL(mock, Foo(_, _, _, _, _, _, _)) .WillOnce(Invoke(IsVisibleInQuadrant1)); // Uh, won't compile. :-( ``` To please the compiler God, you can to define an "adaptor" that has the same signature as `Foo()` and calls the custom action with the right arguments: ``` using ::testing::_; using ::testing::Invoke; bool MyIsVisibleInQuadrant1(bool visible, const string& name, int x, int y, const map, double>& weight, double min_weight, double max_wight) { return IsVisibleInQuadrant1(visible, x, y); } ... EXPECT_CALL(mock, Foo(_, _, _, _, _, _, _)) .WillOnce(Invoke(MyIsVisibleInQuadrant1)); // Now it works. ``` But isn't this awkward? Google Mock provides a generic _action adaptor_, so you can spend your time minding more important business than writing your own adaptors. Here's the syntax: ``` WithArgs(action) ``` creates an action that passes the arguments of the mock function at the given indices (0-based) to the inner `action` and performs it. Using `WithArgs`, our original example can be written as: ``` using ::testing::_; using ::testing::Invoke; using ::testing::WithArgs; ... EXPECT_CALL(mock, Foo(_, _, _, _, _, _, _)) .WillOnce(WithArgs<0, 2, 3>(Invoke(IsVisibleInQuadrant1))); // No need to define your own adaptor. ``` For better readability, Google Mock also gives you: * `WithoutArgs(action)` when the inner `action` takes _no_ argument, and * `WithArg(action)` (no `s` after `Arg`) when the inner `action` takes _one_ argument. As you may have realized, `InvokeWithoutArgs(...)` is just syntactic sugar for `WithoutArgs(Inovke(...))`. Here are more tips: * The inner action used in `WithArgs` and friends does not have to be `Invoke()` -- it can be anything. * You can repeat an argument in the argument list if necessary, e.g. `WithArgs<2, 3, 3, 5>(...)`. * You can change the order of the arguments, e.g. `WithArgs<3, 2, 1>(...)`. * The types of the selected arguments do _not_ have to match the signature of the inner action exactly. It works as long as they can be implicitly converted to the corresponding arguments of the inner action. For example, if the 4-th argument of the mock function is an `int` and `my_action` takes a `double`, `WithArg<4>(my_action)` will work. ## Ignoring Arguments in Action Functions ## The selecting-an-action's-arguments recipe showed us one way to make a mock function and an action with incompatible argument lists fit together. The downside is that wrapping the action in `WithArgs<...>()` can get tedious for people writing the tests. If you are defining a function, method, or functor to be used with `Invoke*()`, and you are not interested in some of its arguments, an alternative to `WithArgs` is to declare the uninteresting arguments as `Unused`. This makes the definition less cluttered and less fragile in case the types of the uninteresting arguments change. It could also increase the chance the action function can be reused. For example, given ``` MOCK_METHOD3(Foo, double(const string& label, double x, double y)); MOCK_METHOD3(Bar, double(int index, double x, double y)); ``` instead of ``` using ::testing::_; using ::testing::Invoke; double DistanceToOriginWithLabel(const string& label, double x, double y) { return sqrt(x*x + y*y); } double DistanceToOriginWithIndex(int index, double x, double y) { return sqrt(x*x + y*y); } ... EXEPCT_CALL(mock, Foo("abc", _, _)) .WillOnce(Invoke(DistanceToOriginWithLabel)); EXEPCT_CALL(mock, Bar(5, _, _)) .WillOnce(Invoke(DistanceToOriginWithIndex)); ``` you could write ``` using ::testing::_; using ::testing::Invoke; using ::testing::Unused; double DistanceToOrigin(Unused, double x, double y) { return sqrt(x*x + y*y); } ... EXEPCT_CALL(mock, Foo("abc", _, _)) .WillOnce(Invoke(DistanceToOrigin)); EXEPCT_CALL(mock, Bar(5, _, _)) .WillOnce(Invoke(DistanceToOrigin)); ``` ## Sharing Actions ## Just like matchers, a Google Mock action object consists of a pointer to a ref-counted implementation object. Therefore copying actions is also allowed and very efficient. When the last action that references the implementation object dies, the implementation object will be deleted. If you have some complex action that you want to use again and again, you may not have to build it from scratch everytime. If the action doesn't have an internal state (i.e. if it always does the same thing no matter how many times it has been called), you can assign it to an action variable and use that variable repeatedly. For example: ``` Action set_flag = DoAll(SetArgPointee<0>(5), Return(true)); ... use set_flag in .WillOnce() and .WillRepeatedly() ... ``` However, if the action has its own state, you may be surprised if you share the action object. Suppose you have an action factory `IncrementCounter(init)` which creates an action that increments and returns a counter whose initial value is `init`, using two actions created from the same expression and using a shared action will exihibit different behaviors. Example: ``` EXPECT_CALL(foo, DoThis()) .WillRepeatedly(IncrementCounter(0)); EXPECT_CALL(foo, DoThat()) .WillRepeatedly(IncrementCounter(0)); foo.DoThis(); // Returns 1. foo.DoThis(); // Returns 2. foo.DoThat(); // Returns 1 - Blah() uses a different // counter than Bar()'s. ``` versus ``` Action increment = IncrementCounter(0); EXPECT_CALL(foo, DoThis()) .WillRepeatedly(increment); EXPECT_CALL(foo, DoThat()) .WillRepeatedly(increment); foo.DoThis(); // Returns 1. foo.DoThis(); // Returns 2. foo.DoThat(); // Returns 3 - the counter is shared. ``` # Misc Recipes on Using Google Mock # ## Making the Compilation Faster ## Believe it or not, the _vast majority_ of the time spent on compiling a mock class is in generating its constructor and destructor, as they perform non-trivial tasks (e.g. verification of the expectations). What's more, mock methods with different signatures have different types and thus their constructors/destructors need to be generated by the compiler separately. As a result, if you mock many different types of methods, compiling your mock class can get really slow. If you are experiencing slow compilation, you can move the definition of your mock class' constructor and destructor out of the class body and into a `.cpp` file. This way, even if you `#include` your mock class in N files, the compiler only needs to generate its constructor and destructor once, resulting in a much faster compilation. Let's illustrate the idea using an example. Here's the definition of a mock class before applying this recipe: ``` // File mock_foo.h. ... class MockFoo : public Foo { public: // Since we don't declare the constructor or the destructor, // the compiler will generate them in every translation unit // where this mock class is used. MOCK_METHOD0(DoThis, int()); MOCK_METHOD1(DoThat, bool(const char* str)); ... more mock methods ... }; ``` After the change, it would look like: ``` // File mock_foo.h. ... class MockFoo : public Foo { public: // The constructor and destructor are declared, but not defined, here. MockFoo(); virtual ~MockFoo(); MOCK_METHOD0(DoThis, int()); MOCK_METHOD1(DoThat, bool(const char* str)); ... more mock methods ... }; ``` and ``` // File mock_foo.cpp. #include "path/to/mock_foo.h" // The definitions may appear trivial, but the functions actually do a // lot of things through the constructors/destructors of the member // variables used to implement the mock methods. MockFoo::MockFoo() {} MockFoo::~MockFoo() {} ``` ## Forcing a Verification ## When it's being destoyed, your friendly mock object will automatically verify that all expectations on it have been satisfied, and will generate [Google Test](http://code.google.com/p/googletest/) failures if not. This is convenient as it leaves you with one less thing to worry about. That is, unless you are not sure if your mock object will be destoyed. How could it be that your mock object won't eventually be destroyed? Well, it might be created on the heap and owned by the code you are testing. Suppose there's a bug in that code and it doesn't delete the mock object properly - you could end up with a passing test when there's actually a bug. Using a heap checker is a good idea and can alleviate the concern, but its implementation may not be 100% reliable. So, sometimes you do want to _force_ Google Mock to verify a mock object before it is (hopefully) destructed. You can do this with `Mock::VerifyAndClearExpectations(&mock_object)`: ``` TEST(MyServerTest, ProcessesRequest) { using ::testing::Mock; MockFoo* const foo = new MockFoo; EXPECT_CALL(*foo, ...)...; // ... other expectations ... // server now owns foo. MyServer server(foo); server.ProcessRequest(...); // In case that server's destructor will forget to delete foo, // this will verify the expectations anyway. Mock::VerifyAndClearExpectations(foo); } // server is destroyed when it goes out of scope here. ``` **Tip:** The `Mock::VerifyAndClearExpectations()` function returns a `bool` to indicate whether the verification was successful (`true` for yes), so you can wrap that function call inside a `ASSERT_TRUE()` if there is no point going further when the verification has failed. ## Using Check Points ## Sometimes you may want to "reset" a mock object at various check points in your test: at each check point, you verify that all existing expectations on the mock object have been satisfied, and then you set some new expectations on it as if it's newly created. This allows you to work with a mock object in "phases" whose sizes are each manageable. One such scenario is that in your test's `SetUp()` function, you may want to put the object you are testing into a certain state, with the help from a mock object. Once in the desired state, you want to clear all expectations on the mock, such that in the `TEST_F` body you can set fresh expectations on it. As you may have figured out, the `Mock::VerifyAndClearExpectations()` function we saw in the previous recipe can help you here. Or, if you are using `ON_CALL()` to set default actions on the mock object and want to clear the default actions as well, use `Mock::VerifyAndClear(&mock_object)` instead. This function does what `Mock::VerifyAndClearExpectations(&mock_object)` does and returns the same `bool`, **plus** it clears the `ON_CALL()` statements on `mock_object` too. Another trick you can use to achieve the same effect is to put the expectations in sequences and insert calls to a dummy "check-point" function at specific places. Then you can verify that the mock function calls do happen at the right time. For example, if you are exercising code: ``` Foo(1); Foo(2); Foo(3); ``` and want to verify that `Foo(1)` and `Foo(3)` both invoke `mock.Bar("a")`, but `Foo(2)` doesn't invoke anything. You can write: ``` using ::testing::MockFunction; TEST(FooTest, InvokesBarCorrectly) { MyMock mock; // Class MockFunction has exactly one mock method. It is named // Call() and has type F. MockFunction check; { InSequence s; EXPECT_CALL(mock, Bar("a")); EXPECT_CALL(check, Call("1")); EXPECT_CALL(check, Call("2")); EXPECT_CALL(mock, Bar("a")); } Foo(1); check.Call("1"); Foo(2); check.Call("2"); Foo(3); } ``` The expectation spec says that the first `Bar("a")` must happen before check point "1", the second `Bar("a")` must happen after check point "2", and nothing should happen between the two check points. The explicit check points make it easy to tell which `Bar("a")` is called by which call to `Foo()`. ## Mocking Destructors ## Sometimes you want to make sure a mock object is destructed at the right time, e.g. after `bar->A()` is called but before `bar->B()` is called. We already know that you can specify constraints on the order of mock function calls, so all we need to do is to mock the destructor of the mock function. This sounds simple, except for one problem: a destructor is a special function with special syntax and special semantics, and the `MOCK_METHOD0` macro doesn't work for it: ``` MOCK_METHOD0(~MockFoo, void()); // Won't compile! ``` The good news is that you can use a simple pattern to achieve the same effect. First, add a mock function `Die()` to your mock class and call it in the destructor, like this: ``` class MockFoo : public Foo { ... // Add the following two lines to the mock class. MOCK_METHOD0(Die, void()); virtual ~MockFoo() { Die(); } }; ``` (If the name `Die()` clashes with an existing symbol, choose another name.) Now, we have translated the problem of testing when a `MockFoo` object dies to testing when its `Die()` method is called: ``` MockFoo* foo = new MockFoo; MockBar* bar = new MockBar; ... { InSequence s; // Expects *foo to die after bar->A() and before bar->B(). EXPECT_CALL(*bar, A()); EXPECT_CALL(*foo, Die()); EXPECT_CALL(*bar, B()); } ``` And that's that. ## Using Google Mock and Threads ## **IMPORTANT NOTE:** What we describe in this recipe is **ONLY** true on platforms where Google Mock is thread-safe. Currently these are only platforms that support the pthreads library (this includes Linux and Mac). To make it thread-safe on other platforms we only need to implement some synchronization operations in `"gtest/internal/gtest-port.h"`. In a **unit** test, it's best if you could isolate and test a piece of code in a single-threaded context. That avoids race conditions and dead locks, and makes debugging your test much easier. Yet many programs are multi-threaded, and sometimes to test something we need to pound on it from more than one thread. Google Mock works for this purpose too. Remember the steps for using a mock: 1. Create a mock object `foo`. 1. Set its default actions and expectations using `ON_CALL()` and `EXPECT_CALL()`. 1. The code under test calls methods of `foo`. 1. Optionally, verify and reset the mock. 1. Destroy the mock yourself, or let the code under test destroy it. The destructor will automatically verify it. If you follow the following simple rules, your mocks and threads can live happily togeter: * Execute your _test code_ (as opposed to the code being tested) in _one_ thread. This makes your test easy to follow. * Obviously, you can do step #1 without locking. * When doing step #2 and #5, make sure no other thread is accessing `foo`. Obvious too, huh? * #3 and #4 can be done either in one thread or in multiple threads - anyway you want. Google Mock takes care of the locking, so you don't have to do any - unless required by your test logic. If you violate the rules (for example, if you set expectations on a mock while another thread is calling its methods), you get undefined behavior. That's not fun, so don't do it. Google Mock guarantees that the action for a mock function is done in the same thread that called the mock function. For example, in ``` EXPECT_CALL(mock, Foo(1)) .WillOnce(action1); EXPECT_CALL(mock, Foo(2)) .WillOnce(action2); ``` if `Foo(1)` is called in thread 1 and `Foo(2)` is called in thread 2, Google Mock will execute `action1` in thread 1 and `action2` in thread 2. Google Mock does _not_ impose a sequence on actions performed in different threads (doing so may create deadlocks as the actions may need to cooperate). This means that the execution of `action1` and `action2` in the above example _may_ interleave. If this is a problem, you should add proper synchronization logic to `action1` and `action2` to make the test thread-safe. Also, remember that `DefaultValue` is a global resource that potentially affects _all_ living mock objects in your program. Naturally, you won't want to mess with it from multiple threads or when there still are mocks in action. ## Controlling How Much Information Google Mock Prints ## When Google Mock sees something that has the potential of being an error (e.g. a mock function with no expectation is called, a.k.a. an uninteresting call, which is allowed but perhaps you forgot to explicitly ban the call), it prints some warning messages, including the arguments of the function and the return value. Hopefully this will remind you to take a look and see if there is indeed a problem. Sometimes you are confident that your tests are correct and may not appreciate such friendly messages. Some other times, you are debugging your tests or learning about the behavior of the code you are testing, and wish you could observe every mock call that happens (including argument values and the return value). Clearly, one size doesn't fit all. You can control how much Google Mock tells you using the `--gmock_verbose=LEVEL` command-line flag, where `LEVEL` is a string with three possible values: * `info`: Google Mock will print all informational messages, warnings, and errors (most verbose). At this setting, Google Mock will also log any calls to the `ON_CALL/EXPECT_CALL` macros. * `warning`: Google Mock will print both warnings and errors (less verbose). This is the default. * `error`: Google Mock will print errors only (least verbose). Alternatively, you can adjust the value of that flag from within your tests like so: ``` ::testing::FLAGS_gmock_verbose = "error"; ``` Now, judiciously use the right flag to enable Google Mock serve you better! ## Gaining Super Vision into Mock Calls ## You have a test using Google Mock. It fails: Google Mock tells you that some expectations aren't satisfied. However, you aren't sure why: Is there a typo somewhere in the matchers? Did you mess up the order of the `EXPECT_CALL`s? Or is the code under test doing something wrong? How can you find out the cause? Won't it be nice if you have X-ray vision and can actually see the trace of all `EXPECT_CALL`s and mock method calls as they are made? For each call, would you like to see its actual argument values and which `EXPECT_CALL` Google Mock thinks it matches? You can unlock this power by running your test with the `--gmock_verbose=info` flag. For example, given the test program: ``` using testing::_; using testing::HasSubstr; using testing::Return; class MockFoo { public: MOCK_METHOD2(F, void(const string& x, const string& y)); }; TEST(Foo, Bar) { MockFoo mock; EXPECT_CALL(mock, F(_, _)).WillRepeatedly(Return()); EXPECT_CALL(mock, F("a", "b")); EXPECT_CALL(mock, F("c", HasSubstr("d"))); mock.F("a", "good"); mock.F("a", "b"); } ``` if you run it with `--gmock_verbose=info`, you will see this output: ``` [ RUN ] Foo.Bar foo_test.cc:14: EXPECT_CALL(mock, F(_, _)) invoked foo_test.cc:15: EXPECT_CALL(mock, F("a", "b")) invoked foo_test.cc:16: EXPECT_CALL(mock, F("c", HasSubstr("d"))) invoked foo_test.cc:14: Mock function call matches EXPECT_CALL(mock, F(_, _))... Function call: F(@0x7fff7c8dad40"a", @0x7fff7c8dad10"good") foo_test.cc:15: Mock function call matches EXPECT_CALL(mock, F("a", "b"))... Function call: F(@0x7fff7c8dada0"a", @0x7fff7c8dad70"b") foo_test.cc:16: Failure Actual function call count doesn't match EXPECT_CALL(mock, F("c", HasSubstr("d")))... Expected: to be called once Actual: never called - unsatisfied and active [ FAILED ] Foo.Bar ``` Suppose the bug is that the `"c"` in the third `EXPECT_CALL` is a typo and should actually be `"a"`. With the above message, you should see that the actual `F("a", "good")` call is matched by the first `EXPECT_CALL`, not the third as you thought. From that it should be obvious that the third `EXPECT_CALL` is written wrong. Case solved. ## Running Tests in Emacs ## If you build and run your tests in Emacs, the source file locations of Google Mock and [Google Test](http://code.google.com/p/googletest/) errors will be highlighted. Just press `` on one of them and you'll be taken to the offending line. Or, you can just type `C-x `` to jump to the next error. To make it even easier, you can add the following lines to your `~/.emacs` file: ``` (global-set-key "\M-m" 'compile) ; m is for make (global-set-key [M-down] 'next-error) (global-set-key [M-up] '(lambda () (interactive) (next-error -1))) ``` Then you can type `M-m` to start a build, or `M-up`/`M-down` to move back and forth between errors. ## Fusing Google Mock Source Files ## Google Mock's implementation consists of dozens of files (excluding its own tests). Sometimes you may want them to be packaged up in fewer files instead, such that you can easily copy them to a new machine and start hacking there. For this we provide an experimental Python script `fuse_gmock_files.py` in the `scripts/` directory (starting with release 1.2.0). Assuming you have Python 2.4 or above installed on your machine, just go to that directory and run ``` python fuse_gmock_files.py OUTPUT_DIR ``` and you should see an `OUTPUT_DIR` directory being created with files `gtest/gtest.h`, `gmock/gmock.h`, and `gmock-gtest-all.cc` in it. These three files contain everything you need to use Google Mock (and Google Test). Just copy them to anywhere you want and you are ready to write tests and use mocks. You can use the [scrpts/test/Makefile](http://code.google.com/p/googlemock/source/browse/trunk/scripts/test/Makefile) file as an example on how to compile your tests against them. # Extending Google Mock # ## Writing New Matchers Quickly ## The `MATCHER*` family of macros can be used to define custom matchers easily. The syntax: ``` MATCHER(name, description_string_expression) { statements; } ``` will define a matcher with the given name that executes the statements, which must return a `bool` to indicate if the match succeeds. Inside the statements, you can refer to the value being matched by `arg`, and refer to its type by `arg_type`. The description string is a `string`-typed expression that documents what the matcher does, and is used to generate the failure message when the match fails. It can (and should) reference the special `bool` variable `negation`, and should evaluate to the description of the matcher when `negation` is `false`, or that of the matcher's negation when `negation` is `true`. For convenience, we allow the description string to be empty (`""`), in which case Google Mock will use the sequence of words in the matcher name as the description. For example: ``` MATCHER(IsDivisibleBy7, "") { return (arg % 7) == 0; } ``` allows you to write ``` // Expects mock_foo.Bar(n) to be called where n is divisible by 7. EXPECT_CALL(mock_foo, Bar(IsDivisibleBy7())); ``` or, ``` using ::testing::Not; ... EXPECT_THAT(some_expression, IsDivisibleBy7()); EXPECT_THAT(some_other_expression, Not(IsDivisibleBy7())); ``` If the above assertions fail, they will print something like: ``` Value of: some_expression Expected: is divisible by 7 Actual: 27 ... Value of: some_other_expression Expected: not (is divisible by 7) Actual: 21 ``` where the descriptions `"is divisible by 7"` and `"not (is divisible by 7)"` are automatically calculated from the matcher name `IsDivisibleBy7`. As you may have noticed, the auto-generated descriptions (especially those for the negation) may not be so great. You can always override them with a string expression of your own: ``` MATCHER(IsDivisibleBy7, std::string(negation ? "isn't" : "is") + " divisible by 7") { return (arg % 7) == 0; } ``` Optionally, you can stream additional information to a hidden argument named `result_listener` to explain the match result. For example, a better definition of `IsDivisibleBy7` is: ``` MATCHER(IsDivisibleBy7, "") { if ((arg % 7) == 0) return true; *result_listener << "the remainder is " << (arg % 7); return false; } ``` With this definition, the above assertion will give a better message: ``` Value of: some_expression Expected: is divisible by 7 Actual: 27 (the remainder is 6) ``` You should let `MatchAndExplain()` print _any additional information_ that can help a user understand the match result. Note that it should explain why the match succeeds in case of a success (unless it's obvious) - this is useful when the matcher is used inside `Not()`. There is no need to print the argument value itself, as Google Mock already prints it for you. **Notes:** 1. The type of the value being matched (`arg_type`) is determined by the context in which you use the matcher and is supplied to you by the compiler, so you don't need to worry about declaring it (nor can you). This allows the matcher to be polymorphic. For example, `IsDivisibleBy7()` can be used to match any type where the value of `(arg % 7) == 0` can be implicitly converted to a `bool`. In the `Bar(IsDivisibleBy7())` example above, if method `Bar()` takes an `int`, `arg_type` will be `int`; if it takes an `unsigned long`, `arg_type` will be `unsigned long`; and so on. 1. Google Mock doesn't guarantee when or how many times a matcher will be invoked. Therefore the matcher logic must be _purely functional_ (i.e. it cannot have any side effect, and the result must not depend on anything other than the value being matched and the matcher parameters). This requirement must be satisfied no matter how you define the matcher (e.g. using one of the methods described in the following recipes). In particular, a matcher can never call a mock function, as that will affect the state of the mock object and Google Mock. ## Writing New Parameterized Matchers Quickly ## Sometimes you'll want to define a matcher that has parameters. For that you can use the macro: ``` MATCHER_P(name, param_name, description_string) { statements; } ``` where the description string can be either `""` or a string expression that references `negation` and `param_name`. For example: ``` MATCHER_P(HasAbsoluteValue, value, "") { return abs(arg) == value; } ``` will allow you to write: ``` EXPECT_THAT(Blah("a"), HasAbsoluteValue(n)); ``` which may lead to this message (assuming `n` is 10): ``` Value of: Blah("a") Expected: has absolute value 10 Actual: -9 ``` Note that both the matcher description and its parameter are printed, making the message human-friendly. In the matcher definition body, you can write `foo_type` to reference the type of a parameter named `foo`. For example, in the body of `MATCHER_P(HasAbsoluteValue, value)` above, you can write `value_type` to refer to the type of `value`. Google Mock also provides `MATCHER_P2`, `MATCHER_P3`, ..., up to `MATCHER_P10` to support multi-parameter matchers: ``` MATCHER_Pk(name, param_1, ..., param_k, description_string) { statements; } ``` Please note that the custom description string is for a particular **instance** of the matcher, where the parameters have been bound to actual values. Therefore usually you'll want the parameter values to be part of the description. Google Mock lets you do that by referencing the matcher parameters in the description string expression. For example, ``` using ::testing::PrintToString; MATCHER_P2(InClosedRange, low, hi, std::string(negation ? "isn't" : "is") + " in range [" + PrintToString(low) + ", " + PrintToString(hi) + "]") { return low <= arg && arg <= hi; } ... EXPECT_THAT(3, InClosedRange(4, 6)); ``` would generate a failure that contains the message: ``` Expected: is in range [4, 6] ``` If you specify `""` as the description, the failure message will contain the sequence of words in the matcher name followed by the parameter values printed as a tuple. For example, ``` MATCHER_P2(InClosedRange, low, hi, "") { ... } ... EXPECT_THAT(3, InClosedRange(4, 6)); ``` would generate a failure that contains the text: ``` Expected: in closed range (4, 6) ``` For the purpose of typing, you can view ``` MATCHER_Pk(Foo, p1, ..., pk, description_string) { ... } ``` as shorthand for ``` template FooMatcherPk Foo(p1_type p1, ..., pk_type pk) { ... } ``` When you write `Foo(v1, ..., vk)`, the compiler infers the types of the parameters `v1`, ..., and `vk` for you. If you are not happy with the result of the type inference, you can specify the types by explicitly instantiating the template, as in `Foo(5, false)`. As said earlier, you don't get to (or need to) specify `arg_type` as that's determined by the context in which the matcher is used. You can assign the result of expression `Foo(p1, ..., pk)` to a variable of type `FooMatcherPk`. This can be useful when composing matchers. Matchers that don't have a parameter or have only one parameter have special types: you can assign `Foo()` to a `FooMatcher`-typed variable, and assign `Foo(p)` to a `FooMatcherP`-typed variable. While you can instantiate a matcher template with reference types, passing the parameters by pointer usually makes your code more readable. If, however, you still want to pass a parameter by reference, be aware that in the failure message generated by the matcher you will see the value of the referenced object but not its address. You can overload matchers with different numbers of parameters: ``` MATCHER_P(Blah, a, description_string_1) { ... } MATCHER_P2(Blah, a, b, description_string_2) { ... } ``` While it's tempting to always use the `MATCHER*` macros when defining a new matcher, you should also consider implementing `MatcherInterface` or using `MakePolymorphicMatcher()` instead (see the recipes that follow), especially if you need to use the matcher a lot. While these approaches require more work, they give you more control on the types of the value being matched and the matcher parameters, which in general leads to better compiler error messages that pay off in the long run. They also allow overloading matchers based on parameter types (as opposed to just based on the number of parameters). ## Writing New Monomorphic Matchers ## A matcher of argument type `T` implements `::testing::MatcherInterface` and does two things: it tests whether a value of type `T` matches the matcher, and can describe what kind of values it matches. The latter ability is used for generating readable error messages when expectations are violated. The interface looks like this: ``` class MatchResultListener { public: ... // Streams x to the underlying ostream; does nothing if the ostream // is NULL. template MatchResultListener& operator<<(const T& x); // Returns the underlying ostream. ::std::ostream* stream(); }; template class MatcherInterface { public: virtual ~MatcherInterface(); // Returns true iff the matcher matches x; also explains the match // result to 'listener'. virtual bool MatchAndExplain(T x, MatchResultListener* listener) const = 0; // Describes this matcher to an ostream. virtual void DescribeTo(::std::ostream* os) const = 0; // Describes the negation of this matcher to an ostream. virtual void DescribeNegationTo(::std::ostream* os) const; }; ``` If you need a custom matcher but `Truly()` is not a good option (for example, you may not be happy with the way `Truly(predicate)` describes itself, or you may want your matcher to be polymorphic as `Eq(value)` is), you can define a matcher to do whatever you want in two steps: first implement the matcher interface, and then define a factory function to create a matcher instance. The second step is not strictly needed but it makes the syntax of using the matcher nicer. For example, you can define a matcher to test whether an `int` is divisible by 7 and then use it like this: ``` using ::testing::MakeMatcher; using ::testing::Matcher; using ::testing::MatcherInterface; using ::testing::MatchResultListener; class DivisibleBy7Matcher : public MatcherInterface { public: virtual bool MatchAndExplain(int n, MatchResultListener* listener) const { return (n % 7) == 0; } virtual void DescribeTo(::std::ostream* os) const { *os << "is divisible by 7"; } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "is not divisible by 7"; } }; inline Matcher DivisibleBy7() { return MakeMatcher(new DivisibleBy7Matcher); } ... EXPECT_CALL(foo, Bar(DivisibleBy7())); ``` You may improve the matcher message by streaming additional information to the `listener` argument in `MatchAndExplain()`: ``` class DivisibleBy7Matcher : public MatcherInterface { public: virtual bool MatchAndExplain(int n, MatchResultListener* listener) const { const int remainder = n % 7; if (remainder != 0) { *listener << "the remainder is " << remainder; } return remainder == 0; } ... }; ``` Then, `EXPECT_THAT(x, DivisibleBy7());` may general a message like this: ``` Value of: x Expected: is divisible by 7 Actual: 23 (the remainder is 2) ``` ## Writing New Polymorphic Matchers ## You've learned how to write your own matchers in the previous recipe. Just one problem: a matcher created using `MakeMatcher()` only works for one particular type of arguments. If you want a _polymorphic_ matcher that works with arguments of several types (for instance, `Eq(x)` can be used to match a `value` as long as `value` == `x` compiles -- `value` and `x` don't have to share the same type), you can learn the trick from `"gmock/gmock-matchers.h"` but it's a bit involved. Fortunately, most of the time you can define a polymorphic matcher easily with the help of `MakePolymorphicMatcher()`. Here's how you can define `NotNull()` as an example: ``` using ::testing::MakePolymorphicMatcher; using ::testing::MatchResultListener; using ::testing::NotNull; using ::testing::PolymorphicMatcher; class NotNullMatcher { public: // To implement a polymorphic matcher, first define a COPYABLE class // that has three members MatchAndExplain(), DescribeTo(), and // DescribeNegationTo(), like the following. // In this example, we want to use NotNull() with any pointer, so // MatchAndExplain() accepts a pointer of any type as its first argument. // In general, you can define MatchAndExplain() as an ordinary method or // a method template, or even overload it. template bool MatchAndExplain(T* p, MatchResultListener* /* listener */) const { return p != NULL; } // Describes the property of a value matching this matcher. void DescribeTo(::std::ostream* os) const { *os << "is not NULL"; } // Describes the property of a value NOT matching this matcher. void DescribeNegationTo(::std::ostream* os) const { *os << "is NULL"; } }; // To construct a polymorphic matcher, pass an instance of the class // to MakePolymorphicMatcher(). Note the return type. inline PolymorphicMatcher NotNull() { return MakePolymorphicMatcher(NotNullMatcher()); } ... EXPECT_CALL(foo, Bar(NotNull())); // The argument must be a non-NULL pointer. ``` **Note:** Your polymorphic matcher class does **not** need to inherit from `MatcherInterface` or any other class, and its methods do **not** need to be virtual. Like in a monomorphic matcher, you may explain the match result by streaming additional information to the `listener` argument in `MatchAndExplain()`. ## Writing New Cardinalities ## A cardinality is used in `Times()` to tell Google Mock how many times you expect a call to occur. It doesn't have to be exact. For example, you can say `AtLeast(5)` or `Between(2, 4)`. If the built-in set of cardinalities doesn't suit you, you are free to define your own by implementing the following interface (in namespace `testing`): ``` class CardinalityInterface { public: virtual ~CardinalityInterface(); // Returns true iff call_count calls will satisfy this cardinality. virtual bool IsSatisfiedByCallCount(int call_count) const = 0; // Returns true iff call_count calls will saturate this cardinality. virtual bool IsSaturatedByCallCount(int call_count) const = 0; // Describes self to an ostream. virtual void DescribeTo(::std::ostream* os) const = 0; }; ``` For example, to specify that a call must occur even number of times, you can write ``` using ::testing::Cardinality; using ::testing::CardinalityInterface; using ::testing::MakeCardinality; class EvenNumberCardinality : public CardinalityInterface { public: virtual bool IsSatisfiedByCallCount(int call_count) const { return (call_count % 2) == 0; } virtual bool IsSaturatedByCallCount(int call_count) const { return false; } virtual void DescribeTo(::std::ostream* os) const { *os << "called even number of times"; } }; Cardinality EvenNumber() { return MakeCardinality(new EvenNumberCardinality); } ... EXPECT_CALL(foo, Bar(3)) .Times(EvenNumber()); ``` ## Writing New Actions Quickly ## If the built-in actions don't work for you, and you find it inconvenient to use `Invoke()`, you can use a macro from the `ACTION*` family to quickly define a new action that can be used in your code as if it's a built-in action. By writing ``` ACTION(name) { statements; } ``` in a namespace scope (i.e. not inside a class or function), you will define an action with the given name that executes the statements. The value returned by `statements` will be used as the return value of the action. Inside the statements, you can refer to the K-th (0-based) argument of the mock function as `argK`. For example: ``` ACTION(IncrementArg1) { return ++(*arg1); } ``` allows you to write ``` ... WillOnce(IncrementArg1()); ``` Note that you don't need to specify the types of the mock function arguments. Rest assured that your code is type-safe though: you'll get a compiler error if `*arg1` doesn't support the `++` operator, or if the type of `++(*arg1)` isn't compatible with the mock function's return type. Another example: ``` ACTION(Foo) { (*arg2)(5); Blah(); *arg1 = 0; return arg0; } ``` defines an action `Foo()` that invokes argument #2 (a function pointer) with 5, calls function `Blah()`, sets the value pointed to by argument #1 to 0, and returns argument #0. For more convenience and flexibility, you can also use the following pre-defined symbols in the body of `ACTION`: | `argK_type` | The type of the K-th (0-based) argument of the mock function | |:------------|:-------------------------------------------------------------| | `args` | All arguments of the mock function as a tuple | | `args_type` | The type of all arguments of the mock function as a tuple | | `return_type` | The return type of the mock function | | `function_type` | The type of the mock function | For example, when using an `ACTION` as a stub action for mock function: ``` int DoSomething(bool flag, int* ptr); ``` we have: | **Pre-defined Symbol** | **Is Bound To** | |:-----------------------|:----------------| | `arg0` | the value of `flag` | | `arg0_type` | the type `bool` | | `arg1` | the value of `ptr` | | `arg1_type` | the type `int*` | | `args` | the tuple `(flag, ptr)` | | `args_type` | the type `std::tr1::tuple` | | `return_type` | the type `int` | | `function_type` | the type `int(bool, int*)` | ## Writing New Parameterized Actions Quickly ## Sometimes you'll want to parameterize an action you define. For that we have another macro ``` ACTION_P(name, param) { statements; } ``` For example, ``` ACTION_P(Add, n) { return arg0 + n; } ``` will allow you to write ``` // Returns argument #0 + 5. ... WillOnce(Add(5)); ``` For convenience, we use the term _arguments_ for the values used to invoke the mock function, and the term _parameters_ for the values used to instantiate an action. Note that you don't need to provide the type of the parameter either. Suppose the parameter is named `param`, you can also use the Google-Mock-defined symbol `param_type` to refer to the type of the parameter as inferred by the compiler. For example, in the body of `ACTION_P(Add, n)` above, you can write `n_type` for the type of `n`. Google Mock also provides `ACTION_P2`, `ACTION_P3`, and etc to support multi-parameter actions. For example, ``` ACTION_P2(ReturnDistanceTo, x, y) { double dx = arg0 - x; double dy = arg1 - y; return sqrt(dx*dx + dy*dy); } ``` lets you write ``` ... WillOnce(ReturnDistanceTo(5.0, 26.5)); ``` You can view `ACTION` as a degenerated parameterized action where the number of parameters is 0. You can also easily define actions overloaded on the number of parameters: ``` ACTION_P(Plus, a) { ... } ACTION_P2(Plus, a, b) { ... } ``` ## Restricting the Type of an Argument or Parameter in an ACTION ## For maximum brevity and reusability, the `ACTION*` macros don't ask you to provide the types of the mock function arguments and the action parameters. Instead, we let the compiler infer the types for us. Sometimes, however, we may want to be more explicit about the types. There are several tricks to do that. For example: ``` ACTION(Foo) { // Makes sure arg0 can be converted to int. int n = arg0; ... use n instead of arg0 here ... } ACTION_P(Bar, param) { // Makes sure the type of arg1 is const char*. ::testing::StaticAssertTypeEq(); // Makes sure param can be converted to bool. bool flag = param; } ``` where `StaticAssertTypeEq` is a compile-time assertion in Google Test that verifies two types are the same. ## Writing New Action Templates Quickly ## Sometimes you want to give an action explicit template parameters that cannot be inferred from its value parameters. `ACTION_TEMPLATE()` supports that and can be viewed as an extension to `ACTION()` and `ACTION_P*()`. The syntax: ``` ACTION_TEMPLATE(ActionName, HAS_m_TEMPLATE_PARAMS(kind1, name1, ..., kind_m, name_m), AND_n_VALUE_PARAMS(p1, ..., p_n)) { statements; } ``` defines an action template that takes _m_ explicit template parameters and _n_ value parameters, where _m_ is between 1 and 10, and _n_ is between 0 and 10. `name_i` is the name of the i-th template parameter, and `kind_i` specifies whether it's a `typename`, an integral constant, or a template. `p_i` is the name of the i-th value parameter. Example: ``` // DuplicateArg(output) converts the k-th argument of the mock // function to type T and copies it to *output. ACTION_TEMPLATE(DuplicateArg, // Note the comma between int and k: HAS_2_TEMPLATE_PARAMS(int, k, typename, T), AND_1_VALUE_PARAMS(output)) { *output = T(std::tr1::get(args)); } ``` To create an instance of an action template, write: ``` ActionName(v1, ..., v_n) ``` where the `t`s are the template arguments and the `v`s are the value arguments. The value argument types are inferred by the compiler. For example: ``` using ::testing::_; ... int n; EXPECT_CALL(mock, Foo(_, _)) .WillOnce(DuplicateArg<1, unsigned char>(&n)); ``` If you want to explicitly specify the value argument types, you can provide additional template arguments: ``` ActionName(v1, ..., v_n) ``` where `u_i` is the desired type of `v_i`. `ACTION_TEMPLATE` and `ACTION`/`ACTION_P*` can be overloaded on the number of value parameters, but not on the number of template parameters. Without the restriction, the meaning of the following is unclear: ``` OverloadedAction(x); ``` Are we using a single-template-parameter action where `bool` refers to the type of `x`, or a two-template-parameter action where the compiler is asked to infer the type of `x`? ## Using the ACTION Object's Type ## If you are writing a function that returns an `ACTION` object, you'll need to know its type. The type depends on the macro used to define the action and the parameter types. The rule is relatively simple: | **Given Definition** | **Expression** | **Has Type** | |:---------------------|:---------------|:-------------| | `ACTION(Foo)` | `Foo()` | `FooAction` | | `ACTION_TEMPLATE(Foo, HAS_m_TEMPLATE_PARAMS(...), AND_0_VALUE_PARAMS())` | `Foo()` | `FooAction` | | `ACTION_P(Bar, param)` | `Bar(int_value)` | `BarActionP` | | `ACTION_TEMPLATE(Bar, HAS_m_TEMPLATE_PARAMS(...), AND_1_VALUE_PARAMS(p1))` | `Bar(int_value)` | `FooActionP` | | `ACTION_P2(Baz, p1, p2)` | `Baz(bool_value, int_value)` | `BazActionP2` | | `ACTION_TEMPLATE(Baz, HAS_m_TEMPLATE_PARAMS(...), AND_2_VALUE_PARAMS(p1, p2))` | `Baz(bool_value, int_value)` | `FooActionP2` | | ... | ... | ... | Note that we have to pick different suffixes (`Action`, `ActionP`, `ActionP2`, and etc) for actions with different numbers of value parameters, or the action definitions cannot be overloaded on the number of them. ## Writing New Monomorphic Actions ## While the `ACTION*` macros are very convenient, sometimes they are inappropriate. For example, despite the tricks shown in the previous recipes, they don't let you directly specify the types of the mock function arguments and the action parameters, which in general leads to unoptimized compiler error messages that can baffle unfamiliar users. They also don't allow overloading actions based on parameter types without jumping through some hoops. An alternative to the `ACTION*` macros is to implement `::testing::ActionInterface`, where `F` is the type of the mock function in which the action will be used. For example: ``` template class ActionInterface { public: virtual ~ActionInterface(); // Performs the action. Result is the return type of function type // F, and ArgumentTuple is the tuple of arguments of F. // // For example, if F is int(bool, const string&), then Result would // be int, and ArgumentTuple would be tr1::tuple. virtual Result Perform(const ArgumentTuple& args) = 0; }; using ::testing::_; using ::testing::Action; using ::testing::ActionInterface; using ::testing::MakeAction; typedef int IncrementMethod(int*); class IncrementArgumentAction : public ActionInterface { public: virtual int Perform(const tr1::tuple& args) { int* p = tr1::get<0>(args); // Grabs the first argument. return *p++; } }; Action IncrementArgument() { return MakeAction(new IncrementArgumentAction); } ... EXPECT_CALL(foo, Baz(_)) .WillOnce(IncrementArgument()); int n = 5; foo.Baz(&n); // Should return 5 and change n to 6. ``` ## Writing New Polymorphic Actions ## The previous recipe showed you how to define your own action. This is all good, except that you need to know the type of the function in which the action will be used. Sometimes that can be a problem. For example, if you want to use the action in functions with _different_ types (e.g. like `Return()` and `SetArgPointee()`). If an action can be used in several types of mock functions, we say it's _polymorphic_. The `MakePolymorphicAction()` function template makes it easy to define such an action: ``` namespace testing { template PolymorphicAction MakePolymorphicAction(const Impl& impl); } // namespace testing ``` As an example, let's define an action that returns the second argument in the mock function's argument list. The first step is to define an implementation class: ``` class ReturnSecondArgumentAction { public: template Result Perform(const ArgumentTuple& args) const { // To get the i-th (0-based) argument, use tr1::get(args). return tr1::get<1>(args); } }; ``` This implementation class does _not_ need to inherit from any particular class. What matters is that it must have a `Perform()` method template. This method template takes the mock function's arguments as a tuple in a **single** argument, and returns the result of the action. It can be either `const` or not, but must be invokable with exactly one template argument, which is the result type. In other words, you must be able to call `Perform(args)` where `R` is the mock function's return type and `args` is its arguments in a tuple. Next, we use `MakePolymorphicAction()` to turn an instance of the implementation class into the polymorphic action we need. It will be convenient to have a wrapper for this: ``` using ::testing::MakePolymorphicAction; using ::testing::PolymorphicAction; PolymorphicAction ReturnSecondArgument() { return MakePolymorphicAction(ReturnSecondArgumentAction()); } ``` Now, you can use this polymorphic action the same way you use the built-in ones: ``` using ::testing::_; class MockFoo : public Foo { public: MOCK_METHOD2(DoThis, int(bool flag, int n)); MOCK_METHOD3(DoThat, string(int x, const char* str1, const char* str2)); }; ... MockFoo foo; EXPECT_CALL(foo, DoThis(_, _)) .WillOnce(ReturnSecondArgument()); EXPECT_CALL(foo, DoThat(_, _, _)) .WillOnce(ReturnSecondArgument()); ... foo.DoThis(true, 5); // Will return 5. foo.DoThat(1, "Hi", "Bye"); // Will return "Hi". ``` ## Teaching Google Mock How to Print Your Values ## When an uninteresting or unexpected call occurs, Google Mock prints the argument values and the stack trace to help you debug. Assertion macros like `EXPECT_THAT` and `EXPECT_EQ` also print the values in question when the assertion fails. Google Mock and Google Test do this using Google Test's user-extensible value printer. This printer knows how to print built-in C++ types, native arrays, STL containers, and any type that supports the `<<` operator. For other types, it prints the raw bytes in the value and hopes that you the user can figure it out. [Google Test's advanced guide](http://code.google.com/p/googletest/wiki/AdvancedGuide#Teaching_Google_Test_How_to_Print_Your_Values) explains how to extend the printer to do a better job at printing your particular type than to dump the bytes.vendor/googletest/gtest-1.7.0/googlemock/docs/v1_7/Documentation.md000066400000000000000000000014441300002025200252660ustar00rootroot00000000000000This page lists all documentation wiki pages for Google Mock **(the SVN trunk version)** - **if you use a released version of Google Mock, please read the documentation for that specific version instead.** * [ForDummies](V1_7_ForDummies.md) -- start here if you are new to Google Mock. * [CheatSheet](V1_7_CheatSheet.md) -- a quick reference. * [CookBook](V1_7_CookBook.md) -- recipes for doing various tasks using Google Mock. * [FrequentlyAskedQuestions](V1_7_FrequentlyAskedQuestions.md) -- check here before asking a question on the mailing list. To contribute code to Google Mock, read: * [DevGuide](DevGuide.md) -- read this _before_ writing your first patch. * [Pump Manual](http://code.google.com/p/googletest/wiki/PumpManual) -- how we generate some of Google Mock's source files.vendor/googletest/gtest-1.7.0/googlemock/docs/v1_7/ForDummies.md000066400000000000000000000726671300002025200245460ustar00rootroot00000000000000 (**Note:** If you get compiler errors that you don't understand, be sure to consult [Google Mock Doctor](http://code.google.com/p/googlemock/wiki/V1_7_FrequentlyAskedQuestions#How_am_I_supposed_to_make_sense_of_these_horrible_template_error).) # What Is Google C++ Mocking Framework? # When you write a prototype or test, often it's not feasible or wise to rely on real objects entirely. A **mock object** implements the same interface as a real object (so it can be used as one), but lets you specify at run time how it will be used and what it should do (which methods will be called? in which order? how many times? with what arguments? what will they return? etc). **Note:** It is easy to confuse the term _fake objects_ with mock objects. Fakes and mocks actually mean very different things in the Test-Driven Development (TDD) community: * **Fake** objects have working implementations, but usually take some shortcut (perhaps to make the operations less expensive), which makes them not suitable for production. An in-memory file system would be an example of a fake. * **Mocks** are objects pre-programmed with _expectations_, which form a specification of the calls they are expected to receive. If all this seems too abstract for you, don't worry - the most important thing to remember is that a mock allows you to check the _interaction_ between itself and code that uses it. The difference between fakes and mocks will become much clearer once you start to use mocks. **Google C++ Mocking Framework** (or **Google Mock** for short) is a library (sometimes we also call it a "framework" to make it sound cool) for creating mock classes and using them. It does to C++ what [jMock](http://www.jmock.org/) and [EasyMock](http://www.easymock.org/) do to Java. Using Google Mock involves three basic steps: 1. Use some simple macros to describe the interface you want to mock, and they will expand to the implementation of your mock class; 1. Create some mock objects and specify its expectations and behavior using an intuitive syntax; 1. Exercise code that uses the mock objects. Google Mock will catch any violation of the expectations as soon as it arises. # Why Google Mock? # While mock objects help you remove unnecessary dependencies in tests and make them fast and reliable, using mocks manually in C++ is _hard_: * Someone has to implement the mocks. The job is usually tedious and error-prone. No wonder people go great distance to avoid it. * The quality of those manually written mocks is a bit, uh, unpredictable. You may see some really polished ones, but you may also see some that were hacked up in a hurry and have all sorts of ad hoc restrictions. * The knowledge you gained from using one mock doesn't transfer to the next. In contrast, Java and Python programmers have some fine mock frameworks, which automate the creation of mocks. As a result, mocking is a proven effective technique and widely adopted practice in those communities. Having the right tool absolutely makes the difference. Google Mock was built to help C++ programmers. It was inspired by [jMock](http://www.jmock.org/) and [EasyMock](http://www.easymock.org/), but designed with C++'s specifics in mind. It is your friend if any of the following problems is bothering you: * You are stuck with a sub-optimal design and wish you had done more prototyping before it was too late, but prototyping in C++ is by no means "rapid". * Your tests are slow as they depend on too many libraries or use expensive resources (e.g. a database). * Your tests are brittle as some resources they use are unreliable (e.g. the network). * You want to test how your code handles a failure (e.g. a file checksum error), but it's not easy to cause one. * You need to make sure that your module interacts with other modules in the right way, but it's hard to observe the interaction; therefore you resort to observing the side effects at the end of the action, which is awkward at best. * You want to "mock out" your dependencies, except that they don't have mock implementations yet; and, frankly, you aren't thrilled by some of those hand-written mocks. We encourage you to use Google Mock as: * a _design_ tool, for it lets you experiment with your interface design early and often. More iterations lead to better designs! * a _testing_ tool to cut your tests' outbound dependencies and probe the interaction between your module and its collaborators. # Getting Started # Using Google Mock is easy! Inside your C++ source file, just #include `"gtest/gtest.h"` and `"gmock/gmock.h"`, and you are ready to go. # A Case for Mock Turtles # Let's look at an example. Suppose you are developing a graphics program that relies on a LOGO-like API for drawing. How would you test that it does the right thing? Well, you can run it and compare the screen with a golden screen snapshot, but let's admit it: tests like this are expensive to run and fragile (What if you just upgraded to a shiny new graphics card that has better anti-aliasing? Suddenly you have to update all your golden images.). It would be too painful if all your tests are like this. Fortunately, you learned about Dependency Injection and know the right thing to do: instead of having your application talk to the drawing API directly, wrap the API in an interface (say, `Turtle`) and code to that interface: ``` class Turtle { ... virtual ~Turtle() {} virtual void PenUp() = 0; virtual void PenDown() = 0; virtual void Forward(int distance) = 0; virtual void Turn(int degrees) = 0; virtual void GoTo(int x, int y) = 0; virtual int GetX() const = 0; virtual int GetY() const = 0; }; ``` (Note that the destructor of `Turtle` **must** be virtual, as is the case for **all** classes you intend to inherit from - otherwise the destructor of the derived class will not be called when you delete an object through a base pointer, and you'll get corrupted program states like memory leaks.) You can control whether the turtle's movement will leave a trace using `PenUp()` and `PenDown()`, and control its movement using `Forward()`, `Turn()`, and `GoTo()`. Finally, `GetX()` and `GetY()` tell you the current position of the turtle. Your program will normally use a real implementation of this interface. In tests, you can use a mock implementation instead. This allows you to easily check what drawing primitives your program is calling, with what arguments, and in which order. Tests written this way are much more robust (they won't break because your new machine does anti-aliasing differently), easier to read and maintain (the intent of a test is expressed in the code, not in some binary images), and run _much, much faster_. # Writing the Mock Class # If you are lucky, the mocks you need to use have already been implemented by some nice people. If, however, you find yourself in the position to write a mock class, relax - Google Mock turns this task into a fun game! (Well, almost.) ## How to Define It ## Using the `Turtle` interface as example, here are the simple steps you need to follow: 1. Derive a class `MockTurtle` from `Turtle`. 1. Take a _virtual_ function of `Turtle` (while it's possible to [mock non-virtual methods using templates](http://code.google.com/p/googlemock/wiki/V1_7_CookBook#Mocking_Nonvirtual_Methods), it's much more involved). Count how many arguments it has. 1. In the `public:` section of the child class, write `MOCK_METHODn();` (or `MOCK_CONST_METHODn();` if you are mocking a `const` method), where `n` is the number of the arguments; if you counted wrong, shame on you, and a compiler error will tell you so. 1. Now comes the fun part: you take the function signature, cut-and-paste the _function name_ as the _first_ argument to the macro, and leave what's left as the _second_ argument (in case you're curious, this is the _type of the function_). 1. Repeat until all virtual functions you want to mock are done. After the process, you should have something like: ``` #include "gmock/gmock.h" // Brings in Google Mock. class MockTurtle : public Turtle { public: ... MOCK_METHOD0(PenUp, void()); MOCK_METHOD0(PenDown, void()); MOCK_METHOD1(Forward, void(int distance)); MOCK_METHOD1(Turn, void(int degrees)); MOCK_METHOD2(GoTo, void(int x, int y)); MOCK_CONST_METHOD0(GetX, int()); MOCK_CONST_METHOD0(GetY, int()); }; ``` You don't need to define these mock methods somewhere else - the `MOCK_METHOD*` macros will generate the definitions for you. It's that simple! Once you get the hang of it, you can pump out mock classes faster than your source-control system can handle your check-ins. **Tip:** If even this is too much work for you, you'll find the `gmock_gen.py` tool in Google Mock's `scripts/generator/` directory (courtesy of the [cppclean](http://code.google.com/p/cppclean/) project) useful. This command-line tool requires that you have Python 2.4 installed. You give it a C++ file and the name of an abstract class defined in it, and it will print the definition of the mock class for you. Due to the complexity of the C++ language, this script may not always work, but it can be quite handy when it does. For more details, read the [user documentation](http://code.google.com/p/googlemock/source/browse/trunk/scripts/generator/README). ## Where to Put It ## When you define a mock class, you need to decide where to put its definition. Some people put it in a `*_test.cc`. This is fine when the interface being mocked (say, `Foo`) is owned by the same person or team. Otherwise, when the owner of `Foo` changes it, your test could break. (You can't really expect `Foo`'s maintainer to fix every test that uses `Foo`, can you?) So, the rule of thumb is: if you need to mock `Foo` and it's owned by others, define the mock class in `Foo`'s package (better, in a `testing` sub-package such that you can clearly separate production code and testing utilities), and put it in a `mock_foo.h`. Then everyone can reference `mock_foo.h` from their tests. If `Foo` ever changes, there is only one copy of `MockFoo` to change, and only tests that depend on the changed methods need to be fixed. Another way to do it: you can introduce a thin layer `FooAdaptor` on top of `Foo` and code to this new interface. Since you own `FooAdaptor`, you can absorb changes in `Foo` much more easily. While this is more work initially, carefully choosing the adaptor interface can make your code easier to write and more readable (a net win in the long run), as you can choose `FooAdaptor` to fit your specific domain much better than `Foo` does. # Using Mocks in Tests # Once you have a mock class, using it is easy. The typical work flow is: 1. Import the Google Mock names from the `testing` namespace such that you can use them unqualified (You only have to do it once per file. Remember that namespaces are a good idea and good for your health.). 1. Create some mock objects. 1. Specify your expectations on them (How many times will a method be called? With what arguments? What should it do? etc.). 1. Exercise some code that uses the mocks; optionally, check the result using Google Test assertions. If a mock method is called more than expected or with wrong arguments, you'll get an error immediately. 1. When a mock is destructed, Google Mock will automatically check whether all expectations on it have been satisfied. Here's an example: ``` #include "path/to/mock-turtle.h" #include "gmock/gmock.h" #include "gtest/gtest.h" using ::testing::AtLeast; // #1 TEST(PainterTest, CanDrawSomething) { MockTurtle turtle; // #2 EXPECT_CALL(turtle, PenDown()) // #3 .Times(AtLeast(1)); Painter painter(&turtle); // #4 EXPECT_TRUE(painter.DrawCircle(0, 0, 10)); } // #5 int main(int argc, char** argv) { // The following line must be executed to initialize Google Mock // (and Google Test) before running the tests. ::testing::InitGoogleMock(&argc, argv); return RUN_ALL_TESTS(); } ``` As you might have guessed, this test checks that `PenDown()` is called at least once. If the `painter` object didn't call this method, your test will fail with a message like this: ``` path/to/my_test.cc:119: Failure Actual function call count doesn't match this expectation: Actually: never called; Expected: called at least once. ``` **Tip 1:** If you run the test from an Emacs buffer, you can hit `` on the line number displayed in the error message to jump right to the failed expectation. **Tip 2:** If your mock objects are never deleted, the final verification won't happen. Therefore it's a good idea to use a heap leak checker in your tests when you allocate mocks on the heap. **Important note:** Google Mock requires expectations to be set **before** the mock functions are called, otherwise the behavior is **undefined**. In particular, you mustn't interleave `EXPECT_CALL()`s and calls to the mock functions. This means `EXPECT_CALL()` should be read as expecting that a call will occur _in the future_, not that a call has occurred. Why does Google Mock work like that? Well, specifying the expectation beforehand allows Google Mock to report a violation as soon as it arises, when the context (stack trace, etc) is still available. This makes debugging much easier. Admittedly, this test is contrived and doesn't do much. You can easily achieve the same effect without using Google Mock. However, as we shall reveal soon, Google Mock allows you to do _much more_ with the mocks. ## Using Google Mock with Any Testing Framework ## If you want to use something other than Google Test (e.g. [CppUnit](http://apps.sourceforge.net/mediawiki/cppunit/index.php?title=Main_Page) or [CxxTest](http://cxxtest.tigris.org/)) as your testing framework, just change the `main()` function in the previous section to: ``` int main(int argc, char** argv) { // The following line causes Google Mock to throw an exception on failure, // which will be interpreted by your testing framework as a test failure. ::testing::GTEST_FLAG(throw_on_failure) = true; ::testing::InitGoogleMock(&argc, argv); ... whatever your testing framework requires ... } ``` This approach has a catch: it makes Google Mock throw an exception from a mock object's destructor sometimes. With some compilers, this sometimes causes the test program to crash. You'll still be able to notice that the test has failed, but it's not a graceful failure. A better solution is to use Google Test's [event listener API](http://code.google.com/p/googletest/wiki/AdvancedGuide#Extending_Google_Test_by_Handling_Test_Events) to report a test failure to your testing framework properly. You'll need to implement the `OnTestPartResult()` method of the event listener interface, but it should be straightforward. If this turns out to be too much work, we suggest that you stick with Google Test, which works with Google Mock seamlessly (in fact, it is technically part of Google Mock.). If there is a reason that you cannot use Google Test, please let us know. # Setting Expectations # The key to using a mock object successfully is to set the _right expectations_ on it. If you set the expectations too strict, your test will fail as the result of unrelated changes. If you set them too loose, bugs can slip through. You want to do it just right such that your test can catch exactly the kind of bugs you intend it to catch. Google Mock provides the necessary means for you to do it "just right." ## General Syntax ## In Google Mock we use the `EXPECT_CALL()` macro to set an expectation on a mock method. The general syntax is: ``` EXPECT_CALL(mock_object, method(matchers)) .Times(cardinality) .WillOnce(action) .WillRepeatedly(action); ``` The macro has two arguments: first the mock object, and then the method and its arguments. Note that the two are separated by a comma (`,`), not a period (`.`). (Why using a comma? The answer is that it was necessary for technical reasons.) The macro can be followed by some optional _clauses_ that provide more information about the expectation. We'll discuss how each clause works in the coming sections. This syntax is designed to make an expectation read like English. For example, you can probably guess that ``` using ::testing::Return;... EXPECT_CALL(turtle, GetX()) .Times(5) .WillOnce(Return(100)) .WillOnce(Return(150)) .WillRepeatedly(Return(200)); ``` says that the `turtle` object's `GetX()` method will be called five times, it will return 100 the first time, 150 the second time, and then 200 every time. Some people like to call this style of syntax a Domain-Specific Language (DSL). **Note:** Why do we use a macro to do this? It serves two purposes: first it makes expectations easily identifiable (either by `grep` or by a human reader), and second it allows Google Mock to include the source file location of a failed expectation in messages, making debugging easier. ## Matchers: What Arguments Do We Expect? ## When a mock function takes arguments, we must specify what arguments we are expecting; for example: ``` // Expects the turtle to move forward by 100 units. EXPECT_CALL(turtle, Forward(100)); ``` Sometimes you may not want to be too specific (Remember that talk about tests being too rigid? Over specification leads to brittle tests and obscures the intent of tests. Therefore we encourage you to specify only what's necessary - no more, no less.). If you care to check that `Forward()` will be called but aren't interested in its actual argument, write `_` as the argument, which means "anything goes": ``` using ::testing::_; ... // Expects the turtle to move forward. EXPECT_CALL(turtle, Forward(_)); ``` `_` is an instance of what we call **matchers**. A matcher is like a predicate and can test whether an argument is what we'd expect. You can use a matcher inside `EXPECT_CALL()` wherever a function argument is expected. A list of built-in matchers can be found in the [CheatSheet](V1_7_CheatSheet.md). For example, here's the `Ge` (greater than or equal) matcher: ``` using ::testing::Ge;... EXPECT_CALL(turtle, Forward(Ge(100))); ``` This checks that the turtle will be told to go forward by at least 100 units. ## Cardinalities: How Many Times Will It Be Called? ## The first clause we can specify following an `EXPECT_CALL()` is `Times()`. We call its argument a **cardinality** as it tells _how many times_ the call should occur. It allows us to repeat an expectation many times without actually writing it as many times. More importantly, a cardinality can be "fuzzy", just like a matcher can be. This allows a user to express the intent of a test exactly. An interesting special case is when we say `Times(0)`. You may have guessed - it means that the function shouldn't be called with the given arguments at all, and Google Mock will report a Google Test failure whenever the function is (wrongfully) called. We've seen `AtLeast(n)` as an example of fuzzy cardinalities earlier. For the list of built-in cardinalities you can use, see the [CheatSheet](V1_7_CheatSheet.md). The `Times()` clause can be omitted. **If you omit `Times()`, Google Mock will infer the cardinality for you.** The rules are easy to remember: * If **neither** `WillOnce()` **nor** `WillRepeatedly()` is in the `EXPECT_CALL()`, the inferred cardinality is `Times(1)`. * If there are `n WillOnce()`'s but **no** `WillRepeatedly()`, where `n` >= 1, the cardinality is `Times(n)`. * If there are `n WillOnce()`'s and **one** `WillRepeatedly()`, where `n` >= 0, the cardinality is `Times(AtLeast(n))`. **Quick quiz:** what do you think will happen if a function is expected to be called twice but actually called four times? ## Actions: What Should It Do? ## Remember that a mock object doesn't really have a working implementation? We as users have to tell it what to do when a method is invoked. This is easy in Google Mock. First, if the return type of a mock function is a built-in type or a pointer, the function has a **default action** (a `void` function will just return, a `bool` function will return `false`, and other functions will return 0). If you don't say anything, this behavior will be used. Second, if a mock function doesn't have a default action, or the default action doesn't suit you, you can specify the action to be taken each time the expectation matches using a series of `WillOnce()` clauses followed by an optional `WillRepeatedly()`. For example, ``` using ::testing::Return;... EXPECT_CALL(turtle, GetX()) .WillOnce(Return(100)) .WillOnce(Return(200)) .WillOnce(Return(300)); ``` This says that `turtle.GetX()` will be called _exactly three times_ (Google Mock inferred this from how many `WillOnce()` clauses we've written, since we didn't explicitly write `Times()`), and will return 100, 200, and 300 respectively. ``` using ::testing::Return;... EXPECT_CALL(turtle, GetY()) .WillOnce(Return(100)) .WillOnce(Return(200)) .WillRepeatedly(Return(300)); ``` says that `turtle.GetY()` will be called _at least twice_ (Google Mock knows this as we've written two `WillOnce()` clauses and a `WillRepeatedly()` while having no explicit `Times()`), will return 100 the first time, 200 the second time, and 300 from the third time on. Of course, if you explicitly write a `Times()`, Google Mock will not try to infer the cardinality itself. What if the number you specified is larger than there are `WillOnce()` clauses? Well, after all `WillOnce()`s are used up, Google Mock will do the _default_ action for the function every time (unless, of course, you have a `WillRepeatedly()`.). What can we do inside `WillOnce()` besides `Return()`? You can return a reference using `ReturnRef(variable)`, or invoke a pre-defined function, among [others](http://code.google.com/p/googlemock/wiki/V1_7_CheatSheet#Actions). **Important note:** The `EXPECT_CALL()` statement evaluates the action clause only once, even though the action may be performed many times. Therefore you must be careful about side effects. The following may not do what you want: ``` int n = 100; EXPECT_CALL(turtle, GetX()) .Times(4) .WillRepeatedly(Return(n++)); ``` Instead of returning 100, 101, 102, ..., consecutively, this mock function will always return 100 as `n++` is only evaluated once. Similarly, `Return(new Foo)` will create a new `Foo` object when the `EXPECT_CALL()` is executed, and will return the same pointer every time. If you want the side effect to happen every time, you need to define a custom action, which we'll teach in the [CookBook](V1_7_CookBook.md). Time for another quiz! What do you think the following means? ``` using ::testing::Return;... EXPECT_CALL(turtle, GetY()) .Times(4) .WillOnce(Return(100)); ``` Obviously `turtle.GetY()` is expected to be called four times. But if you think it will return 100 every time, think twice! Remember that one `WillOnce()` clause will be consumed each time the function is invoked and the default action will be taken afterwards. So the right answer is that `turtle.GetY()` will return 100 the first time, but **return 0 from the second time on**, as returning 0 is the default action for `int` functions. ## Using Multiple Expectations ## So far we've only shown examples where you have a single expectation. More realistically, you're going to specify expectations on multiple mock methods, which may be from multiple mock objects. By default, when a mock method is invoked, Google Mock will search the expectations in the **reverse order** they are defined, and stop when an active expectation that matches the arguments is found (you can think of it as "newer rules override older ones."). If the matching expectation cannot take any more calls, you will get an upper-bound-violated failure. Here's an example: ``` using ::testing::_;... EXPECT_CALL(turtle, Forward(_)); // #1 EXPECT_CALL(turtle, Forward(10)) // #2 .Times(2); ``` If `Forward(10)` is called three times in a row, the third time it will be an error, as the last matching expectation (#2) has been saturated. If, however, the third `Forward(10)` call is replaced by `Forward(20)`, then it would be OK, as now #1 will be the matching expectation. **Side note:** Why does Google Mock search for a match in the _reverse_ order of the expectations? The reason is that this allows a user to set up the default expectations in a mock object's constructor or the test fixture's set-up phase and then customize the mock by writing more specific expectations in the test body. So, if you have two expectations on the same method, you want to put the one with more specific matchers **after** the other, or the more specific rule would be shadowed by the more general one that comes after it. ## Ordered vs Unordered Calls ## By default, an expectation can match a call even though an earlier expectation hasn't been satisfied. In other words, the calls don't have to occur in the order the expectations are specified. Sometimes, you may want all the expected calls to occur in a strict order. To say this in Google Mock is easy: ``` using ::testing::InSequence;... TEST(FooTest, DrawsLineSegment) { ... { InSequence dummy; EXPECT_CALL(turtle, PenDown()); EXPECT_CALL(turtle, Forward(100)); EXPECT_CALL(turtle, PenUp()); } Foo(); } ``` By creating an object of type `InSequence`, all expectations in its scope are put into a _sequence_ and have to occur _sequentially_. Since we are just relying on the constructor and destructor of this object to do the actual work, its name is really irrelevant. In this example, we test that `Foo()` calls the three expected functions in the order as written. If a call is made out-of-order, it will be an error. (What if you care about the relative order of some of the calls, but not all of them? Can you specify an arbitrary partial order? The answer is ... yes! If you are impatient, the details can be found in the [CookBook](V1_7_CookBook#Expecting_Partially_Ordered_Calls.md).) ## All Expectations Are Sticky (Unless Said Otherwise) ## Now let's do a quick quiz to see how well you can use this mock stuff already. How would you test that the turtle is asked to go to the origin _exactly twice_ (you want to ignore any other instructions it receives)? After you've come up with your answer, take a look at ours and compare notes (solve it yourself first - don't cheat!): ``` using ::testing::_;... EXPECT_CALL(turtle, GoTo(_, _)) // #1 .Times(AnyNumber()); EXPECT_CALL(turtle, GoTo(0, 0)) // #2 .Times(2); ``` Suppose `turtle.GoTo(0, 0)` is called three times. In the third time, Google Mock will see that the arguments match expectation #2 (remember that we always pick the last matching expectation). Now, since we said that there should be only two such calls, Google Mock will report an error immediately. This is basically what we've told you in the "Using Multiple Expectations" section above. This example shows that **expectations in Google Mock are "sticky" by default**, in the sense that they remain active even after we have reached their invocation upper bounds. This is an important rule to remember, as it affects the meaning of the spec, and is **different** to how it's done in many other mocking frameworks (Why'd we do that? Because we think our rule makes the common cases easier to express and understand.). Simple? Let's see if you've really understood it: what does the following code say? ``` using ::testing::Return; ... for (int i = n; i > 0; i--) { EXPECT_CALL(turtle, GetX()) .WillOnce(Return(10*i)); } ``` If you think it says that `turtle.GetX()` will be called `n` times and will return 10, 20, 30, ..., consecutively, think twice! The problem is that, as we said, expectations are sticky. So, the second time `turtle.GetX()` is called, the last (latest) `EXPECT_CALL()` statement will match, and will immediately lead to an "upper bound exceeded" error - this piece of code is not very useful! One correct way of saying that `turtle.GetX()` will return 10, 20, 30, ..., is to explicitly say that the expectations are _not_ sticky. In other words, they should _retire_ as soon as they are saturated: ``` using ::testing::Return; ... for (int i = n; i > 0; i--) { EXPECT_CALL(turtle, GetX()) .WillOnce(Return(10*i)) .RetiresOnSaturation(); } ``` And, there's a better way to do it: in this case, we expect the calls to occur in a specific order, and we line up the actions to match the order. Since the order is important here, we should make it explicit using a sequence: ``` using ::testing::InSequence; using ::testing::Return; ... { InSequence s; for (int i = 1; i <= n; i++) { EXPECT_CALL(turtle, GetX()) .WillOnce(Return(10*i)) .RetiresOnSaturation(); } } ``` By the way, the other situation where an expectation may _not_ be sticky is when it's in a sequence - as soon as another expectation that comes after it in the sequence has been used, it automatically retires (and will never be used to match any call). ## Uninteresting Calls ## A mock object may have many methods, and not all of them are that interesting. For example, in some tests we may not care about how many times `GetX()` and `GetY()` get called. In Google Mock, if you are not interested in a method, just don't say anything about it. If a call to this method occurs, you'll see a warning in the test output, but it won't be a failure. # What Now? # Congratulations! You've learned enough about Google Mock to start using it. Now, you might want to join the [googlemock](http://groups.google.com/group/googlemock) discussion group and actually write some tests using Google Mock - it will be fun. Hey, it may even be addictive - you've been warned. Then, if you feel like increasing your mock quotient, you should move on to the [CookBook](V1_7_CookBook.md). You can learn many advanced features of Google Mock there -- and advance your level of enjoyment and testing bliss.vendor/googletest/gtest-1.7.0/googlemock/docs/v1_7/FrequentlyAskedQuestions.md000066400000000000000000000563041300002025200275030ustar00rootroot00000000000000 Please send your questions to the [googlemock](http://groups.google.com/group/googlemock) discussion group. If you need help with compiler errors, make sure you have tried [Google Mock Doctor](#How_am_I_supposed_to_make_sense_of_these_horrible_template_error.md) first. ## When I call a method on my mock object, the method for the real object is invoked instead. What's the problem? ## In order for a method to be mocked, it must be _virtual_, unless you use the [high-perf dependency injection technique](http://code.google.com/p/googlemock/wiki/V1_7_CookBook#Mocking_Nonvirtual_Methods). ## I wrote some matchers. After I upgraded to a new version of Google Mock, they no longer compile. What's going on? ## After version 1.4.0 of Google Mock was released, we had an idea on how to make it easier to write matchers that can generate informative messages efficiently. We experimented with this idea and liked what we saw. Therefore we decided to implement it. Unfortunately, this means that if you have defined your own matchers by implementing `MatcherInterface` or using `MakePolymorphicMatcher()`, your definitions will no longer compile. Matchers defined using the `MATCHER*` family of macros are not affected. Sorry for the hassle if your matchers are affected. We believe it's in everyone's long-term interest to make this change sooner than later. Fortunately, it's usually not hard to migrate an existing matcher to the new API. Here's what you need to do: If you wrote your matcher like this: ``` // Old matcher definition that doesn't work with the latest // Google Mock. using ::testing::MatcherInterface; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool Matches(MyType value) const { // Returns true if value matches. return value.GetFoo() > 5; } ... }; ``` you'll need to change it to: ``` // New matcher definition that works with the latest Google Mock. using ::testing::MatcherInterface; using ::testing::MatchResultListener; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. return value.GetFoo() > 5; } ... }; ``` (i.e. rename `Matches()` to `MatchAndExplain()` and give it a second argument of type `MatchResultListener*`.) If you were also using `ExplainMatchResultTo()` to improve the matcher message: ``` // Old matcher definition that doesn't work with the lastest // Google Mock. using ::testing::MatcherInterface; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool Matches(MyType value) const { // Returns true if value matches. return value.GetFoo() > 5; } virtual void ExplainMatchResultTo(MyType value, ::std::ostream* os) const { // Prints some helpful information to os to help // a user understand why value matches (or doesn't match). *os << "the Foo property is " << value.GetFoo(); } ... }; ``` you should move the logic of `ExplainMatchResultTo()` into `MatchAndExplain()`, using the `MatchResultListener` argument where the `::std::ostream` was used: ``` // New matcher definition that works with the latest Google Mock. using ::testing::MatcherInterface; using ::testing::MatchResultListener; ... class MyWonderfulMatcher : public MatcherInterface { public: ... virtual bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. *listener << "the Foo property is " << value.GetFoo(); return value.GetFoo() > 5; } ... }; ``` If your matcher is defined using `MakePolymorphicMatcher()`: ``` // Old matcher definition that doesn't work with the latest // Google Mock. using ::testing::MakePolymorphicMatcher; ... class MyGreatMatcher { public: ... bool Matches(MyType value) const { // Returns true if value matches. return value.GetBar() < 42; } ... }; ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` you should rename the `Matches()` method to `MatchAndExplain()` and add a `MatchResultListener*` argument (the same as what you need to do for matchers defined by implementing `MatcherInterface`): ``` // New matcher definition that works with the latest Google Mock. using ::testing::MakePolymorphicMatcher; using ::testing::MatchResultListener; ... class MyGreatMatcher { public: ... bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. return value.GetBar() < 42; } ... }; ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` If your polymorphic matcher uses `ExplainMatchResultTo()` for better failure messages: ``` // Old matcher definition that doesn't work with the latest // Google Mock. using ::testing::MakePolymorphicMatcher; ... class MyGreatMatcher { public: ... bool Matches(MyType value) const { // Returns true if value matches. return value.GetBar() < 42; } ... }; void ExplainMatchResultTo(const MyGreatMatcher& matcher, MyType value, ::std::ostream* os) { // Prints some helpful information to os to help // a user understand why value matches (or doesn't match). *os << "the Bar property is " << value.GetBar(); } ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` you'll need to move the logic inside `ExplainMatchResultTo()` to `MatchAndExplain()`: ``` // New matcher definition that works with the latest Google Mock. using ::testing::MakePolymorphicMatcher; using ::testing::MatchResultListener; ... class MyGreatMatcher { public: ... bool MatchAndExplain(MyType value, MatchResultListener* listener) const { // Returns true if value matches. *listener << "the Bar property is " << value.GetBar(); return value.GetBar() < 42; } ... }; ... MakePolymorphicMatcher(MyGreatMatcher()) ... ``` For more information, you can read these [two](http://code.google.com/p/googlemock/wiki/V1_7_CookBook#Writing_New_Monomorphic_Matchers) [recipes](http://code.google.com/p/googlemock/wiki/V1_7_CookBook#Writing_New_Polymorphic_Matchers) from the cookbook. As always, you are welcome to post questions on `googlemock@googlegroups.com` if you need any help. ## When using Google Mock, do I have to use Google Test as the testing framework? I have my favorite testing framework and don't want to switch. ## Google Mock works out of the box with Google Test. However, it's easy to configure it to work with any testing framework of your choice. [Here](http://code.google.com/p/googlemock/wiki/V1_7_ForDummies#Using_Google_Mock_with_Any_Testing_Framework) is how. ## How am I supposed to make sense of these horrible template errors? ## If you are confused by the compiler errors gcc threw at you, try consulting the _Google Mock Doctor_ tool first. What it does is to scan stdin for gcc error messages, and spit out diagnoses on the problems (we call them diseases) your code has. To "install", run command: ``` alias gmd='/scripts/gmock_doctor.py' ``` To use it, do: ``` 2>&1 | gmd ``` For example: ``` make my_test 2>&1 | gmd ``` Or you can run `gmd` and copy-n-paste gcc's error messages to it. ## Can I mock a variadic function? ## You cannot mock a variadic function (i.e. a function taking ellipsis (`...`) arguments) directly in Google Mock. The problem is that in general, there is _no way_ for a mock object to know how many arguments are passed to the variadic method, and what the arguments' types are. Only the _author of the base class_ knows the protocol, and we cannot look into his head. Therefore, to mock such a function, the _user_ must teach the mock object how to figure out the number of arguments and their types. One way to do it is to provide overloaded versions of the function. Ellipsis arguments are inherited from C and not really a C++ feature. They are unsafe to use and don't work with arguments that have constructors or destructors. Therefore we recommend to avoid them in C++ as much as possible. ## MSVC gives me warning C4301 or C4373 when I define a mock method with a const parameter. Why? ## If you compile this using Microsoft Visual C++ 2005 SP1: ``` class Foo { ... virtual void Bar(const int i) = 0; }; class MockFoo : public Foo { ... MOCK_METHOD1(Bar, void(const int i)); }; ``` You may get the following warning: ``` warning C4301: 'MockFoo::Bar': overriding virtual function only differs from 'Foo::Bar' by const/volatile qualifier ``` This is a MSVC bug. The same code compiles fine with gcc ,for example. If you use Visual C++ 2008 SP1, you would get the warning: ``` warning C4373: 'MockFoo::Bar': virtual function overrides 'Foo::Bar', previous versions of the compiler did not override when parameters only differed by const/volatile qualifiers ``` In C++, if you _declare_ a function with a `const` parameter, the `const` modifier is _ignored_. Therefore, the `Foo` base class above is equivalent to: ``` class Foo { ... virtual void Bar(int i) = 0; // int or const int? Makes no difference. }; ``` In fact, you can _declare_ Bar() with an `int` parameter, and _define_ it with a `const int` parameter. The compiler will still match them up. Since making a parameter `const` is meaningless in the method _declaration_, we recommend to remove it in both `Foo` and `MockFoo`. That should workaround the VC bug. Note that we are talking about the _top-level_ `const` modifier here. If the function parameter is passed by pointer or reference, declaring the _pointee_ or _referee_ as `const` is still meaningful. For example, the following two declarations are _not_ equivalent: ``` void Bar(int* p); // Neither p nor *p is const. void Bar(const int* p); // p is not const, but *p is. ``` ## I have a huge mock class, and Microsoft Visual C++ runs out of memory when compiling it. What can I do? ## We've noticed that when the `/clr` compiler flag is used, Visual C++ uses 5~6 times as much memory when compiling a mock class. We suggest to avoid `/clr` when compiling native C++ mocks. ## I can't figure out why Google Mock thinks my expectations are not satisfied. What should I do? ## You might want to run your test with `--gmock_verbose=info`. This flag lets Google Mock print a trace of every mock function call it receives. By studying the trace, you'll gain insights on why the expectations you set are not met. ## How can I assert that a function is NEVER called? ## ``` EXPECT_CALL(foo, Bar(_)) .Times(0); ``` ## I have a failed test where Google Mock tells me TWICE that a particular expectation is not satisfied. Isn't this redundant? ## When Google Mock detects a failure, it prints relevant information (the mock function arguments, the state of relevant expectations, and etc) to help the user debug. If another failure is detected, Google Mock will do the same, including printing the state of relevant expectations. Sometimes an expectation's state didn't change between two failures, and you'll see the same description of the state twice. They are however _not_ redundant, as they refer to _different points in time_. The fact they are the same _is_ interesting information. ## I get a heap check failure when using a mock object, but using a real object is fine. What can be wrong? ## Does the class (hopefully a pure interface) you are mocking have a virtual destructor? Whenever you derive from a base class, make sure its destructor is virtual. Otherwise Bad Things will happen. Consider the following code: ``` class Base { public: // Not virtual, but should be. ~Base() { ... } ... }; class Derived : public Base { public: ... private: std::string value_; }; ... Base* p = new Derived; ... delete p; // Surprise! ~Base() will be called, but ~Derived() will not // - value_ is leaked. ``` By changing `~Base()` to virtual, `~Derived()` will be correctly called when `delete p` is executed, and the heap checker will be happy. ## The "newer expectations override older ones" rule makes writing expectations awkward. Why does Google Mock do that? ## When people complain about this, often they are referring to code like: ``` // foo.Bar() should be called twice, return 1 the first time, and return // 2 the second time. However, I have to write the expectations in the // reverse order. This sucks big time!!! EXPECT_CALL(foo, Bar()) .WillOnce(Return(2)) .RetiresOnSaturation(); EXPECT_CALL(foo, Bar()) .WillOnce(Return(1)) .RetiresOnSaturation(); ``` The problem is that they didn't pick the **best** way to express the test's intent. By default, expectations don't have to be matched in _any_ particular order. If you want them to match in a certain order, you need to be explicit. This is Google Mock's (and jMock's) fundamental philosophy: it's easy to accidentally over-specify your tests, and we want to make it harder to do so. There are two better ways to write the test spec. You could either put the expectations in sequence: ``` // foo.Bar() should be called twice, return 1 the first time, and return // 2 the second time. Using a sequence, we can write the expectations // in their natural order. { InSequence s; EXPECT_CALL(foo, Bar()) .WillOnce(Return(1)) .RetiresOnSaturation(); EXPECT_CALL(foo, Bar()) .WillOnce(Return(2)) .RetiresOnSaturation(); } ``` or you can put the sequence of actions in the same expectation: ``` // foo.Bar() should be called twice, return 1 the first time, and return // 2 the second time. EXPECT_CALL(foo, Bar()) .WillOnce(Return(1)) .WillOnce(Return(2)) .RetiresOnSaturation(); ``` Back to the original questions: why does Google Mock search the expectations (and `ON_CALL`s) from back to front? Because this allows a user to set up a mock's behavior for the common case early (e.g. in the mock's constructor or the test fixture's set-up phase) and customize it with more specific rules later. If Google Mock searches from front to back, this very useful pattern won't be possible. ## Google Mock prints a warning when a function without EXPECT\_CALL is called, even if I have set its behavior using ON\_CALL. Would it be reasonable not to show the warning in this case? ## When choosing between being neat and being safe, we lean toward the latter. So the answer is that we think it's better to show the warning. Often people write `ON_CALL`s in the mock object's constructor or `SetUp()`, as the default behavior rarely changes from test to test. Then in the test body they set the expectations, which are often different for each test. Having an `ON_CALL` in the set-up part of a test doesn't mean that the calls are expected. If there's no `EXPECT_CALL` and the method is called, it's possibly an error. If we quietly let the call go through without notifying the user, bugs may creep in unnoticed. If, however, you are sure that the calls are OK, you can write ``` EXPECT_CALL(foo, Bar(_)) .WillRepeatedly(...); ``` instead of ``` ON_CALL(foo, Bar(_)) .WillByDefault(...); ``` This tells Google Mock that you do expect the calls and no warning should be printed. Also, you can control the verbosity using the `--gmock_verbose` flag. If you find the output too noisy when debugging, just choose a less verbose level. ## How can I delete the mock function's argument in an action? ## If you find yourself needing to perform some action that's not supported by Google Mock directly, remember that you can define your own actions using [MakeAction()](http://code.google.com/p/googlemock/wiki/V1_7_CookBook#Writing_New_Actions) or [MakePolymorphicAction()](http://code.google.com/p/googlemock/wiki/V1_7_CookBook#Writing_New_Polymorphic_Actions), or you can write a stub function and invoke it using [Invoke()](http://code.google.com/p/googlemock/wiki/V1_7_CookBook#Using_Functions_Methods_Functors). ## MOCK\_METHODn()'s second argument looks funny. Why don't you use the MOCK\_METHODn(Method, return\_type, arg\_1, ..., arg\_n) syntax? ## What?! I think it's beautiful. :-) While which syntax looks more natural is a subjective matter to some extent, Google Mock's syntax was chosen for several practical advantages it has. Try to mock a function that takes a map as an argument: ``` virtual int GetSize(const map& m); ``` Using the proposed syntax, it would be: ``` MOCK_METHOD1(GetSize, int, const map& m); ``` Guess what? You'll get a compiler error as the compiler thinks that `const map& m` are **two**, not one, arguments. To work around this you can use `typedef` to give the map type a name, but that gets in the way of your work. Google Mock's syntax avoids this problem as the function's argument types are protected inside a pair of parentheses: ``` // This compiles fine. MOCK_METHOD1(GetSize, int(const map& m)); ``` You still need a `typedef` if the return type contains an unprotected comma, but that's much rarer. Other advantages include: 1. `MOCK_METHOD1(Foo, int, bool)` can leave a reader wonder whether the method returns `int` or `bool`, while there won't be such confusion using Google Mock's syntax. 1. The way Google Mock describes a function type is nothing new, although many people may not be familiar with it. The same syntax was used in C, and the `function` library in `tr1` uses this syntax extensively. Since `tr1` will become a part of the new version of STL, we feel very comfortable to be consistent with it. 1. The function type syntax is also used in other parts of Google Mock's API (e.g. the action interface) in order to make the implementation tractable. A user needs to learn it anyway in order to utilize Google Mock's more advanced features. We'd as well stick to the same syntax in `MOCK_METHOD*`! ## My code calls a static/global function. Can I mock it? ## You can, but you need to make some changes. In general, if you find yourself needing to mock a static function, it's a sign that your modules are too tightly coupled (and less flexible, less reusable, less testable, etc). You are probably better off defining a small interface and call the function through that interface, which then can be easily mocked. It's a bit of work initially, but usually pays for itself quickly. This Google Testing Blog [post](http://googletesting.blogspot.com/2008/06/defeat-static-cling.html) says it excellently. Check it out. ## My mock object needs to do complex stuff. It's a lot of pain to specify the actions. Google Mock sucks! ## I know it's not a question, but you get an answer for free any way. :-) With Google Mock, you can create mocks in C++ easily. And people might be tempted to use them everywhere. Sometimes they work great, and sometimes you may find them, well, a pain to use. So, what's wrong in the latter case? When you write a test without using mocks, you exercise the code and assert that it returns the correct value or that the system is in an expected state. This is sometimes called "state-based testing". Mocks are great for what some call "interaction-based" testing: instead of checking the system state at the very end, mock objects verify that they are invoked the right way and report an error as soon as it arises, giving you a handle on the precise context in which the error was triggered. This is often more effective and economical to do than state-based testing. If you are doing state-based testing and using a test double just to simulate the real object, you are probably better off using a fake. Using a mock in this case causes pain, as it's not a strong point for mocks to perform complex actions. If you experience this and think that mocks suck, you are just not using the right tool for your problem. Or, you might be trying to solve the wrong problem. :-) ## I got a warning "Uninteresting function call encountered - default action taken.." Should I panic? ## By all means, NO! It's just an FYI. What it means is that you have a mock function, you haven't set any expectations on it (by Google Mock's rule this means that you are not interested in calls to this function and therefore it can be called any number of times), and it is called. That's OK - you didn't say it's not OK to call the function! What if you actually meant to disallow this function to be called, but forgot to write `EXPECT_CALL(foo, Bar()).Times(0)`? While one can argue that it's the user's fault, Google Mock tries to be nice and prints you a note. So, when you see the message and believe that there shouldn't be any uninteresting calls, you should investigate what's going on. To make your life easier, Google Mock prints the function name and arguments when an uninteresting call is encountered. ## I want to define a custom action. Should I use Invoke() or implement the action interface? ## Either way is fine - you want to choose the one that's more convenient for your circumstance. Usually, if your action is for a particular function type, defining it using `Invoke()` should be easier; if your action can be used in functions of different types (e.g. if you are defining `Return(value)`), `MakePolymorphicAction()` is easiest. Sometimes you want precise control on what types of functions the action can be used in, and implementing `ActionInterface` is the way to go here. See the implementation of `Return()` in `include/gmock/gmock-actions.h` for an example. ## I'm using the set-argument-pointee action, and the compiler complains about "conflicting return type specified". What does it mean? ## You got this error as Google Mock has no idea what value it should return when the mock method is called. `SetArgPointee()` says what the side effect is, but doesn't say what the return value should be. You need `DoAll()` to chain a `SetArgPointee()` with a `Return()`. See this [recipe](http://code.google.com/p/googlemock/wiki/V1_7_CookBook#Mocking_Side_Effects) for more details and an example. ## My question is not in your FAQ! ## If you cannot find the answer to your question in this FAQ, there are some other resources you can use: 1. read other [wiki pages](http://code.google.com/p/googlemock/w/list), 1. search the mailing list [archive](http://groups.google.com/group/googlemock/topics), 1. ask it on [googlemock@googlegroups.com](mailto:googlemock@googlegroups.com) and someone will answer it (to prevent spam, we require you to join the [discussion group](http://groups.google.com/group/googlemock) before you can post.). Please note that creating an issue in the [issue tracker](http://code.google.com/p/googlemock/issues/list) is _not_ a good way to get your answer, as it is monitored infrequently by a very small number of people. When asking a question, it's helpful to provide as much of the following information as possible (people cannot help you if there's not enough information in your question): * the version (or the revision number if you check out from SVN directly) of Google Mock you use (Google Mock is under active development, so it's possible that your problem has been solved in a later version), * your operating system, * the name and version of your compiler, * the complete command line flags you give to your compiler, * the complete compiler error messages (if the question is about compilation), * the _actual_ code (ideally, a minimal but complete program) that has the problem you encounter.vendor/googletest/gtest-1.7.0/googlemock/include/000077500000000000000000000000001300002025200220475ustar00rootroot00000000000000vendor/googletest/gtest-1.7.0/googlemock/include/gmock/000077500000000000000000000000001300002025200231475ustar00rootroot00000000000000vendor/googletest/gtest-1.7.0/googlemock/include/gmock/gmock-actions.h000066400000000000000000001204131300002025200260570ustar00rootroot00000000000000// Copyright 2007, Google Inc. // 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 Google Inc. 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. // // Author: wan@google.com (Zhanyong Wan) // Google Mock - a framework for writing C++ mock classes. // // This file implements some commonly used actions. #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_ACTIONS_H_ #define GMOCK_INCLUDE_GMOCK_GMOCK_ACTIONS_H_ #ifndef _WIN32_WCE # include #endif #include #include #include "gmock/internal/gmock-internal-utils.h" #include "gmock/internal/gmock-port.h" #if GTEST_HAS_STD_TYPE_TRAITS_ // Defined by gtest-port.h via gmock-port.h. #include #endif namespace testing { // To implement an action Foo, define: // 1. a class FooAction that implements the ActionInterface interface, and // 2. a factory function that creates an Action object from a // const FooAction*. // // The two-level delegation design follows that of Matcher, providing // consistency for extension developers. It also eases ownership // management as Action objects can now be copied like plain values. namespace internal { template class ActionAdaptor; // BuiltInDefaultValueGetter::Get() returns a // default-constructed T value. BuiltInDefaultValueGetter::Get() crashes with an error. // // This primary template is used when kDefaultConstructible is true. template struct BuiltInDefaultValueGetter { static T Get() { return T(); } }; template struct BuiltInDefaultValueGetter { static T Get() { Assert(false, __FILE__, __LINE__, "Default action undefined for the function return type."); return internal::Invalid(); // The above statement will never be reached, but is required in // order for this function to compile. } }; // BuiltInDefaultValue::Get() returns the "built-in" default value // for type T, which is NULL when T is a raw pointer type, 0 when T is // a numeric type, false when T is bool, or "" when T is string or // std::string. In addition, in C++11 and above, it turns a // default-constructed T value if T is default constructible. For any // other type T, the built-in default T value is undefined, and the // function will abort the process. template class BuiltInDefaultValue { public: #if GTEST_HAS_STD_TYPE_TRAITS_ // This function returns true iff type T has a built-in default value. static bool Exists() { return ::std::is_default_constructible::value; } static T Get() { return BuiltInDefaultValueGetter< T, ::std::is_default_constructible::value>::Get(); } #else // GTEST_HAS_STD_TYPE_TRAITS_ // This function returns true iff type T has a built-in default value. static bool Exists() { return false; } static T Get() { return BuiltInDefaultValueGetter::Get(); } #endif // GTEST_HAS_STD_TYPE_TRAITS_ }; // This partial specialization says that we use the same built-in // default value for T and const T. template class BuiltInDefaultValue { public: static bool Exists() { return BuiltInDefaultValue::Exists(); } static T Get() { return BuiltInDefaultValue::Get(); } }; // This partial specialization defines the default values for pointer // types. template class BuiltInDefaultValue { public: static bool Exists() { return true; } static T* Get() { return NULL; } }; // The following specializations define the default values for // specific types we care about. #define GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(type, value) \ template <> \ class BuiltInDefaultValue { \ public: \ static bool Exists() { return true; } \ static type Get() { return value; } \ } GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(void, ); // NOLINT #if GTEST_HAS_GLOBAL_STRING GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(::string, ""); #endif // GTEST_HAS_GLOBAL_STRING GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(::std::string, ""); GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(bool, false); GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned char, '\0'); GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed char, '\0'); GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(char, '\0'); // There's no need for a default action for signed wchar_t, as that // type is the same as wchar_t for gcc, and invalid for MSVC. // // There's also no need for a default action for unsigned wchar_t, as // that type is the same as unsigned int for gcc, and invalid for // MSVC. #if GMOCK_WCHAR_T_IS_NATIVE_ GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(wchar_t, 0U); // NOLINT #endif GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned short, 0U); // NOLINT GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed short, 0); // NOLINT GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned int, 0U); GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed int, 0); GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned long, 0UL); // NOLINT GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed long, 0L); // NOLINT GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(UInt64, 0); GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(Int64, 0); GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(float, 0); GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(double, 0); #undef GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_ } // namespace internal // When an unexpected function call is encountered, Google Mock will // let it return a default value if the user has specified one for its // return type, or if the return type has a built-in default value; // otherwise Google Mock won't know what value to return and will have // to abort the process. // // The DefaultValue class allows a user to specify the // default value for a type T that is both copyable and publicly // destructible (i.e. anything that can be used as a function return // type). The usage is: // // // Sets the default value for type T to be foo. // DefaultValue::Set(foo); template class DefaultValue { public: // Sets the default value for type T; requires T to be // copy-constructable and have a public destructor. static void Set(T x) { delete producer_; producer_ = new FixedValueProducer(x); } // Provides a factory function to be called to generate the default value. // This method can be used even if T is only move-constructible, but it is not // limited to that case. typedef T (*FactoryFunction)(); static void SetFactory(FactoryFunction factory) { delete producer_; producer_ = new FactoryValueProducer(factory); } // Unsets the default value for type T. static void Clear() { delete producer_; producer_ = NULL; } // Returns true iff the user has set the default value for type T. static bool IsSet() { return producer_ != NULL; } // Returns true if T has a default return value set by the user or there // exists a built-in default value. static bool Exists() { return IsSet() || internal::BuiltInDefaultValue::Exists(); } // Returns the default value for type T if the user has set one; // otherwise returns the built-in default value. Requires that Exists() // is true, which ensures that the return value is well-defined. static T Get() { return producer_ == NULL ? internal::BuiltInDefaultValue::Get() : producer_->Produce(); } private: class ValueProducer { public: virtual ~ValueProducer() {} virtual T Produce() = 0; }; class FixedValueProducer : public ValueProducer { public: explicit FixedValueProducer(T value) : value_(value) {} virtual T Produce() { return value_; } private: const T value_; GTEST_DISALLOW_COPY_AND_ASSIGN_(FixedValueProducer); }; class FactoryValueProducer : public ValueProducer { public: explicit FactoryValueProducer(FactoryFunction factory) : factory_(factory) {} virtual T Produce() { return factory_(); } private: const FactoryFunction factory_; GTEST_DISALLOW_COPY_AND_ASSIGN_(FactoryValueProducer); }; static ValueProducer* producer_; }; // This partial specialization allows a user to set default values for // reference types. template class DefaultValue { public: // Sets the default value for type T&. static void Set(T& x) { // NOLINT address_ = &x; } // Unsets the default value for type T&. static void Clear() { address_ = NULL; } // Returns true iff the user has set the default value for type T&. static bool IsSet() { return address_ != NULL; } // Returns true if T has a default return value set by the user or there // exists a built-in default value. static bool Exists() { return IsSet() || internal::BuiltInDefaultValue::Exists(); } // Returns the default value for type T& if the user has set one; // otherwise returns the built-in default value if there is one; // otherwise aborts the process. static T& Get() { return address_ == NULL ? internal::BuiltInDefaultValue::Get() : *address_; } private: static T* address_; }; // This specialization allows DefaultValue::Get() to // compile. template <> class DefaultValue { public: static bool Exists() { return true; } static void Get() {} }; // Points to the user-set default value for type T. template typename DefaultValue::ValueProducer* DefaultValue::producer_ = NULL; // Points to the user-set default value for type T&. template T* DefaultValue::address_ = NULL; // Implement this interface to define an action for function type F. template class ActionInterface { public: typedef typename internal::Function::Result Result; typedef typename internal::Function::ArgumentTuple ArgumentTuple; ActionInterface() {} virtual ~ActionInterface() {} // Performs the action. This method is not const, as in general an // action can have side effects and be stateful. For example, a // get-the-next-element-from-the-collection action will need to // remember the current element. virtual Result Perform(const ArgumentTuple& args) = 0; private: GTEST_DISALLOW_COPY_AND_ASSIGN_(ActionInterface); }; // An Action is a copyable and IMMUTABLE (except by assignment) // object that represents an action to be taken when a mock function // of type F is called. The implementation of Action is just a // linked_ptr to const ActionInterface, so copying is fairly cheap. // Don't inherit from Action! // // You can view an object implementing ActionInterface as a // concrete action (including its current state), and an Action // object as a handle to it. template class Action { public: typedef typename internal::Function::Result Result; typedef typename internal::Function::ArgumentTuple ArgumentTuple; // Constructs a null Action. Needed for storing Action objects in // STL containers. Action() : impl_(NULL) {} // Constructs an Action from its implementation. A NULL impl is // used to represent the "do-default" action. explicit Action(ActionInterface* impl) : impl_(impl) {} // Copy constructor. Action(const Action& action) : impl_(action.impl_) {} // This constructor allows us to turn an Action object into an // Action, as long as F's arguments can be implicitly converted // to Func's and Func's return type can be implicitly converted to // F's. template explicit Action(const Action& action); // Returns true iff this is the DoDefault() action. bool IsDoDefault() const { return impl_.get() == NULL; } // Performs the action. Note that this method is const even though // the corresponding method in ActionInterface is not. The reason // is that a const Action means that it cannot be re-bound to // another concrete action, not that the concrete action it binds to // cannot change state. (Think of the difference between a const // pointer and a pointer to const.) Result Perform(const ArgumentTuple& args) const { internal::Assert( !IsDoDefault(), __FILE__, __LINE__, "You are using DoDefault() inside a composite action like " "DoAll() or WithArgs(). This is not supported for technical " "reasons. Please instead spell out the default action, or " "assign the default action to an Action variable and use " "the variable in various places."); return impl_->Perform(args); } private: template friend class internal::ActionAdaptor; internal::linked_ptr > impl_; }; // The PolymorphicAction class template makes it easy to implement a // polymorphic action (i.e. an action that can be used in mock // functions of than one type, e.g. Return()). // // To define a polymorphic action, a user first provides a COPYABLE // implementation class that has a Perform() method template: // // class FooAction { // public: // template // Result Perform(const ArgumentTuple& args) const { // // Processes the arguments and returns a result, using // // tr1::get(args) to get the N-th (0-based) argument in the tuple. // } // ... // }; // // Then the user creates the polymorphic action using // MakePolymorphicAction(object) where object has type FooAction. See // the definition of Return(void) and SetArgumentPointee(value) for // complete examples. template class PolymorphicAction { public: explicit PolymorphicAction(const Impl& impl) : impl_(impl) {} template operator Action() const { return Action(new MonomorphicImpl(impl_)); } private: template class MonomorphicImpl : public ActionInterface { public: typedef typename internal::Function::Result Result; typedef typename internal::Function::ArgumentTuple ArgumentTuple; explicit MonomorphicImpl(const Impl& impl) : impl_(impl) {} virtual Result Perform(const ArgumentTuple& args) { return impl_.template Perform(args); } private: Impl impl_; GTEST_DISALLOW_ASSIGN_(MonomorphicImpl); }; Impl impl_; GTEST_DISALLOW_ASSIGN_(PolymorphicAction); }; // Creates an Action from its implementation and returns it. The // created Action object owns the implementation. template Action MakeAction(ActionInterface* impl) { return Action(impl); } // Creates a polymorphic action from its implementation. This is // easier to use than the PolymorphicAction constructor as it // doesn't require you to explicitly write the template argument, e.g. // // MakePolymorphicAction(foo); // vs // PolymorphicAction(foo); template inline PolymorphicAction MakePolymorphicAction(const Impl& impl) { return PolymorphicAction(impl); } namespace internal { // Allows an Action object to pose as an Action, as long as F2 // and F1 are compatible. template class ActionAdaptor : public ActionInterface { public: typedef typename internal::Function::Result Result; typedef typename internal::Function::ArgumentTuple ArgumentTuple; explicit ActionAdaptor(const Action& from) : impl_(from.impl_) {} virtual Result Perform(const ArgumentTuple& args) { return impl_->Perform(args); } private: const internal::linked_ptr > impl_; GTEST_DISALLOW_ASSIGN_(ActionAdaptor); }; // Helper struct to specialize ReturnAction to execute a move instead of a copy // on return. Useful for move-only types, but could be used on any type. template struct ByMoveWrapper { explicit ByMoveWrapper(T value) : payload(internal::move(value)) {} T payload; }; // Implements the polymorphic Return(x) action, which can be used in // any function that returns the type of x, regardless of the argument // types. // // Note: The value passed into Return must be converted into // Function::Result when this action is cast to Action rather than // when that action is performed. This is important in scenarios like // // MOCK_METHOD1(Method, T(U)); // ... // { // Foo foo; // X x(&foo); // EXPECT_CALL(mock, Method(_)).WillOnce(Return(x)); // } // // In the example above the variable x holds reference to foo which leaves // scope and gets destroyed. If copying X just copies a reference to foo, // that copy will be left with a hanging reference. If conversion to T // makes a copy of foo, the above code is safe. To support that scenario, we // need to make sure that the type conversion happens inside the EXPECT_CALL // statement, and conversion of the result of Return to Action is a // good place for that. // template class ReturnAction { public: // Constructs a ReturnAction object from the value to be returned. // 'value' is passed by value instead of by const reference in order // to allow Return("string literal") to compile. explicit ReturnAction(R value) : value_(new R(internal::move(value))) {} // This template type conversion operator allows Return(x) to be // used in ANY function that returns x's type. template operator Action() const { // Assert statement belongs here because this is the best place to verify // conditions on F. It produces the clearest error messages // in most compilers. // Impl really belongs in this scope as a local class but can't // because MSVC produces duplicate symbols in different translation units // in this case. Until MS fixes that bug we put Impl into the class scope // and put the typedef both here (for use in assert statement) and // in the Impl class. But both definitions must be the same. typedef typename Function::Result Result; GTEST_COMPILE_ASSERT_( !is_reference::value, use_ReturnRef_instead_of_Return_to_return_a_reference); return Action(new Impl(value_)); } private: // Implements the Return(x) action for a particular function type F. template class Impl : public ActionInterface { public: typedef typename Function::Result Result; typedef typename Function::ArgumentTuple ArgumentTuple; // The implicit cast is necessary when Result has more than one // single-argument constructor (e.g. Result is std::vector) and R // has a type conversion operator template. In that case, value_(value) // won't compile as the compiler doesn't known which constructor of // Result to call. ImplicitCast_ forces the compiler to convert R to // Result without considering explicit constructors, thus resolving the // ambiguity. value_ is then initialized using its copy constructor. explicit Impl(const linked_ptr& value) : value_before_cast_(*value), value_(ImplicitCast_(value_before_cast_)) {} virtual Result Perform(const ArgumentTuple&) { return value_; } private: GTEST_COMPILE_ASSERT_(!is_reference::value, Result_cannot_be_a_reference_type); // We save the value before casting just in case it is being cast to a // wrapper type. R value_before_cast_; Result value_; GTEST_DISALLOW_COPY_AND_ASSIGN_(Impl); }; // Partially specialize for ByMoveWrapper. This version of ReturnAction will // move its contents instead. template class Impl, F> : public ActionInterface { public: typedef typename Function::Result Result; typedef typename Function::ArgumentTuple ArgumentTuple; explicit Impl(const linked_ptr& wrapper) : performed_(false), wrapper_(wrapper) {} virtual Result Perform(const ArgumentTuple&) { GTEST_CHECK_(!performed_) << "A ByMove() action should only be performed once."; performed_ = true; return internal::move(wrapper_->payload); } private: bool performed_; const linked_ptr wrapper_; GTEST_DISALLOW_ASSIGN_(Impl); }; const linked_ptr value_; GTEST_DISALLOW_ASSIGN_(ReturnAction); }; // Implements the ReturnNull() action. class ReturnNullAction { public: // Allows ReturnNull() to be used in any pointer-returning function. In C++11 // this is enforced by returning nullptr, and in non-C++11 by asserting a // pointer type on compile time. template static Result Perform(const ArgumentTuple&) { #if GTEST_LANG_CXX11 return nullptr; #else GTEST_COMPILE_ASSERT_(internal::is_pointer::value, ReturnNull_can_be_used_to_return_a_pointer_only); return NULL; #endif // GTEST_LANG_CXX11 } }; // Implements the Return() action. class ReturnVoidAction { public: // Allows Return() to be used in any void-returning function. template static void Perform(const ArgumentTuple&) { CompileAssertTypesEqual(); } }; // Implements the polymorphic ReturnRef(x) action, which can be used // in any function that returns a reference to the type of x, // regardless of the argument types. template class ReturnRefAction { public: // Constructs a ReturnRefAction object from the reference to be returned. explicit ReturnRefAction(T& ref) : ref_(ref) {} // NOLINT // This template type conversion operator allows ReturnRef(x) to be // used in ANY function that returns a reference to x's type. template operator Action() const { typedef typename Function::Result Result; // Asserts that the function return type is a reference. This // catches the user error of using ReturnRef(x) when Return(x) // should be used, and generates some helpful error message. GTEST_COMPILE_ASSERT_(internal::is_reference::value, use_Return_instead_of_ReturnRef_to_return_a_value); return Action(new Impl(ref_)); } private: // Implements the ReturnRef(x) action for a particular function type F. template class Impl : public ActionInterface { public: typedef typename Function::Result Result; typedef typename Function::ArgumentTuple ArgumentTuple; explicit Impl(T& ref) : ref_(ref) {} // NOLINT virtual Result Perform(const ArgumentTuple&) { return ref_; } private: T& ref_; GTEST_DISALLOW_ASSIGN_(Impl); }; T& ref_; GTEST_DISALLOW_ASSIGN_(ReturnRefAction); }; // Implements the polymorphic ReturnRefOfCopy(x) action, which can be // used in any function that returns a reference to the type of x, // regardless of the argument types. template class ReturnRefOfCopyAction { public: // Constructs a ReturnRefOfCopyAction object from the reference to // be returned. explicit ReturnRefOfCopyAction(const T& value) : value_(value) {} // NOLINT // This template type conversion operator allows ReturnRefOfCopy(x) to be // used in ANY function that returns a reference to x's type. template operator Action() const { typedef typename Function::Result Result; // Asserts that the function return type is a reference. This // catches the user error of using ReturnRefOfCopy(x) when Return(x) // should be used, and generates some helpful error message. GTEST_COMPILE_ASSERT_( internal::is_reference::value, use_Return_instead_of_ReturnRefOfCopy_to_return_a_value); return Action(new Impl(value_)); } private: // Implements the ReturnRefOfCopy(x) action for a particular function type F. template class Impl : public ActionInterface { public: typedef typename Function::Result Result; typedef typename Function::ArgumentTuple ArgumentTuple; explicit Impl(const T& value) : value_(value) {} // NOLINT virtual Result Perform(const ArgumentTuple&) { return value_; } private: T value_; GTEST_DISALLOW_ASSIGN_(Impl); }; const T value_; GTEST_DISALLOW_ASSIGN_(ReturnRefOfCopyAction); }; // Implements the polymorphic DoDefault() action. class DoDefaultAction { public: // This template type conversion operator allows DoDefault() to be // used in any function. template operator Action() const { return Action(NULL); } }; // Implements the Assign action to set a given pointer referent to a // particular value. template class AssignAction { public: AssignAction(T1* ptr, T2 value) : ptr_(ptr), value_(value) {} template void Perform(const ArgumentTuple& /* args */) const { *ptr_ = value_; } private: T1* const ptr_; const T2 value_; GTEST_DISALLOW_ASSIGN_(AssignAction); }; #if !GTEST_OS_WINDOWS_MOBILE // Implements the SetErrnoAndReturn action to simulate return from // various system calls and libc functions. template class SetErrnoAndReturnAction { public: SetErrnoAndReturnAction(int errno_value, T result) : errno_(errno_value), result_(result) {} template Result Perform(const ArgumentTuple& /* args */) const { errno = errno_; return result_; } private: const int errno_; const T result_; GTEST_DISALLOW_ASSIGN_(SetErrnoAndReturnAction); }; #endif // !GTEST_OS_WINDOWS_MOBILE // Implements the SetArgumentPointee(x) action for any function // whose N-th argument (0-based) is a pointer to x's type. The // template parameter kIsProto is true iff type A is ProtocolMessage, // proto2::Message, or a sub-class of those. template class SetArgumentPointeeAction { public: // Constructs an action that sets the variable pointed to by the // N-th function argument to 'value'. explicit SetArgumentPointeeAction(const A& value) : value_(value) {} template void Perform(const ArgumentTuple& args) const { CompileAssertTypesEqual(); *::testing::get(args) = value_; } private: const A value_; GTEST_DISALLOW_ASSIGN_(SetArgumentPointeeAction); }; template class SetArgumentPointeeAction { public: // Constructs an action that sets the variable pointed to by the // N-th function argument to 'proto'. Both ProtocolMessage and // proto2::Message have the CopyFrom() method, so the same // implementation works for both. explicit SetArgumentPointeeAction(const Proto& proto) : proto_(new Proto) { proto_->CopyFrom(proto); } template void Perform(const ArgumentTuple& args) const { CompileAssertTypesEqual(); ::testing::get(args)->CopyFrom(*proto_); } private: const internal::linked_ptr proto_; GTEST_DISALLOW_ASSIGN_(SetArgumentPointeeAction); }; // Implements the InvokeWithoutArgs(f) action. The template argument // FunctionImpl is the implementation type of f, which can be either a // function pointer or a functor. InvokeWithoutArgs(f) can be used as an // Action as long as f's type is compatible with F (i.e. f can be // assigned to a tr1::function). template class InvokeWithoutArgsAction { public: // The c'tor makes a copy of function_impl (either a function // pointer or a functor). explicit InvokeWithoutArgsAction(FunctionImpl function_impl) : function_impl_(function_impl) {} // Allows InvokeWithoutArgs(f) to be used as any action whose type is // compatible with f. template Result Perform(const ArgumentTuple&) { return function_impl_(); } private: FunctionImpl function_impl_; GTEST_DISALLOW_ASSIGN_(InvokeWithoutArgsAction); }; // Implements the InvokeWithoutArgs(object_ptr, &Class::Method) action. template class InvokeMethodWithoutArgsAction { public: InvokeMethodWithoutArgsAction(Class* obj_ptr, MethodPtr method_ptr) : obj_ptr_(obj_ptr), method_ptr_(method_ptr) {} template Result Perform(const ArgumentTuple&) const { return (obj_ptr_->*method_ptr_)(); } private: Class* const obj_ptr_; const MethodPtr method_ptr_; GTEST_DISALLOW_ASSIGN_(InvokeMethodWithoutArgsAction); }; // Implements the IgnoreResult(action) action. template class IgnoreResultAction { public: explicit IgnoreResultAction(const A& action) : action_(action) {} template operator Action() const { // Assert statement belongs here because this is the best place to verify // conditions on F. It produces the clearest error messages // in most compilers. // Impl really belongs in this scope as a local class but can't // because MSVC produces duplicate symbols in different translation units // in this case. Until MS fixes that bug we put Impl into the class scope // and put the typedef both here (for use in assert statement) and // in the Impl class. But both definitions must be the same. typedef typename internal::Function::Result Result; // Asserts at compile time that F returns void. CompileAssertTypesEqual(); return Action(new Impl(action_)); } private: template class Impl : public ActionInterface { public: typedef typename internal::Function::Result Result; typedef typename internal::Function::ArgumentTuple ArgumentTuple; explicit Impl(const A& action) : action_(action) {} virtual void Perform(const ArgumentTuple& args) { // Performs the action and ignores its result. action_.Perform(args); } private: // Type OriginalFunction is the same as F except that its return // type is IgnoredValue. typedef typename internal::Function::MakeResultIgnoredValue OriginalFunction; const Action action_; GTEST_DISALLOW_ASSIGN_(Impl); }; const A action_; GTEST_DISALLOW_ASSIGN_(IgnoreResultAction); }; // A ReferenceWrapper object represents a reference to type T, // which can be either const or not. It can be explicitly converted // from, and implicitly converted to, a T&. Unlike a reference, // ReferenceWrapper can be copied and can survive template type // inference. This is used to support by-reference arguments in the // InvokeArgument(...) action. The idea was from "reference // wrappers" in tr1, which we don't have in our source tree yet. template class ReferenceWrapper { public: // Constructs a ReferenceWrapper object from a T&. explicit ReferenceWrapper(T& l_value) : pointer_(&l_value) {} // NOLINT // Allows a ReferenceWrapper object to be implicitly converted to // a T&. operator T&() const { return *pointer_; } private: T* pointer_; }; // Allows the expression ByRef(x) to be printed as a reference to x. template void PrintTo(const ReferenceWrapper& ref, ::std::ostream* os) { T& value = ref; UniversalPrinter::Print(value, os); } // Does two actions sequentially. Used for implementing the DoAll(a1, // a2, ...) action. template class DoBothAction { public: DoBothAction(Action1 action1, Action2 action2) : action1_(action1), action2_(action2) {} // This template type conversion operator allows DoAll(a1, ..., a_n) // to be used in ANY function of compatible type. template operator Action() const { return Action(new Impl(action1_, action2_)); } private: // Implements the DoAll(...) action for a particular function type F. template class Impl : public ActionInterface { public: typedef typename Function::Result Result; typedef typename Function::ArgumentTuple ArgumentTuple; typedef typename Function::MakeResultVoid VoidResult; Impl(const Action& action1, const Action& action2) : action1_(action1), action2_(action2) {} virtual Result Perform(const ArgumentTuple& args) { action1_.Perform(args); return action2_.Perform(args); } private: const Action action1_; const Action action2_; GTEST_DISALLOW_ASSIGN_(Impl); }; Action1 action1_; Action2 action2_; GTEST_DISALLOW_ASSIGN_(DoBothAction); }; } // namespace internal // An Unused object can be implicitly constructed from ANY value. // This is handy when defining actions that ignore some or all of the // mock function arguments. For example, given // // MOCK_METHOD3(Foo, double(const string& label, double x, double y)); // MOCK_METHOD3(Bar, double(int index, double x, double y)); // // instead of // // double DistanceToOriginWithLabel(const string& label, double x, double y) { // return sqrt(x*x + y*y); // } // double DistanceToOriginWithIndex(int index, double x, double y) { // return sqrt(x*x + y*y); // } // ... // EXEPCT_CALL(mock, Foo("abc", _, _)) // .WillOnce(Invoke(DistanceToOriginWithLabel)); // EXEPCT_CALL(mock, Bar(5, _, _)) // .WillOnce(Invoke(DistanceToOriginWithIndex)); // // you could write // // // We can declare any uninteresting argument as Unused. // double DistanceToOrigin(Unused, double x, double y) { // return sqrt(x*x + y*y); // } // ... // EXEPCT_CALL(mock, Foo("abc", _, _)).WillOnce(Invoke(DistanceToOrigin)); // EXEPCT_CALL(mock, Bar(5, _, _)).WillOnce(Invoke(DistanceToOrigin)); typedef internal::IgnoredValue Unused; // This constructor allows us to turn an Action object into an // Action, as long as To's arguments can be implicitly converted // to From's and From's return type cann be implicitly converted to // To's. template template Action::Action(const Action& from) : impl_(new internal::ActionAdaptor(from)) {} // Creates an action that returns 'value'. 'value' is passed by value // instead of const reference - otherwise Return("string literal") // will trigger a compiler error about using array as initializer. template internal::ReturnAction Return(R value) { return internal::ReturnAction(internal::move(value)); } // Creates an action that returns NULL. inline PolymorphicAction ReturnNull() { return MakePolymorphicAction(internal::ReturnNullAction()); } // Creates an action that returns from a void function. inline PolymorphicAction Return() { return MakePolymorphicAction(internal::ReturnVoidAction()); } // Creates an action that returns the reference to a variable. template inline internal::ReturnRefAction ReturnRef(R& x) { // NOLINT return internal::ReturnRefAction(x); } // Creates an action that returns the reference to a copy of the // argument. The copy is created when the action is constructed and // lives as long as the action. template inline internal::ReturnRefOfCopyAction ReturnRefOfCopy(const R& x) { return internal::ReturnRefOfCopyAction(x); } // Modifies the parent action (a Return() action) to perform a move of the // argument instead of a copy. // Return(ByMove()) actions can only be executed once and will assert this // invariant. template internal::ByMoveWrapper ByMove(R x) { return internal::ByMoveWrapper(internal::move(x)); } // Creates an action that does the default action for the give mock function. inline internal::DoDefaultAction DoDefault() { return internal::DoDefaultAction(); } // Creates an action that sets the variable pointed by the N-th // (0-based) function argument to 'value'. template PolymorphicAction< internal::SetArgumentPointeeAction< N, T, internal::IsAProtocolMessage::value> > SetArgPointee(const T& x) { return MakePolymorphicAction(internal::SetArgumentPointeeAction< N, T, internal::IsAProtocolMessage::value>(x)); } #if !((GTEST_GCC_VER_ && GTEST_GCC_VER_ < 40000) || GTEST_OS_SYMBIAN) // This overload allows SetArgPointee() to accept a string literal. // GCC prior to the version 4.0 and Symbian C++ compiler cannot distinguish // this overload from the templated version and emit a compile error. template PolymorphicAction< internal::SetArgumentPointeeAction > SetArgPointee(const char* p) { return MakePolymorphicAction(internal::SetArgumentPointeeAction< N, const char*, false>(p)); } template PolymorphicAction< internal::SetArgumentPointeeAction > SetArgPointee(const wchar_t* p) { return MakePolymorphicAction(internal::SetArgumentPointeeAction< N, const wchar_t*, false>(p)); } #endif // The following version is DEPRECATED. template PolymorphicAction< internal::SetArgumentPointeeAction< N, T, internal::IsAProtocolMessage::value> > SetArgumentPointee(const T& x) { return MakePolymorphicAction(internal::SetArgumentPointeeAction< N, T, internal::IsAProtocolMessage::value>(x)); } // Creates an action that sets a pointer referent to a given value. template PolymorphicAction > Assign(T1* ptr, T2 val) { return MakePolymorphicAction(internal::AssignAction(ptr, val)); } #if !GTEST_OS_WINDOWS_MOBILE // Creates an action that sets errno and returns the appropriate error. template PolymorphicAction > SetErrnoAndReturn(int errval, T result) { return MakePolymorphicAction( internal::SetErrnoAndReturnAction(errval, result)); } #endif // !GTEST_OS_WINDOWS_MOBILE // Various overloads for InvokeWithoutArgs(). // Creates an action that invokes 'function_impl' with no argument. template PolymorphicAction > InvokeWithoutArgs(FunctionImpl function_impl) { return MakePolymorphicAction( internal::InvokeWithoutArgsAction(function_impl)); } // Creates an action that invokes the given method on the given object // with no argument. template PolymorphicAction > InvokeWithoutArgs(Class* obj_ptr, MethodPtr method_ptr) { return MakePolymorphicAction( internal::InvokeMethodWithoutArgsAction( obj_ptr, method_ptr)); } // Creates an action that performs an_action and throws away its // result. In other words, it changes the return type of an_action to // void. an_action MUST NOT return void, or the code won't compile. template inline internal::IgnoreResultAction IgnoreResult(const A& an_action) { return internal::IgnoreResultAction(an_action); } // Creates a reference wrapper for the given L-value. If necessary, // you can explicitly specify the type of the reference. For example, // suppose 'derived' is an object of type Derived, ByRef(derived) // would wrap a Derived&. If you want to wrap a const Base& instead, // where Base is a base class of Derived, just write: // // ByRef(derived) template inline internal::ReferenceWrapper ByRef(T& l_value) { // NOLINT return internal::ReferenceWrapper(l_value); } } // namespace testing #endif // GMOCK_INCLUDE_GMOCK_GMOCK_ACTIONS_H_ vendor/googletest/gtest-1.7.0/googlemock/include/gmock/gmock-cardinalities.h000066400000000000000000000132741300002025200272400ustar00rootroot00000000000000// Copyright 2007, Google Inc. // 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 Google Inc. 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. // // Author: wan@google.com (Zhanyong Wan) // Google Mock - a framework for writing C++ mock classes. // // This file implements some commonly used cardinalities. More // cardinalities can be defined by the user implementing the // CardinalityInterface interface if necessary. #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_CARDINALITIES_H_ #define GMOCK_INCLUDE_GMOCK_GMOCK_CARDINALITIES_H_ #include #include // NOLINT #include "gmock/internal/gmock-port.h" #include "gtest/gtest.h" namespace testing { // To implement a cardinality Foo, define: // 1. a class FooCardinality that implements the // CardinalityInterface interface, and // 2. a factory function that creates a Cardinality object from a // const FooCardinality*. // // The two-level delegation design follows that of Matcher, providing // consistency for extension developers. It also eases ownership // management as Cardinality objects can now be copied like plain values. // The implementation of a cardinality. class CardinalityInterface { public: virtual ~CardinalityInterface() {} // Conservative estimate on the lower/upper bound of the number of // calls allowed. virtual int ConservativeLowerBound() const { return 0; } virtual int ConservativeUpperBound() const { return INT_MAX; } // Returns true iff call_count calls will satisfy this cardinality. virtual bool IsSatisfiedByCallCount(int call_count) const = 0; // Returns true iff call_count calls will saturate this cardinality. virtual bool IsSaturatedByCallCount(int call_count) const = 0; // Describes self to an ostream. virtual void DescribeTo(::std::ostream* os) const = 0; }; // A Cardinality is a copyable and IMMUTABLE (except by assignment) // object that specifies how many times a mock function is expected to // be called. The implementation of Cardinality is just a linked_ptr // to const CardinalityInterface, so copying is fairly cheap. // Don't inherit from Cardinality! class GTEST_API_ Cardinality { public: // Constructs a null cardinality. Needed for storing Cardinality // objects in STL containers. Cardinality() {} // Constructs a Cardinality from its implementation. explicit Cardinality(const CardinalityInterface* impl) : impl_(impl) {} // Conservative estimate on the lower/upper bound of the number of // calls allowed. int ConservativeLowerBound() const { return impl_->ConservativeLowerBound(); } int ConservativeUpperBound() const { return impl_->ConservativeUpperBound(); } // Returns true iff call_count calls will satisfy this cardinality. bool IsSatisfiedByCallCount(int call_count) const { return impl_->IsSatisfiedByCallCount(call_count); } // Returns true iff call_count calls will saturate this cardinality. bool IsSaturatedByCallCount(int call_count) const { return impl_->IsSaturatedByCallCount(call_count); } // Returns true iff call_count calls will over-saturate this // cardinality, i.e. exceed the maximum number of allowed calls. bool IsOverSaturatedByCallCount(int call_count) const { return impl_->IsSaturatedByCallCount(call_count) && !impl_->IsSatisfiedByCallCount(call_count); } // Describes self to an ostream void DescribeTo(::std::ostream* os) const { impl_->DescribeTo(os); } // Describes the given actual call count to an ostream. static void DescribeActualCallCountTo(int actual_call_count, ::std::ostream* os); private: internal::linked_ptr impl_; }; // Creates a cardinality that allows at least n calls. GTEST_API_ Cardinality AtLeast(int n); // Creates a cardinality that allows at most n calls. GTEST_API_ Cardinality AtMost(int n); // Creates a cardinality that allows any number of calls. GTEST_API_ Cardinality AnyNumber(); // Creates a cardinality that allows between min and max calls. GTEST_API_ Cardinality Between(int min, int max); // Creates a cardinality that allows exactly n calls. GTEST_API_ Cardinality Exactly(int n); // Creates a cardinality from its implementation. inline Cardinality MakeCardinality(const CardinalityInterface* c) { return Cardinality(c); } } // namespace testing #endif // GMOCK_INCLUDE_GMOCK_GMOCK_CARDINALITIES_H_ vendor/googletest/gtest-1.7.0/googlemock/include/gmock/gmock-generated-actions.h000066400000000000000000003134641300002025200300250ustar00rootroot00000000000000// This file was GENERATED by a script. DO NOT EDIT BY HAND!!! // Copyright 2007, Google Inc. // 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 Google Inc. 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. // // Author: wan@google.com (Zhanyong Wan) // Google Mock - a framework for writing C++ mock classes. // // This file implements some commonly used variadic actions. #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_ACTIONS_H_ #define GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_ACTIONS_H_ #include "gmock/gmock-actions.h" #include "gmock/internal/gmock-port.h" namespace testing { namespace internal { // InvokeHelper knows how to unpack an N-tuple and invoke an N-ary // function or method with the unpacked values, where F is a function // type that takes N arguments. template class InvokeHelper; template class InvokeHelper > { public: template static R Invoke(Function function, const ::testing::tuple<>&) { return function(); } template static R InvokeMethod(Class* obj_ptr, MethodPtr method_ptr, const ::testing::tuple<>&) { return (obj_ptr->*method_ptr)(); } }; template class InvokeHelper > { public: template static R Invoke(Function function, const ::testing::tuple& args) { return function(get<0>(args)); } template static R InvokeMethod(Class* obj_ptr, MethodPtr method_ptr, const ::testing::tuple& args) { return (obj_ptr->*method_ptr)(get<0>(args)); } }; template class InvokeHelper > { public: template static R Invoke(Function function, const ::testing::tuple& args) { return function(get<0>(args), get<1>(args)); } template static R InvokeMethod(Class* obj_ptr, MethodPtr method_ptr, const ::testing::tuple& args) { return (obj_ptr->*method_ptr)(get<0>(args), get<1>(args)); } }; template class InvokeHelper > { public: template static R Invoke(Function function, const ::testing::tuple& args) { return function(get<0>(args), get<1>(args), get<2>(args)); } template static R InvokeMethod(Class* obj_ptr, MethodPtr method_ptr, const ::testing::tuple& args) { return (obj_ptr->*method_ptr)(get<0>(args), get<1>(args), get<2>(args)); } }; template class InvokeHelper > { public: template static R Invoke(Function function, const ::testing::tuple& args) { return function(get<0>(args), get<1>(args), get<2>(args), get<3>(args)); } template static R InvokeMethod(Class* obj_ptr, MethodPtr method_ptr, const ::testing::tuple& args) { return (obj_ptr->*method_ptr)(get<0>(args), get<1>(args), get<2>(args), get<3>(args)); } }; template class InvokeHelper > { public: template static R Invoke(Function function, const ::testing::tuple& args) { return function(get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args)); } template static R InvokeMethod(Class* obj_ptr, MethodPtr method_ptr, const ::testing::tuple& args) { return (obj_ptr->*method_ptr)(get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args)); } }; template class InvokeHelper > { public: template static R Invoke(Function function, const ::testing::tuple& args) { return function(get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args)); } template static R InvokeMethod(Class* obj_ptr, MethodPtr method_ptr, const ::testing::tuple& args) { return (obj_ptr->*method_ptr)(get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args)); } }; template class InvokeHelper > { public: template static R Invoke(Function function, const ::testing::tuple& args) { return function(get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), get<6>(args)); } template static R InvokeMethod(Class* obj_ptr, MethodPtr method_ptr, const ::testing::tuple& args) { return (obj_ptr->*method_ptr)(get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), get<6>(args)); } }; template class InvokeHelper > { public: template static R Invoke(Function function, const ::testing::tuple& args) { return function(get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), get<6>(args), get<7>(args)); } template static R InvokeMethod(Class* obj_ptr, MethodPtr method_ptr, const ::testing::tuple& args) { return (obj_ptr->*method_ptr)(get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), get<6>(args), get<7>(args)); } }; template class InvokeHelper > { public: template static R Invoke(Function function, const ::testing::tuple& args) { return function(get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), get<6>(args), get<7>(args), get<8>(args)); } template static R InvokeMethod(Class* obj_ptr, MethodPtr method_ptr, const ::testing::tuple& args) { return (obj_ptr->*method_ptr)(get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), get<6>(args), get<7>(args), get<8>(args)); } }; template class InvokeHelper > { public: template static R Invoke(Function function, const ::testing::tuple& args) { return function(get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), get<6>(args), get<7>(args), get<8>(args), get<9>(args)); } template static R InvokeMethod(Class* obj_ptr, MethodPtr method_ptr, const ::testing::tuple& args) { return (obj_ptr->*method_ptr)(get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), get<6>(args), get<7>(args), get<8>(args), get<9>(args)); } }; // An INTERNAL macro for extracting the type of a tuple field. It's // subject to change without notice - DO NOT USE IN USER CODE! #define GMOCK_FIELD_(Tuple, N) \ typename ::testing::tuple_element::type // SelectArgs::type is the // type of an n-ary function whose i-th (1-based) argument type is the // k{i}-th (0-based) field of ArgumentTuple, which must be a tuple // type, and whose return type is Result. For example, // SelectArgs, 0, 3>::type // is int(bool, long). // // SelectArgs::Select(args) // returns the selected fields (k1, k2, ..., k_n) of args as a tuple. // For example, // SelectArgs, 2, 0>::Select( // ::testing::make_tuple(true, 'a', 2.5)) // returns tuple (2.5, true). // // The numbers in list k1, k2, ..., k_n must be >= 0, where n can be // in the range [0, 10]. Duplicates are allowed and they don't have // to be in an ascending or descending order. template class SelectArgs { public: typedef Result type(GMOCK_FIELD_(ArgumentTuple, k1), GMOCK_FIELD_(ArgumentTuple, k2), GMOCK_FIELD_(ArgumentTuple, k3), GMOCK_FIELD_(ArgumentTuple, k4), GMOCK_FIELD_(ArgumentTuple, k5), GMOCK_FIELD_(ArgumentTuple, k6), GMOCK_FIELD_(ArgumentTuple, k7), GMOCK_FIELD_(ArgumentTuple, k8), GMOCK_FIELD_(ArgumentTuple, k9), GMOCK_FIELD_(ArgumentTuple, k10)); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& args) { return SelectedArgs(get(args), get(args), get(args), get(args), get(args), get(args), get(args), get(args), get(args), get(args)); } }; template class SelectArgs { public: typedef Result type(); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& /* args */) { return SelectedArgs(); } }; template class SelectArgs { public: typedef Result type(GMOCK_FIELD_(ArgumentTuple, k1)); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& args) { return SelectedArgs(get(args)); } }; template class SelectArgs { public: typedef Result type(GMOCK_FIELD_(ArgumentTuple, k1), GMOCK_FIELD_(ArgumentTuple, k2)); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& args) { return SelectedArgs(get(args), get(args)); } }; template class SelectArgs { public: typedef Result type(GMOCK_FIELD_(ArgumentTuple, k1), GMOCK_FIELD_(ArgumentTuple, k2), GMOCK_FIELD_(ArgumentTuple, k3)); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& args) { return SelectedArgs(get(args), get(args), get(args)); } }; template class SelectArgs { public: typedef Result type(GMOCK_FIELD_(ArgumentTuple, k1), GMOCK_FIELD_(ArgumentTuple, k2), GMOCK_FIELD_(ArgumentTuple, k3), GMOCK_FIELD_(ArgumentTuple, k4)); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& args) { return SelectedArgs(get(args), get(args), get(args), get(args)); } }; template class SelectArgs { public: typedef Result type(GMOCK_FIELD_(ArgumentTuple, k1), GMOCK_FIELD_(ArgumentTuple, k2), GMOCK_FIELD_(ArgumentTuple, k3), GMOCK_FIELD_(ArgumentTuple, k4), GMOCK_FIELD_(ArgumentTuple, k5)); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& args) { return SelectedArgs(get(args), get(args), get(args), get(args), get(args)); } }; template class SelectArgs { public: typedef Result type(GMOCK_FIELD_(ArgumentTuple, k1), GMOCK_FIELD_(ArgumentTuple, k2), GMOCK_FIELD_(ArgumentTuple, k3), GMOCK_FIELD_(ArgumentTuple, k4), GMOCK_FIELD_(ArgumentTuple, k5), GMOCK_FIELD_(ArgumentTuple, k6)); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& args) { return SelectedArgs(get(args), get(args), get(args), get(args), get(args), get(args)); } }; template class SelectArgs { public: typedef Result type(GMOCK_FIELD_(ArgumentTuple, k1), GMOCK_FIELD_(ArgumentTuple, k2), GMOCK_FIELD_(ArgumentTuple, k3), GMOCK_FIELD_(ArgumentTuple, k4), GMOCK_FIELD_(ArgumentTuple, k5), GMOCK_FIELD_(ArgumentTuple, k6), GMOCK_FIELD_(ArgumentTuple, k7)); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& args) { return SelectedArgs(get(args), get(args), get(args), get(args), get(args), get(args), get(args)); } }; template class SelectArgs { public: typedef Result type(GMOCK_FIELD_(ArgumentTuple, k1), GMOCK_FIELD_(ArgumentTuple, k2), GMOCK_FIELD_(ArgumentTuple, k3), GMOCK_FIELD_(ArgumentTuple, k4), GMOCK_FIELD_(ArgumentTuple, k5), GMOCK_FIELD_(ArgumentTuple, k6), GMOCK_FIELD_(ArgumentTuple, k7), GMOCK_FIELD_(ArgumentTuple, k8)); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& args) { return SelectedArgs(get(args), get(args), get(args), get(args), get(args), get(args), get(args), get(args)); } }; template class SelectArgs { public: typedef Result type(GMOCK_FIELD_(ArgumentTuple, k1), GMOCK_FIELD_(ArgumentTuple, k2), GMOCK_FIELD_(ArgumentTuple, k3), GMOCK_FIELD_(ArgumentTuple, k4), GMOCK_FIELD_(ArgumentTuple, k5), GMOCK_FIELD_(ArgumentTuple, k6), GMOCK_FIELD_(ArgumentTuple, k7), GMOCK_FIELD_(ArgumentTuple, k8), GMOCK_FIELD_(ArgumentTuple, k9)); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& args) { return SelectedArgs(get(args), get(args), get(args), get(args), get(args), get(args), get(args), get(args), get(args)); } }; #undef GMOCK_FIELD_ // Implements the WithArgs action. template class WithArgsAction { public: explicit WithArgsAction(const InnerAction& action) : action_(action) {} template operator Action() const { return MakeAction(new Impl(action_)); } private: template class Impl : public ActionInterface { public: typedef typename Function::Result Result; typedef typename Function::ArgumentTuple ArgumentTuple; explicit Impl(const InnerAction& action) : action_(action) {} virtual Result Perform(const ArgumentTuple& args) { return action_.Perform(SelectArgs::Select(args)); } private: typedef typename SelectArgs::type InnerFunctionType; Action action_; }; const InnerAction action_; GTEST_DISALLOW_ASSIGN_(WithArgsAction); }; // A macro from the ACTION* family (defined later in this file) // defines an action that can be used in a mock function. Typically, // these actions only care about a subset of the arguments of the mock // function. For example, if such an action only uses the second // argument, it can be used in any mock function that takes >= 2 // arguments where the type of the second argument is compatible. // // Therefore, the action implementation must be prepared to take more // arguments than it needs. The ExcessiveArg type is used to // represent those excessive arguments. In order to keep the compiler // error messages tractable, we define it in the testing namespace // instead of testing::internal. However, this is an INTERNAL TYPE // and subject to change without notice, so a user MUST NOT USE THIS // TYPE DIRECTLY. struct ExcessiveArg {}; // A helper class needed for implementing the ACTION* macros. template class ActionHelper { public: static Result Perform(Impl* impl, const ::testing::tuple<>& args) { return impl->template gmock_PerformImpl<>(args, ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg()); } template static Result Perform(Impl* impl, const ::testing::tuple& args) { return impl->template gmock_PerformImpl(args, get<0>(args), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg()); } template static Result Perform(Impl* impl, const ::testing::tuple& args) { return impl->template gmock_PerformImpl(args, get<0>(args), get<1>(args), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg()); } template static Result Perform(Impl* impl, const ::testing::tuple& args) { return impl->template gmock_PerformImpl(args, get<0>(args), get<1>(args), get<2>(args), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg()); } template static Result Perform(Impl* impl, const ::testing::tuple& args) { return impl->template gmock_PerformImpl(args, get<0>(args), get<1>(args), get<2>(args), get<3>(args), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg()); } template static Result Perform(Impl* impl, const ::testing::tuple& args) { return impl->template gmock_PerformImpl(args, get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg()); } template static Result Perform(Impl* impl, const ::testing::tuple& args) { return impl->template gmock_PerformImpl(args, get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), ExcessiveArg(), ExcessiveArg(), ExcessiveArg(), ExcessiveArg()); } template static Result Perform(Impl* impl, const ::testing::tuple& args) { return impl->template gmock_PerformImpl(args, get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), get<6>(args), ExcessiveArg(), ExcessiveArg(), ExcessiveArg()); } template static Result Perform(Impl* impl, const ::testing::tuple& args) { return impl->template gmock_PerformImpl(args, get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), get<6>(args), get<7>(args), ExcessiveArg(), ExcessiveArg()); } template static Result Perform(Impl* impl, const ::testing::tuple& args) { return impl->template gmock_PerformImpl(args, get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), get<6>(args), get<7>(args), get<8>(args), ExcessiveArg()); } template static Result Perform(Impl* impl, const ::testing::tuple& args) { return impl->template gmock_PerformImpl(args, get<0>(args), get<1>(args), get<2>(args), get<3>(args), get<4>(args), get<5>(args), get<6>(args), get<7>(args), get<8>(args), get<9>(args)); } }; } // namespace internal // Various overloads for Invoke(). // WithArgs(an_action) creates an action that passes // the selected arguments of the mock function to an_action and // performs it. It serves as an adaptor between actions with // different argument lists. C++ doesn't support default arguments for // function templates, so we have to overload it. template inline internal::WithArgsAction WithArgs(const InnerAction& action) { return internal::WithArgsAction(action); } template inline internal::WithArgsAction WithArgs(const InnerAction& action) { return internal::WithArgsAction(action); } template inline internal::WithArgsAction WithArgs(const InnerAction& action) { return internal::WithArgsAction(action); } template inline internal::WithArgsAction WithArgs(const InnerAction& action) { return internal::WithArgsAction(action); } template inline internal::WithArgsAction WithArgs(const InnerAction& action) { return internal::WithArgsAction(action); } template inline internal::WithArgsAction WithArgs(const InnerAction& action) { return internal::WithArgsAction(action); } template inline internal::WithArgsAction WithArgs(const InnerAction& action) { return internal::WithArgsAction(action); } template inline internal::WithArgsAction WithArgs(const InnerAction& action) { return internal::WithArgsAction(action); } template inline internal::WithArgsAction WithArgs(const InnerAction& action) { return internal::WithArgsAction(action); } template inline internal::WithArgsAction WithArgs(const InnerAction& action) { return internal::WithArgsAction(action); } // Creates an action that does actions a1, a2, ..., sequentially in // each invocation. template inline internal::DoBothAction DoAll(Action1 a1, Action2 a2) { return internal::DoBothAction(a1, a2); } template inline internal::DoBothAction > DoAll(Action1 a1, Action2 a2, Action3 a3) { return DoAll(a1, DoAll(a2, a3)); } template inline internal::DoBothAction > > DoAll(Action1 a1, Action2 a2, Action3 a3, Action4 a4) { return DoAll(a1, DoAll(a2, a3, a4)); } template inline internal::DoBothAction > > > DoAll(Action1 a1, Action2 a2, Action3 a3, Action4 a4, Action5 a5) { return DoAll(a1, DoAll(a2, a3, a4, a5)); } template inline internal::DoBothAction > > > > DoAll(Action1 a1, Action2 a2, Action3 a3, Action4 a4, Action5 a5, Action6 a6) { return DoAll(a1, DoAll(a2, a3, a4, a5, a6)); } template inline internal::DoBothAction > > > > > DoAll(Action1 a1, Action2 a2, Action3 a3, Action4 a4, Action5 a5, Action6 a6, Action7 a7) { return DoAll(a1, DoAll(a2, a3, a4, a5, a6, a7)); } template inline internal::DoBothAction > > > > > > DoAll(Action1 a1, Action2 a2, Action3 a3, Action4 a4, Action5 a5, Action6 a6, Action7 a7, Action8 a8) { return DoAll(a1, DoAll(a2, a3, a4, a5, a6, a7, a8)); } template inline internal::DoBothAction > > > > > > > DoAll(Action1 a1, Action2 a2, Action3 a3, Action4 a4, Action5 a5, Action6 a6, Action7 a7, Action8 a8, Action9 a9) { return DoAll(a1, DoAll(a2, a3, a4, a5, a6, a7, a8, a9)); } template inline internal::DoBothAction > > > > > > > > DoAll(Action1 a1, Action2 a2, Action3 a3, Action4 a4, Action5 a5, Action6 a6, Action7 a7, Action8 a8, Action9 a9, Action10 a10) { return DoAll(a1, DoAll(a2, a3, a4, a5, a6, a7, a8, a9, a10)); } } // namespace testing // The ACTION* family of macros can be used in a namespace scope to // define custom actions easily. The syntax: // // ACTION(name) { statements; } // // will define an action with the given name that executes the // statements. The value returned by the statements will be used as // the return value of the action. Inside the statements, you can // refer to the K-th (0-based) argument of the mock function by // 'argK', and refer to its type by 'argK_type'. For example: // // ACTION(IncrementArg1) { // arg1_type temp = arg1; // return ++(*temp); // } // // allows you to write // // ...WillOnce(IncrementArg1()); // // You can also refer to the entire argument tuple and its type by // 'args' and 'args_type', and refer to the mock function type and its // return type by 'function_type' and 'return_type'. // // Note that you don't need to specify the types of the mock function // arguments. However rest assured that your code is still type-safe: // you'll get a compiler error if *arg1 doesn't support the ++ // operator, or if the type of ++(*arg1) isn't compatible with the // mock function's return type, for example. // // Sometimes you'll want to parameterize the action. For that you can use // another macro: // // ACTION_P(name, param_name) { statements; } // // For example: // // ACTION_P(Add, n) { return arg0 + n; } // // will allow you to write: // // ...WillOnce(Add(5)); // // Note that you don't need to provide the type of the parameter // either. If you need to reference the type of a parameter named // 'foo', you can write 'foo_type'. For example, in the body of // ACTION_P(Add, n) above, you can write 'n_type' to refer to the type // of 'n'. // // We also provide ACTION_P2, ACTION_P3, ..., up to ACTION_P10 to support // multi-parameter actions. // // For the purpose of typing, you can view // // ACTION_Pk(Foo, p1, ..., pk) { ... } // // as shorthand for // // template // FooActionPk Foo(p1_type p1, ..., pk_type pk) { ... } // // In particular, you can provide the template type arguments // explicitly when invoking Foo(), as in Foo(5, false); // although usually you can rely on the compiler to infer the types // for you automatically. You can assign the result of expression // Foo(p1, ..., pk) to a variable of type FooActionPk. This can be useful when composing actions. // // You can also overload actions with different numbers of parameters: // // ACTION_P(Plus, a) { ... } // ACTION_P2(Plus, a, b) { ... } // // While it's tempting to always use the ACTION* macros when defining // a new action, you should also consider implementing ActionInterface // or using MakePolymorphicAction() instead, especially if you need to // use the action a lot. While these approaches require more work, // they give you more control on the types of the mock function // arguments and the action parameters, which in general leads to // better compiler error messages that pay off in the long run. They // also allow overloading actions based on parameter types (as opposed // to just based on the number of parameters). // // CAVEAT: // // ACTION*() can only be used in a namespace scope. The reason is // that C++ doesn't yet allow function-local types to be used to // instantiate templates. The up-coming C++0x standard will fix this. // Once that's done, we'll consider supporting using ACTION*() inside // a function. // // MORE INFORMATION: // // To learn more about using these macros, please search for 'ACTION' // on http://code.google.com/p/googlemock/wiki/CookBook. // An internal macro needed for implementing ACTION*(). #define GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_\ const args_type& args GTEST_ATTRIBUTE_UNUSED_, \ arg0_type arg0 GTEST_ATTRIBUTE_UNUSED_, \ arg1_type arg1 GTEST_ATTRIBUTE_UNUSED_, \ arg2_type arg2 GTEST_ATTRIBUTE_UNUSED_, \ arg3_type arg3 GTEST_ATTRIBUTE_UNUSED_, \ arg4_type arg4 GTEST_ATTRIBUTE_UNUSED_, \ arg5_type arg5 GTEST_ATTRIBUTE_UNUSED_, \ arg6_type arg6 GTEST_ATTRIBUTE_UNUSED_, \ arg7_type arg7 GTEST_ATTRIBUTE_UNUSED_, \ arg8_type arg8 GTEST_ATTRIBUTE_UNUSED_, \ arg9_type arg9 GTEST_ATTRIBUTE_UNUSED_ // Sometimes you want to give an action explicit template parameters // that cannot be inferred from its value parameters. ACTION() and // ACTION_P*() don't support that. ACTION_TEMPLATE() remedies that // and can be viewed as an extension to ACTION() and ACTION_P*(). // // The syntax: // // ACTION_TEMPLATE(ActionName, // HAS_m_TEMPLATE_PARAMS(kind1, name1, ..., kind_m, name_m), // AND_n_VALUE_PARAMS(p1, ..., p_n)) { statements; } // // defines an action template that takes m explicit template // parameters and n value parameters. name_i is the name of the i-th // template parameter, and kind_i specifies whether it's a typename, // an integral constant, or a template. p_i is the name of the i-th // value parameter. // // Example: // // // DuplicateArg(output) converts the k-th argument of the mock // // function to type T and copies it to *output. // ACTION_TEMPLATE(DuplicateArg, // HAS_2_TEMPLATE_PARAMS(int, k, typename, T), // AND_1_VALUE_PARAMS(output)) { // *output = T(::testing::get(args)); // } // ... // int n; // EXPECT_CALL(mock, Foo(_, _)) // .WillOnce(DuplicateArg<1, unsigned char>(&n)); // // To create an instance of an action template, write: // // ActionName(v1, ..., v_n) // // where the ts are the template arguments and the vs are the value // arguments. The value argument types are inferred by the compiler. // If you want to explicitly specify the value argument types, you can // provide additional template arguments: // // ActionName(v1, ..., v_n) // // where u_i is the desired type of v_i. // // ACTION_TEMPLATE and ACTION/ACTION_P* can be overloaded on the // number of value parameters, but not on the number of template // parameters. Without the restriction, the meaning of the following // is unclear: // // OverloadedAction(x); // // Are we using a single-template-parameter action where 'bool' refers // to the type of x, or are we using a two-template-parameter action // where the compiler is asked to infer the type of x? // // Implementation notes: // // GMOCK_INTERNAL_*_HAS_m_TEMPLATE_PARAMS and // GMOCK_INTERNAL_*_AND_n_VALUE_PARAMS are internal macros for // implementing ACTION_TEMPLATE. The main trick we use is to create // new macro invocations when expanding a macro. For example, we have // // #define ACTION_TEMPLATE(name, template_params, value_params) // ... GMOCK_INTERNAL_DECL_##template_params ... // // which causes ACTION_TEMPLATE(..., HAS_1_TEMPLATE_PARAMS(typename, T), ...) // to expand to // // ... GMOCK_INTERNAL_DECL_HAS_1_TEMPLATE_PARAMS(typename, T) ... // // Since GMOCK_INTERNAL_DECL_HAS_1_TEMPLATE_PARAMS is a macro, the // preprocessor will continue to expand it to // // ... typename T ... // // This technique conforms to the C++ standard and is portable. It // allows us to implement action templates using O(N) code, where N is // the maximum number of template/value parameters supported. Without // using it, we'd have to devote O(N^2) amount of code to implement all // combinations of m and n. // Declares the template parameters. #define GMOCK_INTERNAL_DECL_HAS_1_TEMPLATE_PARAMS(kind0, name0) kind0 name0 #define GMOCK_INTERNAL_DECL_HAS_2_TEMPLATE_PARAMS(kind0, name0, kind1, \ name1) kind0 name0, kind1 name1 #define GMOCK_INTERNAL_DECL_HAS_3_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2) kind0 name0, kind1 name1, kind2 name2 #define GMOCK_INTERNAL_DECL_HAS_4_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2, kind3, name3) kind0 name0, kind1 name1, kind2 name2, \ kind3 name3 #define GMOCK_INTERNAL_DECL_HAS_5_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2, kind3, name3, kind4, name4) kind0 name0, kind1 name1, \ kind2 name2, kind3 name3, kind4 name4 #define GMOCK_INTERNAL_DECL_HAS_6_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2, kind3, name3, kind4, name4, kind5, name5) kind0 name0, \ kind1 name1, kind2 name2, kind3 name3, kind4 name4, kind5 name5 #define GMOCK_INTERNAL_DECL_HAS_7_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2, kind3, name3, kind4, name4, kind5, name5, kind6, \ name6) kind0 name0, kind1 name1, kind2 name2, kind3 name3, kind4 name4, \ kind5 name5, kind6 name6 #define GMOCK_INTERNAL_DECL_HAS_8_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2, kind3, name3, kind4, name4, kind5, name5, kind6, name6, \ kind7, name7) kind0 name0, kind1 name1, kind2 name2, kind3 name3, \ kind4 name4, kind5 name5, kind6 name6, kind7 name7 #define GMOCK_INTERNAL_DECL_HAS_9_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2, kind3, name3, kind4, name4, kind5, name5, kind6, name6, \ kind7, name7, kind8, name8) kind0 name0, kind1 name1, kind2 name2, \ kind3 name3, kind4 name4, kind5 name5, kind6 name6, kind7 name7, \ kind8 name8 #define GMOCK_INTERNAL_DECL_HAS_10_TEMPLATE_PARAMS(kind0, name0, kind1, \ name1, kind2, name2, kind3, name3, kind4, name4, kind5, name5, kind6, \ name6, kind7, name7, kind8, name8, kind9, name9) kind0 name0, \ kind1 name1, kind2 name2, kind3 name3, kind4 name4, kind5 name5, \ kind6 name6, kind7 name7, kind8 name8, kind9 name9 // Lists the template parameters. #define GMOCK_INTERNAL_LIST_HAS_1_TEMPLATE_PARAMS(kind0, name0) name0 #define GMOCK_INTERNAL_LIST_HAS_2_TEMPLATE_PARAMS(kind0, name0, kind1, \ name1) name0, name1 #define GMOCK_INTERNAL_LIST_HAS_3_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2) name0, name1, name2 #define GMOCK_INTERNAL_LIST_HAS_4_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2, kind3, name3) name0, name1, name2, name3 #define GMOCK_INTERNAL_LIST_HAS_5_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2, kind3, name3, kind4, name4) name0, name1, name2, name3, \ name4 #define GMOCK_INTERNAL_LIST_HAS_6_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2, kind3, name3, kind4, name4, kind5, name5) name0, name1, \ name2, name3, name4, name5 #define GMOCK_INTERNAL_LIST_HAS_7_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2, kind3, name3, kind4, name4, kind5, name5, kind6, \ name6) name0, name1, name2, name3, name4, name5, name6 #define GMOCK_INTERNAL_LIST_HAS_8_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2, kind3, name3, kind4, name4, kind5, name5, kind6, name6, \ kind7, name7) name0, name1, name2, name3, name4, name5, name6, name7 #define GMOCK_INTERNAL_LIST_HAS_9_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \ kind2, name2, kind3, name3, kind4, name4, kind5, name5, kind6, name6, \ kind7, name7, kind8, name8) name0, name1, name2, name3, name4, name5, \ name6, name7, name8 #define GMOCK_INTERNAL_LIST_HAS_10_TEMPLATE_PARAMS(kind0, name0, kind1, \ name1, kind2, name2, kind3, name3, kind4, name4, kind5, name5, kind6, \ name6, kind7, name7, kind8, name8, kind9, name9) name0, name1, name2, \ name3, name4, name5, name6, name7, name8, name9 // Declares the types of value parameters. #define GMOCK_INTERNAL_DECL_TYPE_AND_0_VALUE_PARAMS() #define GMOCK_INTERNAL_DECL_TYPE_AND_1_VALUE_PARAMS(p0) , typename p0##_type #define GMOCK_INTERNAL_DECL_TYPE_AND_2_VALUE_PARAMS(p0, p1) , \ typename p0##_type, typename p1##_type #define GMOCK_INTERNAL_DECL_TYPE_AND_3_VALUE_PARAMS(p0, p1, p2) , \ typename p0##_type, typename p1##_type, typename p2##_type #define GMOCK_INTERNAL_DECL_TYPE_AND_4_VALUE_PARAMS(p0, p1, p2, p3) , \ typename p0##_type, typename p1##_type, typename p2##_type, \ typename p3##_type #define GMOCK_INTERNAL_DECL_TYPE_AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4) , \ typename p0##_type, typename p1##_type, typename p2##_type, \ typename p3##_type, typename p4##_type #define GMOCK_INTERNAL_DECL_TYPE_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5) , \ typename p0##_type, typename p1##_type, typename p2##_type, \ typename p3##_type, typename p4##_type, typename p5##_type #define GMOCK_INTERNAL_DECL_TYPE_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \ p6) , typename p0##_type, typename p1##_type, typename p2##_type, \ typename p3##_type, typename p4##_type, typename p5##_type, \ typename p6##_type #define GMOCK_INTERNAL_DECL_TYPE_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \ p6, p7) , typename p0##_type, typename p1##_type, typename p2##_type, \ typename p3##_type, typename p4##_type, typename p5##_type, \ typename p6##_type, typename p7##_type #define GMOCK_INTERNAL_DECL_TYPE_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \ p6, p7, p8) , typename p0##_type, typename p1##_type, typename p2##_type, \ typename p3##_type, typename p4##_type, typename p5##_type, \ typename p6##_type, typename p7##_type, typename p8##_type #define GMOCK_INTERNAL_DECL_TYPE_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \ p6, p7, p8, p9) , typename p0##_type, typename p1##_type, \ typename p2##_type, typename p3##_type, typename p4##_type, \ typename p5##_type, typename p6##_type, typename p7##_type, \ typename p8##_type, typename p9##_type // Initializes the value parameters. #define GMOCK_INTERNAL_INIT_AND_0_VALUE_PARAMS()\ () #define GMOCK_INTERNAL_INIT_AND_1_VALUE_PARAMS(p0)\ (p0##_type gmock_p0) : p0(gmock_p0) #define GMOCK_INTERNAL_INIT_AND_2_VALUE_PARAMS(p0, p1)\ (p0##_type gmock_p0, p1##_type gmock_p1) : p0(gmock_p0), p1(gmock_p1) #define GMOCK_INTERNAL_INIT_AND_3_VALUE_PARAMS(p0, p1, p2)\ (p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2) #define GMOCK_INTERNAL_INIT_AND_4_VALUE_PARAMS(p0, p1, p2, p3)\ (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3) #define GMOCK_INTERNAL_INIT_AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4)\ (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4) : p0(gmock_p0), p1(gmock_p1), \ p2(gmock_p2), p3(gmock_p3), p4(gmock_p4) #define GMOCK_INTERNAL_INIT_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5)\ (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, \ p5##_type gmock_p5) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5) #define GMOCK_INTERNAL_INIT_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6)\ (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \ p6##_type gmock_p6) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6) #define GMOCK_INTERNAL_INIT_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7)\ (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \ p6##_type gmock_p6, p7##_type gmock_p7) : p0(gmock_p0), p1(gmock_p1), \ p2(gmock_p2), p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), \ p7(gmock_p7) #define GMOCK_INTERNAL_INIT_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7, p8)\ (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \ p6##_type gmock_p6, p7##_type gmock_p7, \ p8##_type gmock_p8) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), p7(gmock_p7), \ p8(gmock_p8) #define GMOCK_INTERNAL_INIT_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7, p8, p9)\ (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \ p6##_type gmock_p6, p7##_type gmock_p7, p8##_type gmock_p8, \ p9##_type gmock_p9) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), p7(gmock_p7), \ p8(gmock_p8), p9(gmock_p9) // Declares the fields for storing the value parameters. #define GMOCK_INTERNAL_DEFN_AND_0_VALUE_PARAMS() #define GMOCK_INTERNAL_DEFN_AND_1_VALUE_PARAMS(p0) p0##_type p0; #define GMOCK_INTERNAL_DEFN_AND_2_VALUE_PARAMS(p0, p1) p0##_type p0; \ p1##_type p1; #define GMOCK_INTERNAL_DEFN_AND_3_VALUE_PARAMS(p0, p1, p2) p0##_type p0; \ p1##_type p1; p2##_type p2; #define GMOCK_INTERNAL_DEFN_AND_4_VALUE_PARAMS(p0, p1, p2, p3) p0##_type p0; \ p1##_type p1; p2##_type p2; p3##_type p3; #define GMOCK_INTERNAL_DEFN_AND_5_VALUE_PARAMS(p0, p1, p2, p3, \ p4) p0##_type p0; p1##_type p1; p2##_type p2; p3##_type p3; p4##_type p4; #define GMOCK_INTERNAL_DEFN_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, \ p5) p0##_type p0; p1##_type p1; p2##_type p2; p3##_type p3; p4##_type p4; \ p5##_type p5; #define GMOCK_INTERNAL_DEFN_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \ p6) p0##_type p0; p1##_type p1; p2##_type p2; p3##_type p3; p4##_type p4; \ p5##_type p5; p6##_type p6; #define GMOCK_INTERNAL_DEFN_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7) p0##_type p0; p1##_type p1; p2##_type p2; p3##_type p3; p4##_type p4; \ p5##_type p5; p6##_type p6; p7##_type p7; #define GMOCK_INTERNAL_DEFN_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7, p8) p0##_type p0; p1##_type p1; p2##_type p2; p3##_type p3; \ p4##_type p4; p5##_type p5; p6##_type p6; p7##_type p7; p8##_type p8; #define GMOCK_INTERNAL_DEFN_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7, p8, p9) p0##_type p0; p1##_type p1; p2##_type p2; p3##_type p3; \ p4##_type p4; p5##_type p5; p6##_type p6; p7##_type p7; p8##_type p8; \ p9##_type p9; // Lists the value parameters. #define GMOCK_INTERNAL_LIST_AND_0_VALUE_PARAMS() #define GMOCK_INTERNAL_LIST_AND_1_VALUE_PARAMS(p0) p0 #define GMOCK_INTERNAL_LIST_AND_2_VALUE_PARAMS(p0, p1) p0, p1 #define GMOCK_INTERNAL_LIST_AND_3_VALUE_PARAMS(p0, p1, p2) p0, p1, p2 #define GMOCK_INTERNAL_LIST_AND_4_VALUE_PARAMS(p0, p1, p2, p3) p0, p1, p2, p3 #define GMOCK_INTERNAL_LIST_AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4) p0, p1, \ p2, p3, p4 #define GMOCK_INTERNAL_LIST_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5) p0, \ p1, p2, p3, p4, p5 #define GMOCK_INTERNAL_LIST_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \ p6) p0, p1, p2, p3, p4, p5, p6 #define GMOCK_INTERNAL_LIST_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7) p0, p1, p2, p3, p4, p5, p6, p7 #define GMOCK_INTERNAL_LIST_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7, p8) p0, p1, p2, p3, p4, p5, p6, p7, p8 #define GMOCK_INTERNAL_LIST_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7, p8, p9) p0, p1, p2, p3, p4, p5, p6, p7, p8, p9 // Lists the value parameter types. #define GMOCK_INTERNAL_LIST_TYPE_AND_0_VALUE_PARAMS() #define GMOCK_INTERNAL_LIST_TYPE_AND_1_VALUE_PARAMS(p0) , p0##_type #define GMOCK_INTERNAL_LIST_TYPE_AND_2_VALUE_PARAMS(p0, p1) , p0##_type, \ p1##_type #define GMOCK_INTERNAL_LIST_TYPE_AND_3_VALUE_PARAMS(p0, p1, p2) , p0##_type, \ p1##_type, p2##_type #define GMOCK_INTERNAL_LIST_TYPE_AND_4_VALUE_PARAMS(p0, p1, p2, p3) , \ p0##_type, p1##_type, p2##_type, p3##_type #define GMOCK_INTERNAL_LIST_TYPE_AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4) , \ p0##_type, p1##_type, p2##_type, p3##_type, p4##_type #define GMOCK_INTERNAL_LIST_TYPE_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5) , \ p0##_type, p1##_type, p2##_type, p3##_type, p4##_type, p5##_type #define GMOCK_INTERNAL_LIST_TYPE_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \ p6) , p0##_type, p1##_type, p2##_type, p3##_type, p4##_type, p5##_type, \ p6##_type #define GMOCK_INTERNAL_LIST_TYPE_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \ p6, p7) , p0##_type, p1##_type, p2##_type, p3##_type, p4##_type, \ p5##_type, p6##_type, p7##_type #define GMOCK_INTERNAL_LIST_TYPE_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \ p6, p7, p8) , p0##_type, p1##_type, p2##_type, p3##_type, p4##_type, \ p5##_type, p6##_type, p7##_type, p8##_type #define GMOCK_INTERNAL_LIST_TYPE_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \ p6, p7, p8, p9) , p0##_type, p1##_type, p2##_type, p3##_type, p4##_type, \ p5##_type, p6##_type, p7##_type, p8##_type, p9##_type // Declares the value parameters. #define GMOCK_INTERNAL_DECL_AND_0_VALUE_PARAMS() #define GMOCK_INTERNAL_DECL_AND_1_VALUE_PARAMS(p0) p0##_type p0 #define GMOCK_INTERNAL_DECL_AND_2_VALUE_PARAMS(p0, p1) p0##_type p0, \ p1##_type p1 #define GMOCK_INTERNAL_DECL_AND_3_VALUE_PARAMS(p0, p1, p2) p0##_type p0, \ p1##_type p1, p2##_type p2 #define GMOCK_INTERNAL_DECL_AND_4_VALUE_PARAMS(p0, p1, p2, p3) p0##_type p0, \ p1##_type p1, p2##_type p2, p3##_type p3 #define GMOCK_INTERNAL_DECL_AND_5_VALUE_PARAMS(p0, p1, p2, p3, \ p4) p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, p4##_type p4 #define GMOCK_INTERNAL_DECL_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, \ p5) p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, p4##_type p4, \ p5##_type p5 #define GMOCK_INTERNAL_DECL_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \ p6) p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, p4##_type p4, \ p5##_type p5, p6##_type p6 #define GMOCK_INTERNAL_DECL_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7) p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, p4##_type p4, \ p5##_type p5, p6##_type p6, p7##_type p7 #define GMOCK_INTERNAL_DECL_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7, p8) p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, \ p4##_type p4, p5##_type p5, p6##_type p6, p7##_type p7, p8##_type p8 #define GMOCK_INTERNAL_DECL_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7, p8, p9) p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, \ p4##_type p4, p5##_type p5, p6##_type p6, p7##_type p7, p8##_type p8, \ p9##_type p9 // The suffix of the class template implementing the action template. #define GMOCK_INTERNAL_COUNT_AND_0_VALUE_PARAMS() #define GMOCK_INTERNAL_COUNT_AND_1_VALUE_PARAMS(p0) P #define GMOCK_INTERNAL_COUNT_AND_2_VALUE_PARAMS(p0, p1) P2 #define GMOCK_INTERNAL_COUNT_AND_3_VALUE_PARAMS(p0, p1, p2) P3 #define GMOCK_INTERNAL_COUNT_AND_4_VALUE_PARAMS(p0, p1, p2, p3) P4 #define GMOCK_INTERNAL_COUNT_AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4) P5 #define GMOCK_INTERNAL_COUNT_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5) P6 #define GMOCK_INTERNAL_COUNT_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6) P7 #define GMOCK_INTERNAL_COUNT_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7) P8 #define GMOCK_INTERNAL_COUNT_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7, p8) P9 #define GMOCK_INTERNAL_COUNT_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \ p7, p8, p9) P10 // The name of the class template implementing the action template. #define GMOCK_ACTION_CLASS_(name, value_params)\ GTEST_CONCAT_TOKEN_(name##Action, GMOCK_INTERNAL_COUNT_##value_params) #define ACTION_TEMPLATE(name, template_params, value_params)\ template \ class GMOCK_ACTION_CLASS_(name, value_params) {\ public:\ explicit GMOCK_ACTION_CLASS_(name, value_params)\ GMOCK_INTERNAL_INIT_##value_params {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ explicit gmock_Impl GMOCK_INTERNAL_INIT_##value_params {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template \ return_type gmock_PerformImpl(const args_type& args, arg0_type arg0, \ arg1_type arg1, arg2_type arg2, arg3_type arg3, arg4_type arg4, \ arg5_type arg5, arg6_type arg6, arg7_type arg7, arg8_type arg8, \ arg9_type arg9) const;\ GMOCK_INTERNAL_DEFN_##value_params\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(\ new gmock_Impl(GMOCK_INTERNAL_LIST_##value_params));\ }\ GMOCK_INTERNAL_DEFN_##value_params\ private:\ GTEST_DISALLOW_ASSIGN_(GMOCK_ACTION_CLASS_(name, value_params));\ };\ template \ inline GMOCK_ACTION_CLASS_(name, value_params)<\ GMOCK_INTERNAL_LIST_##template_params\ GMOCK_INTERNAL_LIST_TYPE_##value_params> name(\ GMOCK_INTERNAL_DECL_##value_params) {\ return GMOCK_ACTION_CLASS_(name, value_params)<\ GMOCK_INTERNAL_LIST_##template_params\ GMOCK_INTERNAL_LIST_TYPE_##value_params>(\ GMOCK_INTERNAL_LIST_##value_params);\ }\ template \ template \ template \ typename ::testing::internal::Function::Result\ GMOCK_ACTION_CLASS_(name, value_params)<\ GMOCK_INTERNAL_LIST_##template_params\ GMOCK_INTERNAL_LIST_TYPE_##value_params>::gmock_Impl::\ gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const #define ACTION(name)\ class name##Action {\ public:\ name##Action() {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ gmock_Impl() {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template \ return_type gmock_PerformImpl(const args_type& args, arg0_type arg0, \ arg1_type arg1, arg2_type arg2, arg3_type arg3, arg4_type arg4, \ arg5_type arg5, arg6_type arg6, arg7_type arg7, arg8_type arg8, \ arg9_type arg9) const;\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(new gmock_Impl());\ }\ private:\ GTEST_DISALLOW_ASSIGN_(name##Action);\ };\ inline name##Action name() {\ return name##Action();\ }\ template \ template \ typename ::testing::internal::Function::Result\ name##Action::gmock_Impl::gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const #define ACTION_P(name, p0)\ template \ class name##ActionP {\ public:\ explicit name##ActionP(p0##_type gmock_p0) : p0(gmock_p0) {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ explicit gmock_Impl(p0##_type gmock_p0) : p0(gmock_p0) {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template \ return_type gmock_PerformImpl(const args_type& args, arg0_type arg0, \ arg1_type arg1, arg2_type arg2, arg3_type arg3, arg4_type arg4, \ arg5_type arg5, arg6_type arg6, arg7_type arg7, arg8_type arg8, \ arg9_type arg9) const;\ p0##_type p0;\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(new gmock_Impl(p0));\ }\ p0##_type p0;\ private:\ GTEST_DISALLOW_ASSIGN_(name##ActionP);\ };\ template \ inline name##ActionP name(p0##_type p0) {\ return name##ActionP(p0);\ }\ template \ template \ template \ typename ::testing::internal::Function::Result\ name##ActionP::gmock_Impl::gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const #define ACTION_P2(name, p0, p1)\ template \ class name##ActionP2 {\ public:\ name##ActionP2(p0##_type gmock_p0, p1##_type gmock_p1) : p0(gmock_p0), \ p1(gmock_p1) {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1) : p0(gmock_p0), \ p1(gmock_p1) {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template \ return_type gmock_PerformImpl(const args_type& args, arg0_type arg0, \ arg1_type arg1, arg2_type arg2, arg3_type arg3, arg4_type arg4, \ arg5_type arg5, arg6_type arg6, arg7_type arg7, arg8_type arg8, \ arg9_type arg9) const;\ p0##_type p0;\ p1##_type p1;\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(new gmock_Impl(p0, p1));\ }\ p0##_type p0;\ p1##_type p1;\ private:\ GTEST_DISALLOW_ASSIGN_(name##ActionP2);\ };\ template \ inline name##ActionP2 name(p0##_type p0, \ p1##_type p1) {\ return name##ActionP2(p0, p1);\ }\ template \ template \ template \ typename ::testing::internal::Function::Result\ name##ActionP2::gmock_Impl::gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const #define ACTION_P3(name, p0, p1, p2)\ template \ class name##ActionP3 {\ public:\ name##ActionP3(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2) {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2) {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template \ return_type gmock_PerformImpl(const args_type& args, arg0_type arg0, \ arg1_type arg1, arg2_type arg2, arg3_type arg3, arg4_type arg4, \ arg5_type arg5, arg6_type arg6, arg7_type arg7, arg8_type arg8, \ arg9_type arg9) const;\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(new gmock_Impl(p0, p1, p2));\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ private:\ GTEST_DISALLOW_ASSIGN_(name##ActionP3);\ };\ template \ inline name##ActionP3 name(p0##_type p0, \ p1##_type p1, p2##_type p2) {\ return name##ActionP3(p0, p1, p2);\ }\ template \ template \ template \ typename ::testing::internal::Function::Result\ name##ActionP3::gmock_Impl::gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const #define ACTION_P4(name, p0, p1, p2, p3)\ template \ class name##ActionP4 {\ public:\ name##ActionP4(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3) : p0(gmock_p0), p1(gmock_p1), \ p2(gmock_p2), p3(gmock_p3) {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3) {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template \ return_type gmock_PerformImpl(const args_type& args, arg0_type arg0, \ arg1_type arg1, arg2_type arg2, arg3_type arg3, arg4_type arg4, \ arg5_type arg5, arg6_type arg6, arg7_type arg7, arg8_type arg8, \ arg9_type arg9) const;\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(new gmock_Impl(p0, p1, p2, p3));\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ private:\ GTEST_DISALLOW_ASSIGN_(name##ActionP4);\ };\ template \ inline name##ActionP4 name(p0##_type p0, p1##_type p1, p2##_type p2, \ p3##_type p3) {\ return name##ActionP4(p0, p1, \ p2, p3);\ }\ template \ template \ template \ typename ::testing::internal::Function::Result\ name##ActionP4::gmock_Impl::gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const #define ACTION_P5(name, p0, p1, p2, p3, p4)\ template \ class name##ActionP5 {\ public:\ name##ActionP5(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3, \ p4##_type gmock_p4) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4) {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4) : p0(gmock_p0), \ p1(gmock_p1), p2(gmock_p2), p3(gmock_p3), p4(gmock_p4) {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template \ return_type gmock_PerformImpl(const args_type& args, arg0_type arg0, \ arg1_type arg1, arg2_type arg2, arg3_type arg3, arg4_type arg4, \ arg5_type arg5, arg6_type arg6, arg7_type arg7, arg8_type arg8, \ arg9_type arg9) const;\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(new gmock_Impl(p0, p1, p2, p3, p4));\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ private:\ GTEST_DISALLOW_ASSIGN_(name##ActionP5);\ };\ template \ inline name##ActionP5 name(p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, \ p4##_type p4) {\ return name##ActionP5(p0, p1, p2, p3, p4);\ }\ template \ template \ template \ typename ::testing::internal::Function::Result\ name##ActionP5::gmock_Impl::gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const #define ACTION_P6(name, p0, p1, p2, p3, p4, p5)\ template \ class name##ActionP6 {\ public:\ name##ActionP6(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3, p4##_type gmock_p4, \ p5##_type gmock_p5) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5) {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, \ p5##_type gmock_p5) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5) {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template \ return_type gmock_PerformImpl(const args_type& args, arg0_type arg0, \ arg1_type arg1, arg2_type arg2, arg3_type arg3, arg4_type arg4, \ arg5_type arg5, arg6_type arg6, arg7_type arg7, arg8_type arg8, \ arg9_type arg9) const;\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(new gmock_Impl(p0, p1, p2, p3, p4, p5));\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ private:\ GTEST_DISALLOW_ASSIGN_(name##ActionP6);\ };\ template \ inline name##ActionP6 name(p0##_type p0, p1##_type p1, p2##_type p2, \ p3##_type p3, p4##_type p4, p5##_type p5) {\ return name##ActionP6(p0, p1, p2, p3, p4, p5);\ }\ template \ template \ template \ typename ::testing::internal::Function::Result\ name##ActionP6::gmock_Impl::gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const #define ACTION_P7(name, p0, p1, p2, p3, p4, p5, p6)\ template \ class name##ActionP7 {\ public:\ name##ActionP7(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3, p4##_type gmock_p4, \ p5##_type gmock_p5, p6##_type gmock_p6) : p0(gmock_p0), p1(gmock_p1), \ p2(gmock_p2), p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), \ p6(gmock_p6) {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \ p6##_type gmock_p6) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6) {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template \ return_type gmock_PerformImpl(const args_type& args, arg0_type arg0, \ arg1_type arg1, arg2_type arg2, arg3_type arg3, arg4_type arg4, \ arg5_type arg5, arg6_type arg6, arg7_type arg7, arg8_type arg8, \ arg9_type arg9) const;\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(new gmock_Impl(p0, p1, p2, p3, p4, p5, \ p6));\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ private:\ GTEST_DISALLOW_ASSIGN_(name##ActionP7);\ };\ template \ inline name##ActionP7 name(p0##_type p0, p1##_type p1, \ p2##_type p2, p3##_type p3, p4##_type p4, p5##_type p5, \ p6##_type p6) {\ return name##ActionP7(p0, p1, p2, p3, p4, p5, p6);\ }\ template \ template \ template \ typename ::testing::internal::Function::Result\ name##ActionP7::gmock_Impl::gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const #define ACTION_P8(name, p0, p1, p2, p3, p4, p5, p6, p7)\ template \ class name##ActionP8 {\ public:\ name##ActionP8(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3, p4##_type gmock_p4, \ p5##_type gmock_p5, p6##_type gmock_p6, \ p7##_type gmock_p7) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), \ p7(gmock_p7) {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \ p6##_type gmock_p6, p7##_type gmock_p7) : p0(gmock_p0), \ p1(gmock_p1), p2(gmock_p2), p3(gmock_p3), p4(gmock_p4), \ p5(gmock_p5), p6(gmock_p6), p7(gmock_p7) {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template \ return_type gmock_PerformImpl(const args_type& args, arg0_type arg0, \ arg1_type arg1, arg2_type arg2, arg3_type arg3, arg4_type arg4, \ arg5_type arg5, arg6_type arg6, arg7_type arg7, arg8_type arg8, \ arg9_type arg9) const;\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ p7##_type p7;\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(new gmock_Impl(p0, p1, p2, p3, p4, p5, \ p6, p7));\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ p7##_type p7;\ private:\ GTEST_DISALLOW_ASSIGN_(name##ActionP8);\ };\ template \ inline name##ActionP8 name(p0##_type p0, \ p1##_type p1, p2##_type p2, p3##_type p3, p4##_type p4, p5##_type p5, \ p6##_type p6, p7##_type p7) {\ return name##ActionP8(p0, p1, p2, p3, p4, p5, \ p6, p7);\ }\ template \ template \ template \ typename ::testing::internal::Function::Result\ name##ActionP8::gmock_Impl::gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const #define ACTION_P9(name, p0, p1, p2, p3, p4, p5, p6, p7, p8)\ template \ class name##ActionP9 {\ public:\ name##ActionP9(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3, p4##_type gmock_p4, \ p5##_type gmock_p5, p6##_type gmock_p6, p7##_type gmock_p7, \ p8##_type gmock_p8) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), p7(gmock_p7), \ p8(gmock_p8) {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \ p6##_type gmock_p6, p7##_type gmock_p7, \ p8##_type gmock_p8) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), \ p7(gmock_p7), p8(gmock_p8) {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template \ return_type gmock_PerformImpl(const args_type& args, arg0_type arg0, \ arg1_type arg1, arg2_type arg2, arg3_type arg3, arg4_type arg4, \ arg5_type arg5, arg6_type arg6, arg7_type arg7, arg8_type arg8, \ arg9_type arg9) const;\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ p7##_type p7;\ p8##_type p8;\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(new gmock_Impl(p0, p1, p2, p3, p4, p5, \ p6, p7, p8));\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ p7##_type p7;\ p8##_type p8;\ private:\ GTEST_DISALLOW_ASSIGN_(name##ActionP9);\ };\ template \ inline name##ActionP9 name(p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, \ p4##_type p4, p5##_type p5, p6##_type p6, p7##_type p7, \ p8##_type p8) {\ return name##ActionP9(p0, p1, p2, \ p3, p4, p5, p6, p7, p8);\ }\ template \ template \ template \ typename ::testing::internal::Function::Result\ name##ActionP9::gmock_Impl::gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const #define ACTION_P10(name, p0, p1, p2, p3, p4, p5, p6, p7, p8, p9)\ template \ class name##ActionP10 {\ public:\ name##ActionP10(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3, p4##_type gmock_p4, \ p5##_type gmock_p5, p6##_type gmock_p6, p7##_type gmock_p7, \ p8##_type gmock_p8, p9##_type gmock_p9) : p0(gmock_p0), p1(gmock_p1), \ p2(gmock_p2), p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), \ p7(gmock_p7), p8(gmock_p8), p9(gmock_p9) {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \ p6##_type gmock_p6, p7##_type gmock_p7, p8##_type gmock_p8, \ p9##_type gmock_p9) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), \ p7(gmock_p7), p8(gmock_p8), p9(gmock_p9) {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template \ return_type gmock_PerformImpl(const args_type& args, arg0_type arg0, \ arg1_type arg1, arg2_type arg2, arg3_type arg3, arg4_type arg4, \ arg5_type arg5, arg6_type arg6, arg7_type arg7, arg8_type arg8, \ arg9_type arg9) const;\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ p7##_type p7;\ p8##_type p8;\ p9##_type p9;\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(new gmock_Impl(p0, p1, p2, p3, p4, p5, \ p6, p7, p8, p9));\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ p7##_type p7;\ p8##_type p8;\ p9##_type p9;\ private:\ GTEST_DISALLOW_ASSIGN_(name##ActionP10);\ };\ template \ inline name##ActionP10 name(p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, \ p4##_type p4, p5##_type p5, p6##_type p6, p7##_type p7, p8##_type p8, \ p9##_type p9) {\ return name##ActionP10(p0, \ p1, p2, p3, p4, p5, p6, p7, p8, p9);\ }\ template \ template \ template \ typename ::testing::internal::Function::Result\ name##ActionP10::gmock_Impl::gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const namespace testing { // The ACTION*() macros trigger warning C4100 (unreferenced formal // parameter) in MSVC with -W4. Unfortunately they cannot be fixed in // the macro definition, as the warnings are generated when the macro // is expanded and macro expansion cannot contain #pragma. Therefore // we suppress them here. #ifdef _MSC_VER # pragma warning(push) # pragma warning(disable:4100) #endif // Various overloads for InvokeArgument(). // // The InvokeArgument(a1, a2, ..., a_k) action invokes the N-th // (0-based) argument, which must be a k-ary callable, of the mock // function, with arguments a1, a2, ..., a_k. // // Notes: // // 1. The arguments are passed by value by default. If you need to // pass an argument by reference, wrap it inside ByRef(). For // example, // // InvokeArgument<1>(5, string("Hello"), ByRef(foo)) // // passes 5 and string("Hello") by value, and passes foo by // reference. // // 2. If the callable takes an argument by reference but ByRef() is // not used, it will receive the reference to a copy of the value, // instead of the original value. For example, when the 0-th // argument of the mock function takes a const string&, the action // // InvokeArgument<0>(string("Hello")) // // makes a copy of the temporary string("Hello") object and passes a // reference of the copy, instead of the original temporary object, // to the callable. This makes it easy for a user to define an // InvokeArgument action from temporary values and have it performed // later. namespace internal { namespace invoke_argument { // Appears in InvokeArgumentAdl's argument list to help avoid // accidental calls to user functions of the same name. struct AdlTag {}; // InvokeArgumentAdl - a helper for InvokeArgument. // The basic overloads are provided here for generic functors. // Overloads for other custom-callables are provided in the // internal/custom/callback-actions.h header. template R InvokeArgumentAdl(AdlTag, F f) { return f(); } template R InvokeArgumentAdl(AdlTag, F f, A1 a1) { return f(a1); } template R InvokeArgumentAdl(AdlTag, F f, A1 a1, A2 a2) { return f(a1, a2); } template R InvokeArgumentAdl(AdlTag, F f, A1 a1, A2 a2, A3 a3) { return f(a1, a2, a3); } template R InvokeArgumentAdl(AdlTag, F f, A1 a1, A2 a2, A3 a3, A4 a4) { return f(a1, a2, a3, a4); } template R InvokeArgumentAdl(AdlTag, F f, A1 a1, A2 a2, A3 a3, A4 a4, A5 a5) { return f(a1, a2, a3, a4, a5); } template R InvokeArgumentAdl(AdlTag, F f, A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6) { return f(a1, a2, a3, a4, a5, a6); } template R InvokeArgumentAdl(AdlTag, F f, A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7) { return f(a1, a2, a3, a4, a5, a6, a7); } template R InvokeArgumentAdl(AdlTag, F f, A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7, A8 a8) { return f(a1, a2, a3, a4, a5, a6, a7, a8); } template R InvokeArgumentAdl(AdlTag, F f, A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7, A8 a8, A9 a9) { return f(a1, a2, a3, a4, a5, a6, a7, a8, a9); } template R InvokeArgumentAdl(AdlTag, F f, A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7, A8 a8, A9 a9, A10 a10) { return f(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10); } } // namespace invoke_argument } // namespace internal ACTION_TEMPLATE(InvokeArgument, HAS_1_TEMPLATE_PARAMS(int, k), AND_0_VALUE_PARAMS()) { using internal::invoke_argument::InvokeArgumentAdl; return InvokeArgumentAdl( internal::invoke_argument::AdlTag(), ::testing::get(args)); } ACTION_TEMPLATE(InvokeArgument, HAS_1_TEMPLATE_PARAMS(int, k), AND_1_VALUE_PARAMS(p0)) { using internal::invoke_argument::InvokeArgumentAdl; return InvokeArgumentAdl( internal::invoke_argument::AdlTag(), ::testing::get(args), p0); } ACTION_TEMPLATE(InvokeArgument, HAS_1_TEMPLATE_PARAMS(int, k), AND_2_VALUE_PARAMS(p0, p1)) { using internal::invoke_argument::InvokeArgumentAdl; return InvokeArgumentAdl( internal::invoke_argument::AdlTag(), ::testing::get(args), p0, p1); } ACTION_TEMPLATE(InvokeArgument, HAS_1_TEMPLATE_PARAMS(int, k), AND_3_VALUE_PARAMS(p0, p1, p2)) { using internal::invoke_argument::InvokeArgumentAdl; return InvokeArgumentAdl( internal::invoke_argument::AdlTag(), ::testing::get(args), p0, p1, p2); } ACTION_TEMPLATE(InvokeArgument, HAS_1_TEMPLATE_PARAMS(int, k), AND_4_VALUE_PARAMS(p0, p1, p2, p3)) { using internal::invoke_argument::InvokeArgumentAdl; return InvokeArgumentAdl( internal::invoke_argument::AdlTag(), ::testing::get(args), p0, p1, p2, p3); } ACTION_TEMPLATE(InvokeArgument, HAS_1_TEMPLATE_PARAMS(int, k), AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4)) { using internal::invoke_argument::InvokeArgumentAdl; return InvokeArgumentAdl( internal::invoke_argument::AdlTag(), ::testing::get(args), p0, p1, p2, p3, p4); } ACTION_TEMPLATE(InvokeArgument, HAS_1_TEMPLATE_PARAMS(int, k), AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5)) { using internal::invoke_argument::InvokeArgumentAdl; return InvokeArgumentAdl( internal::invoke_argument::AdlTag(), ::testing::get(args), p0, p1, p2, p3, p4, p5); } ACTION_TEMPLATE(InvokeArgument, HAS_1_TEMPLATE_PARAMS(int, k), AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6)) { using internal::invoke_argument::InvokeArgumentAdl; return InvokeArgumentAdl( internal::invoke_argument::AdlTag(), ::testing::get(args), p0, p1, p2, p3, p4, p5, p6); } ACTION_TEMPLATE(InvokeArgument, HAS_1_TEMPLATE_PARAMS(int, k), AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7)) { using internal::invoke_argument::InvokeArgumentAdl; return InvokeArgumentAdl( internal::invoke_argument::AdlTag(), ::testing::get(args), p0, p1, p2, p3, p4, p5, p6, p7); } ACTION_TEMPLATE(InvokeArgument, HAS_1_TEMPLATE_PARAMS(int, k), AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7, p8)) { using internal::invoke_argument::InvokeArgumentAdl; return InvokeArgumentAdl( internal::invoke_argument::AdlTag(), ::testing::get(args), p0, p1, p2, p3, p4, p5, p6, p7, p8); } ACTION_TEMPLATE(InvokeArgument, HAS_1_TEMPLATE_PARAMS(int, k), AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7, p8, p9)) { using internal::invoke_argument::InvokeArgumentAdl; return InvokeArgumentAdl( internal::invoke_argument::AdlTag(), ::testing::get(args), p0, p1, p2, p3, p4, p5, p6, p7, p8, p9); } // Various overloads for ReturnNew(). // // The ReturnNew(a1, a2, ..., a_k) action returns a pointer to a new // instance of type T, constructed on the heap with constructor arguments // a1, a2, ..., and a_k. The caller assumes ownership of the returned value. ACTION_TEMPLATE(ReturnNew, HAS_1_TEMPLATE_PARAMS(typename, T), AND_0_VALUE_PARAMS()) { return new T(); } ACTION_TEMPLATE(ReturnNew, HAS_1_TEMPLATE_PARAMS(typename, T), AND_1_VALUE_PARAMS(p0)) { return new T(p0); } ACTION_TEMPLATE(ReturnNew, HAS_1_TEMPLATE_PARAMS(typename, T), AND_2_VALUE_PARAMS(p0, p1)) { return new T(p0, p1); } ACTION_TEMPLATE(ReturnNew, HAS_1_TEMPLATE_PARAMS(typename, T), AND_3_VALUE_PARAMS(p0, p1, p2)) { return new T(p0, p1, p2); } ACTION_TEMPLATE(ReturnNew, HAS_1_TEMPLATE_PARAMS(typename, T), AND_4_VALUE_PARAMS(p0, p1, p2, p3)) { return new T(p0, p1, p2, p3); } ACTION_TEMPLATE(ReturnNew, HAS_1_TEMPLATE_PARAMS(typename, T), AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4)) { return new T(p0, p1, p2, p3, p4); } ACTION_TEMPLATE(ReturnNew, HAS_1_TEMPLATE_PARAMS(typename, T), AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5)) { return new T(p0, p1, p2, p3, p4, p5); } ACTION_TEMPLATE(ReturnNew, HAS_1_TEMPLATE_PARAMS(typename, T), AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6)) { return new T(p0, p1, p2, p3, p4, p5, p6); } ACTION_TEMPLATE(ReturnNew, HAS_1_TEMPLATE_PARAMS(typename, T), AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7)) { return new T(p0, p1, p2, p3, p4, p5, p6, p7); } ACTION_TEMPLATE(ReturnNew, HAS_1_TEMPLATE_PARAMS(typename, T), AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7, p8)) { return new T(p0, p1, p2, p3, p4, p5, p6, p7, p8); } ACTION_TEMPLATE(ReturnNew, HAS_1_TEMPLATE_PARAMS(typename, T), AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7, p8, p9)) { return new T(p0, p1, p2, p3, p4, p5, p6, p7, p8, p9); } #ifdef _MSC_VER # pragma warning(pop) #endif } // namespace testing // Include any custom actions added by the local installation. // We must include this header at the end to make sure it can use the // declarations from this file. #include "gmock/internal/custom/gmock-generated-actions.h" #endif // GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_ACTIONS_H_ vendor/googletest/gtest-1.7.0/googlemock/include/gmock/gmock-generated-actions.h.pump000066400000000000000000000634411300002025200310020ustar00rootroot00000000000000$$ -*- mode: c++; -*- $$ This is a Pump source file. Please use Pump to convert it to $$ gmock-generated-actions.h. $$ $var n = 10 $$ The maximum arity we support. $$}} This meta comment fixes auto-indentation in editors. // Copyright 2007, Google Inc. // 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 Google Inc. 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. // // Author: wan@google.com (Zhanyong Wan) // Google Mock - a framework for writing C++ mock classes. // // This file implements some commonly used variadic actions. #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_ACTIONS_H_ #define GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_ACTIONS_H_ #include "gmock/gmock-actions.h" #include "gmock/internal/gmock-port.h" namespace testing { namespace internal { // InvokeHelper knows how to unpack an N-tuple and invoke an N-ary // function or method with the unpacked values, where F is a function // type that takes N arguments. template class InvokeHelper; $range i 0..n $for i [[ $range j 1..i $var types = [[$for j [[, typename A$j]]]] $var as = [[$for j, [[A$j]]]] $var args = [[$if i==0 [[]] $else [[ args]]]] $var gets = [[$for j, [[get<$(j - 1)>(args)]]]] template class InvokeHelper > { public: template static R Invoke(Function function, const ::testing::tuple<$as>&$args) { return function($gets); } template static R InvokeMethod(Class* obj_ptr, MethodPtr method_ptr, const ::testing::tuple<$as>&$args) { return (obj_ptr->*method_ptr)($gets); } }; ]] // An INTERNAL macro for extracting the type of a tuple field. It's // subject to change without notice - DO NOT USE IN USER CODE! #define GMOCK_FIELD_(Tuple, N) \ typename ::testing::tuple_element::type $range i 1..n // SelectArgs::type is the // type of an n-ary function whose i-th (1-based) argument type is the // k{i}-th (0-based) field of ArgumentTuple, which must be a tuple // type, and whose return type is Result. For example, // SelectArgs, 0, 3>::type // is int(bool, long). // // SelectArgs::Select(args) // returns the selected fields (k1, k2, ..., k_n) of args as a tuple. // For example, // SelectArgs, 2, 0>::Select( // ::testing::make_tuple(true, 'a', 2.5)) // returns tuple (2.5, true). // // The numbers in list k1, k2, ..., k_n must be >= 0, where n can be // in the range [0, $n]. Duplicates are allowed and they don't have // to be in an ascending or descending order. template class SelectArgs { public: typedef Result type($for i, [[GMOCK_FIELD_(ArgumentTuple, k$i)]]); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& args) { return SelectedArgs($for i, [[get(args)]]); } }; $for i [[ $range j 1..n $range j1 1..i-1 template class SelectArgs { public: typedef Result type($for j1, [[GMOCK_FIELD_(ArgumentTuple, k$j1)]]); typedef typename Function::ArgumentTuple SelectedArgs; static SelectedArgs Select(const ArgumentTuple& [[]] $if i == 1 [[/* args */]] $else [[args]]) { return SelectedArgs($for j1, [[get(args)]]); } }; ]] #undef GMOCK_FIELD_ $var ks = [[$for i, [[k$i]]]] // Implements the WithArgs action. template class WithArgsAction { public: explicit WithArgsAction(const InnerAction& action) : action_(action) {} template operator Action() const { return MakeAction(new Impl(action_)); } private: template class Impl : public ActionInterface { public: typedef typename Function::Result Result; typedef typename Function::ArgumentTuple ArgumentTuple; explicit Impl(const InnerAction& action) : action_(action) {} virtual Result Perform(const ArgumentTuple& args) { return action_.Perform(SelectArgs::Select(args)); } private: typedef typename SelectArgs::type InnerFunctionType; Action action_; }; const InnerAction action_; GTEST_DISALLOW_ASSIGN_(WithArgsAction); }; // A macro from the ACTION* family (defined later in this file) // defines an action that can be used in a mock function. Typically, // these actions only care about a subset of the arguments of the mock // function. For example, if such an action only uses the second // argument, it can be used in any mock function that takes >= 2 // arguments where the type of the second argument is compatible. // // Therefore, the action implementation must be prepared to take more // arguments than it needs. The ExcessiveArg type is used to // represent those excessive arguments. In order to keep the compiler // error messages tractable, we define it in the testing namespace // instead of testing::internal. However, this is an INTERNAL TYPE // and subject to change without notice, so a user MUST NOT USE THIS // TYPE DIRECTLY. struct ExcessiveArg {}; // A helper class needed for implementing the ACTION* macros. template class ActionHelper { public: $range i 0..n $for i [[ $var template = [[$if i==0 [[]] $else [[ $range j 0..i-1 template <$for j, [[typename A$j]]> ]]]] $range j 0..i-1 $var As = [[$for j, [[A$j]]]] $var as = [[$for j, [[get<$j>(args)]]]] $range k 1..n-i $var eas = [[$for k, [[ExcessiveArg()]]]] $var arg_list = [[$if (i==0) | (i==n) [[$as$eas]] $else [[$as, $eas]]]] $template static Result Perform(Impl* impl, const ::testing::tuple<$As>& args) { return impl->template gmock_PerformImpl<$As>(args, $arg_list); } ]] }; } // namespace internal // Various overloads for Invoke(). // WithArgs(an_action) creates an action that passes // the selected arguments of the mock function to an_action and // performs it. It serves as an adaptor between actions with // different argument lists. C++ doesn't support default arguments for // function templates, so we have to overload it. $range i 1..n $for i [[ $range j 1..i template <$for j [[int k$j, ]]typename InnerAction> inline internal::WithArgsAction WithArgs(const InnerAction& action) { return internal::WithArgsAction(action); } ]] // Creates an action that does actions a1, a2, ..., sequentially in // each invocation. $range i 2..n $for i [[ $range j 2..i $var types = [[$for j, [[typename Action$j]]]] $var Aas = [[$for j [[, Action$j a$j]]]] template $range k 1..i-1 inline $for k [[internal::DoBothAction]] DoAll(Action1 a1$Aas) { $if i==2 [[ return internal::DoBothAction(a1, a2); ]] $else [[ $range j2 2..i return DoAll(a1, DoAll($for j2, [[a$j2]])); ]] } ]] } // namespace testing // The ACTION* family of macros can be used in a namespace scope to // define custom actions easily. The syntax: // // ACTION(name) { statements; } // // will define an action with the given name that executes the // statements. The value returned by the statements will be used as // the return value of the action. Inside the statements, you can // refer to the K-th (0-based) argument of the mock function by // 'argK', and refer to its type by 'argK_type'. For example: // // ACTION(IncrementArg1) { // arg1_type temp = arg1; // return ++(*temp); // } // // allows you to write // // ...WillOnce(IncrementArg1()); // // You can also refer to the entire argument tuple and its type by // 'args' and 'args_type', and refer to the mock function type and its // return type by 'function_type' and 'return_type'. // // Note that you don't need to specify the types of the mock function // arguments. However rest assured that your code is still type-safe: // you'll get a compiler error if *arg1 doesn't support the ++ // operator, or if the type of ++(*arg1) isn't compatible with the // mock function's return type, for example. // // Sometimes you'll want to parameterize the action. For that you can use // another macro: // // ACTION_P(name, param_name) { statements; } // // For example: // // ACTION_P(Add, n) { return arg0 + n; } // // will allow you to write: // // ...WillOnce(Add(5)); // // Note that you don't need to provide the type of the parameter // either. If you need to reference the type of a parameter named // 'foo', you can write 'foo_type'. For example, in the body of // ACTION_P(Add, n) above, you can write 'n_type' to refer to the type // of 'n'. // // We also provide ACTION_P2, ACTION_P3, ..., up to ACTION_P$n to support // multi-parameter actions. // // For the purpose of typing, you can view // // ACTION_Pk(Foo, p1, ..., pk) { ... } // // as shorthand for // // template // FooActionPk Foo(p1_type p1, ..., pk_type pk) { ... } // // In particular, you can provide the template type arguments // explicitly when invoking Foo(), as in Foo(5, false); // although usually you can rely on the compiler to infer the types // for you automatically. You can assign the result of expression // Foo(p1, ..., pk) to a variable of type FooActionPk. This can be useful when composing actions. // // You can also overload actions with different numbers of parameters: // // ACTION_P(Plus, a) { ... } // ACTION_P2(Plus, a, b) { ... } // // While it's tempting to always use the ACTION* macros when defining // a new action, you should also consider implementing ActionInterface // or using MakePolymorphicAction() instead, especially if you need to // use the action a lot. While these approaches require more work, // they give you more control on the types of the mock function // arguments and the action parameters, which in general leads to // better compiler error messages that pay off in the long run. They // also allow overloading actions based on parameter types (as opposed // to just based on the number of parameters). // // CAVEAT: // // ACTION*() can only be used in a namespace scope. The reason is // that C++ doesn't yet allow function-local types to be used to // instantiate templates. The up-coming C++0x standard will fix this. // Once that's done, we'll consider supporting using ACTION*() inside // a function. // // MORE INFORMATION: // // To learn more about using these macros, please search for 'ACTION' // on http://code.google.com/p/googlemock/wiki/CookBook. $range i 0..n $range k 0..n-1 // An internal macro needed for implementing ACTION*(). #define GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_\ const args_type& args GTEST_ATTRIBUTE_UNUSED_ $for k [[, \ arg$k[[]]_type arg$k GTEST_ATTRIBUTE_UNUSED_]] // Sometimes you want to give an action explicit template parameters // that cannot be inferred from its value parameters. ACTION() and // ACTION_P*() don't support that. ACTION_TEMPLATE() remedies that // and can be viewed as an extension to ACTION() and ACTION_P*(). // // The syntax: // // ACTION_TEMPLATE(ActionName, // HAS_m_TEMPLATE_PARAMS(kind1, name1, ..., kind_m, name_m), // AND_n_VALUE_PARAMS(p1, ..., p_n)) { statements; } // // defines an action template that takes m explicit template // parameters and n value parameters. name_i is the name of the i-th // template parameter, and kind_i specifies whether it's a typename, // an integral constant, or a template. p_i is the name of the i-th // value parameter. // // Example: // // // DuplicateArg(output) converts the k-th argument of the mock // // function to type T and copies it to *output. // ACTION_TEMPLATE(DuplicateArg, // HAS_2_TEMPLATE_PARAMS(int, k, typename, T), // AND_1_VALUE_PARAMS(output)) { // *output = T(::testing::get(args)); // } // ... // int n; // EXPECT_CALL(mock, Foo(_, _)) // .WillOnce(DuplicateArg<1, unsigned char>(&n)); // // To create an instance of an action template, write: // // ActionName(v1, ..., v_n) // // where the ts are the template arguments and the vs are the value // arguments. The value argument types are inferred by the compiler. // If you want to explicitly specify the value argument types, you can // provide additional template arguments: // // ActionName(v1, ..., v_n) // // where u_i is the desired type of v_i. // // ACTION_TEMPLATE and ACTION/ACTION_P* can be overloaded on the // number of value parameters, but not on the number of template // parameters. Without the restriction, the meaning of the following // is unclear: // // OverloadedAction(x); // // Are we using a single-template-parameter action where 'bool' refers // to the type of x, or are we using a two-template-parameter action // where the compiler is asked to infer the type of x? // // Implementation notes: // // GMOCK_INTERNAL_*_HAS_m_TEMPLATE_PARAMS and // GMOCK_INTERNAL_*_AND_n_VALUE_PARAMS are internal macros for // implementing ACTION_TEMPLATE. The main trick we use is to create // new macro invocations when expanding a macro. For example, we have // // #define ACTION_TEMPLATE(name, template_params, value_params) // ... GMOCK_INTERNAL_DECL_##template_params ... // // which causes ACTION_TEMPLATE(..., HAS_1_TEMPLATE_PARAMS(typename, T), ...) // to expand to // // ... GMOCK_INTERNAL_DECL_HAS_1_TEMPLATE_PARAMS(typename, T) ... // // Since GMOCK_INTERNAL_DECL_HAS_1_TEMPLATE_PARAMS is a macro, the // preprocessor will continue to expand it to // // ... typename T ... // // This technique conforms to the C++ standard and is portable. It // allows us to implement action templates using O(N) code, where N is // the maximum number of template/value parameters supported. Without // using it, we'd have to devote O(N^2) amount of code to implement all // combinations of m and n. // Declares the template parameters. $range j 1..n $for j [[ $range m 0..j-1 #define GMOCK_INTERNAL_DECL_HAS_$j[[]] _TEMPLATE_PARAMS($for m, [[kind$m, name$m]]) $for m, [[kind$m name$m]] ]] // Lists the template parameters. $for j [[ $range m 0..j-1 #define GMOCK_INTERNAL_LIST_HAS_$j[[]] _TEMPLATE_PARAMS($for m, [[kind$m, name$m]]) $for m, [[name$m]] ]] // Declares the types of value parameters. $for i [[ $range j 0..i-1 #define GMOCK_INTERNAL_DECL_TYPE_AND_$i[[]] _VALUE_PARAMS($for j, [[p$j]]) $for j [[, typename p$j##_type]] ]] // Initializes the value parameters. $for i [[ $range j 0..i-1 #define GMOCK_INTERNAL_INIT_AND_$i[[]]_VALUE_PARAMS($for j, [[p$j]])\ ($for j, [[p$j##_type gmock_p$j]])$if i>0 [[ : ]]$for j, [[p$j(gmock_p$j)]] ]] // Declares the fields for storing the value parameters. $for i [[ $range j 0..i-1 #define GMOCK_INTERNAL_DEFN_AND_$i[[]] _VALUE_PARAMS($for j, [[p$j]]) $for j [[p$j##_type p$j; ]] ]] // Lists the value parameters. $for i [[ $range j 0..i-1 #define GMOCK_INTERNAL_LIST_AND_$i[[]] _VALUE_PARAMS($for j, [[p$j]]) $for j, [[p$j]] ]] // Lists the value parameter types. $for i [[ $range j 0..i-1 #define GMOCK_INTERNAL_LIST_TYPE_AND_$i[[]] _VALUE_PARAMS($for j, [[p$j]]) $for j [[, p$j##_type]] ]] // Declares the value parameters. $for i [[ $range j 0..i-1 #define GMOCK_INTERNAL_DECL_AND_$i[[]]_VALUE_PARAMS($for j, [[p$j]]) [[]] $for j, [[p$j##_type p$j]] ]] // The suffix of the class template implementing the action template. $for i [[ $range j 0..i-1 #define GMOCK_INTERNAL_COUNT_AND_$i[[]]_VALUE_PARAMS($for j, [[p$j]]) [[]] $if i==1 [[P]] $elif i>=2 [[P$i]] ]] // The name of the class template implementing the action template. #define GMOCK_ACTION_CLASS_(name, value_params)\ GTEST_CONCAT_TOKEN_(name##Action, GMOCK_INTERNAL_COUNT_##value_params) $range k 0..n-1 #define ACTION_TEMPLATE(name, template_params, value_params)\ template \ class GMOCK_ACTION_CLASS_(name, value_params) {\ public:\ explicit GMOCK_ACTION_CLASS_(name, value_params)\ GMOCK_INTERNAL_INIT_##value_params {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ explicit gmock_Impl GMOCK_INTERNAL_INIT_##value_params {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template <$for k, [[typename arg$k[[]]_type]]>\ return_type gmock_PerformImpl(const args_type& args[[]] $for k [[, arg$k[[]]_type arg$k]]) const;\ GMOCK_INTERNAL_DEFN_##value_params\ private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(\ new gmock_Impl(GMOCK_INTERNAL_LIST_##value_params));\ }\ GMOCK_INTERNAL_DEFN_##value_params\ private:\ GTEST_DISALLOW_ASSIGN_(GMOCK_ACTION_CLASS_(name, value_params));\ };\ template \ inline GMOCK_ACTION_CLASS_(name, value_params)<\ GMOCK_INTERNAL_LIST_##template_params\ GMOCK_INTERNAL_LIST_TYPE_##value_params> name(\ GMOCK_INTERNAL_DECL_##value_params) {\ return GMOCK_ACTION_CLASS_(name, value_params)<\ GMOCK_INTERNAL_LIST_##template_params\ GMOCK_INTERNAL_LIST_TYPE_##value_params>(\ GMOCK_INTERNAL_LIST_##value_params);\ }\ template \ template \ template \ typename ::testing::internal::Function::Result\ GMOCK_ACTION_CLASS_(name, value_params)<\ GMOCK_INTERNAL_LIST_##template_params\ GMOCK_INTERNAL_LIST_TYPE_##value_params>::gmock_Impl::\ gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const $for i [[ $var template = [[$if i==0 [[]] $else [[ $range j 0..i-1 template <$for j, [[typename p$j##_type]]>\ ]]]] $var class_name = [[name##Action[[$if i==0 [[]] $elif i==1 [[P]] $else [[P$i]]]]]] $range j 0..i-1 $var ctor_param_list = [[$for j, [[p$j##_type gmock_p$j]]]] $var param_types_and_names = [[$for j, [[p$j##_type p$j]]]] $var inits = [[$if i==0 [[]] $else [[ : $for j, [[p$j(gmock_p$j)]]]]]] $var param_field_decls = [[$for j [[ p$j##_type p$j;\ ]]]] $var param_field_decls2 = [[$for j [[ p$j##_type p$j;\ ]]]] $var params = [[$for j, [[p$j]]]] $var param_types = [[$if i==0 [[]] $else [[<$for j, [[p$j##_type]]>]]]] $var typename_arg_types = [[$for k, [[typename arg$k[[]]_type]]]] $var arg_types_and_names = [[$for k, [[arg$k[[]]_type arg$k]]]] $var macro_name = [[$if i==0 [[ACTION]] $elif i==1 [[ACTION_P]] $else [[ACTION_P$i]]]] #define $macro_name(name$for j [[, p$j]])\$template class $class_name {\ public:\ [[$if i==1 [[explicit ]]]]$class_name($ctor_param_list)$inits {}\ template \ class gmock_Impl : public ::testing::ActionInterface {\ public:\ typedef F function_type;\ typedef typename ::testing::internal::Function::Result return_type;\ typedef typename ::testing::internal::Function::ArgumentTuple\ args_type;\ [[$if i==1 [[explicit ]]]]gmock_Impl($ctor_param_list)$inits {}\ virtual return_type Perform(const args_type& args) {\ return ::testing::internal::ActionHelper::\ Perform(this, args);\ }\ template <$typename_arg_types>\ return_type gmock_PerformImpl(const args_type& args, [[]] $arg_types_and_names) const;\$param_field_decls private:\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template operator ::testing::Action() const {\ return ::testing::Action(new gmock_Impl($params));\ }\$param_field_decls2 private:\ GTEST_DISALLOW_ASSIGN_($class_name);\ };\$template inline $class_name$param_types name($param_types_and_names) {\ return $class_name$param_types($params);\ }\$template template \ template <$typename_arg_types>\ typename ::testing::internal::Function::Result\ $class_name$param_types::gmock_Impl::gmock_PerformImpl(\ GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const ]] $$ } // This meta comment fixes auto-indentation in Emacs. It won't $$ // show up in the generated code. namespace testing { // The ACTION*() macros trigger warning C4100 (unreferenced formal // parameter) in MSVC with -W4. Unfortunately they cannot be fixed in // the macro definition, as the warnings are generated when the macro // is expanded and macro expansion cannot contain #pragma. Therefore // we suppress them here. #ifdef _MSC_VER # pragma warning(push) # pragma warning(disable:4100) #endif // Various overloads for InvokeArgument(). // // The InvokeArgument(a1, a2, ..., a_k) action invokes the N-th // (0-based) argument, which must be a k-ary callable, of the mock // function, with arguments a1, a2, ..., a_k. // // Notes: // // 1. The arguments are passed by value by default. If you need to // pass an argument by reference, wrap it inside ByRef(). For // example, // // InvokeArgument<1>(5, string("Hello"), ByRef(foo)) // // passes 5 and string("Hello") by value, and passes foo by // reference. // // 2. If the callable takes an argument by reference but ByRef() is // not used, it will receive the reference to a copy of the value, // instead of the original value. For example, when the 0-th // argument of the mock function takes a const string&, the action // // InvokeArgument<0>(string("Hello")) // // makes a copy of the temporary string("Hello") object and passes a // reference of the copy, instead of the original temporary object, // to the callable. This makes it easy for a user to define an // InvokeArgument action from temporary values and have it performed // later. namespace internal { namespace invoke_argument { // Appears in InvokeArgumentAdl's argument list to help avoid // accidental calls to user functions of the same name. struct AdlTag {}; // InvokeArgumentAdl - a helper for InvokeArgument. // The basic overloads are provided here for generic functors. // Overloads for other custom-callables are provided in the // internal/custom/callback-actions.h header. $range i 0..n $for i [[ $range j 1..i template R InvokeArgumentAdl(AdlTag, F f[[$for j [[, A$j a$j]]]]) { return f([[$for j, [[a$j]]]]); } ]] } // namespace invoke_argument } // namespace internal $range i 0..n $for i [[ $range j 0..i-1 ACTION_TEMPLATE(InvokeArgument, HAS_1_TEMPLATE_PARAMS(int, k), AND_$i[[]]_VALUE_PARAMS($for j, [[p$j]])) { using internal::invoke_argument::InvokeArgumentAdl; return InvokeArgumentAdl( internal::invoke_argument::AdlTag(), ::testing::get(args)$for j [[, p$j]]); } ]] // Various overloads for ReturnNew(). // // The ReturnNew(a1, a2, ..., a_k) action returns a pointer to a new // instance of type T, constructed on the heap with constructor arguments // a1, a2, ..., and a_k. The caller assumes ownership of the returned value. $range i 0..n $for i [[ $range j 0..i-1 $var ps = [[$for j, [[p$j]]]] ACTION_TEMPLATE(ReturnNew, HAS_1_TEMPLATE_PARAMS(typename, T), AND_$i[[]]_VALUE_PARAMS($ps)) { return new T($ps); } ]] #ifdef _MSC_VER # pragma warning(pop) #endif } // namespace testing // Include any custom callback actions added by the local installation. // We must include this header at the end to make sure it can use the // declarations from this file. #include "gmock/internal/custom/gmock-generated-actions.h" #endif // GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_ACTIONS_H_ vendor/googletest/gtest-1.7.0/googlemock/include/gmock/gmock-generated-function-mockers.h000066400000000000000000001325571300002025200316550ustar00rootroot00000000000000// This file was GENERATED by command: // pump.py gmock-generated-function-mockers.h.pump // DO NOT EDIT BY HAND!!! // Copyright 2007, Google Inc. // 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 Google Inc. 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. // // Author: wan@google.com (Zhanyong Wan) // Google Mock - a framework for writing C++ mock classes. // // This file implements function mockers of various arities. #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_FUNCTION_MOCKERS_H_ #define GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_FUNCTION_MOCKERS_H_ #include "gmock/gmock-spec-builders.h" #include "gmock/internal/gmock-internal-utils.h" #if GTEST_HAS_STD_FUNCTION_ # include #endif namespace testing { namespace internal { template class FunctionMockerBase; // Note: class FunctionMocker really belongs to the ::testing // namespace. However if we define it in ::testing, MSVC will // complain when classes in ::testing::internal declare it as a // friend class template. To workaround this compiler bug, we define // FunctionMocker in ::testing::internal and import it into ::testing. template class FunctionMocker; template class FunctionMocker : public internal::FunctionMockerBase { public: typedef R F(); typedef typename internal::Function::ArgumentTuple ArgumentTuple; MockSpec& With() { return this->current_spec(); } R Invoke() { // Even though gcc and MSVC don't enforce it, 'this->' is required // by the C++ standard [14.6.4] here, as the base class type is // dependent on the template argument (and thus shouldn't be // looked into when resolving InvokeWith). return this->InvokeWith(ArgumentTuple()); } }; template class FunctionMocker : public internal::FunctionMockerBase { public: typedef R F(A1); typedef typename internal::Function::ArgumentTuple ArgumentTuple; MockSpec& With(const Matcher& m1) { this->current_spec().SetMatchers(::testing::make_tuple(m1)); return this->current_spec(); } R Invoke(A1 a1) { // Even though gcc and MSVC don't enforce it, 'this->' is required // by the C++ standard [14.6.4] here, as the base class type is // dependent on the template argument (and thus shouldn't be // looked into when resolving InvokeWith). return this->InvokeWith(ArgumentTuple(a1)); } }; template class FunctionMocker : public internal::FunctionMockerBase { public: typedef R F(A1, A2); typedef typename internal::Function::ArgumentTuple ArgumentTuple; MockSpec& With(const Matcher& m1, const Matcher& m2) { this->current_spec().SetMatchers(::testing::make_tuple(m1, m2)); return this->current_spec(); } R Invoke(A1 a1, A2 a2) { // Even though gcc and MSVC don't enforce it, 'this->' is required // by the C++ standard [14.6.4] here, as the base class type is // dependent on the template argument (and thus shouldn't be // looked into when resolving InvokeWith). return this->InvokeWith(ArgumentTuple(a1, a2)); } }; template class FunctionMocker : public internal::FunctionMockerBase { public: typedef R F(A1, A2, A3); typedef typename internal::Function::ArgumentTuple ArgumentTuple; MockSpec& With(const Matcher& m1, const Matcher& m2, const Matcher& m3) { this->current_spec().SetMatchers(::testing::make_tuple(m1, m2, m3)); return this->current_spec(); } R Invoke(A1 a1, A2 a2, A3 a3) { // Even though gcc and MSVC don't enforce it, 'this->' is required // by the C++ standard [14.6.4] here, as the base class type is // dependent on the template argument (and thus shouldn't be // looked into when resolving InvokeWith). return this->InvokeWith(ArgumentTuple(a1, a2, a3)); } }; template class FunctionMocker : public internal::FunctionMockerBase { public: typedef R F(A1, A2, A3, A4); typedef typename internal::Function::ArgumentTuple ArgumentTuple; MockSpec& With(const Matcher& m1, const Matcher& m2, const Matcher& m3, const Matcher& m4) { this->current_spec().SetMatchers(::testing::make_tuple(m1, m2, m3, m4)); return this->current_spec(); } R Invoke(A1 a1, A2 a2, A3 a3, A4 a4) { // Even though gcc and MSVC don't enforce it, 'this->' is required // by the C++ standard [14.6.4] here, as the base class type is // dependent on the template argument (and thus shouldn't be // looked into when resolving InvokeWith). return this->InvokeWith(ArgumentTuple(a1, a2, a3, a4)); } }; template class FunctionMocker : public internal::FunctionMockerBase { public: typedef R F(A1, A2, A3, A4, A5); typedef typename internal::Function::ArgumentTuple ArgumentTuple; MockSpec& With(const Matcher& m1, const Matcher& m2, const Matcher& m3, const Matcher& m4, const Matcher& m5) { this->current_spec().SetMatchers(::testing::make_tuple(m1, m2, m3, m4, m5)); return this->current_spec(); } R Invoke(A1 a1, A2 a2, A3 a3, A4 a4, A5 a5) { // Even though gcc and MSVC don't enforce it, 'this->' is required // by the C++ standard [14.6.4] here, as the base class type is // dependent on the template argument (and thus shouldn't be // looked into when resolving InvokeWith). return this->InvokeWith(ArgumentTuple(a1, a2, a3, a4, a5)); } }; template class FunctionMocker : public internal::FunctionMockerBase { public: typedef R F(A1, A2, A3, A4, A5, A6); typedef typename internal::Function::ArgumentTuple ArgumentTuple; MockSpec& With(const Matcher& m1, const Matcher& m2, const Matcher& m3, const Matcher& m4, const Matcher& m5, const Matcher& m6) { this->current_spec().SetMatchers(::testing::make_tuple(m1, m2, m3, m4, m5, m6)); return this->current_spec(); } R Invoke(A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6) { // Even though gcc and MSVC don't enforce it, 'this->' is required // by the C++ standard [14.6.4] here, as the base class type is // dependent on the template argument (and thus shouldn't be // looked into when resolving InvokeWith). return this->InvokeWith(ArgumentTuple(a1, a2, a3, a4, a5, a6)); } }; template class FunctionMocker : public internal::FunctionMockerBase { public: typedef R F(A1, A2, A3, A4, A5, A6, A7); typedef typename internal::Function::ArgumentTuple ArgumentTuple; MockSpec& With(const Matcher& m1, const Matcher& m2, const Matcher& m3, const Matcher& m4, const Matcher& m5, const Matcher& m6, const Matcher& m7) { this->current_spec().SetMatchers(::testing::make_tuple(m1, m2, m3, m4, m5, m6, m7)); return this->current_spec(); } R Invoke(A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7) { // Even though gcc and MSVC don't enforce it, 'this->' is required // by the C++ standard [14.6.4] here, as the base class type is // dependent on the template argument (and thus shouldn't be // looked into when resolving InvokeWith). return this->InvokeWith(ArgumentTuple(a1, a2, a3, a4, a5, a6, a7)); } }; template class FunctionMocker : public internal::FunctionMockerBase { public: typedef R F(A1, A2, A3, A4, A5, A6, A7, A8); typedef typename internal::Function::ArgumentTuple ArgumentTuple; MockSpec& With(const Matcher& m1, const Matcher& m2, const Matcher& m3, const Matcher& m4, const Matcher& m5, const Matcher& m6, const Matcher& m7, const Matcher& m8) { this->current_spec().SetMatchers(::testing::make_tuple(m1, m2, m3, m4, m5, m6, m7, m8)); return this->current_spec(); } R Invoke(A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7, A8 a8) { // Even though gcc and MSVC don't enforce it, 'this->' is required // by the C++ standard [14.6.4] here, as the base class type is // dependent on the template argument (and thus shouldn't be // looked into when resolving InvokeWith). return this->InvokeWith(ArgumentTuple(a1, a2, a3, a4, a5, a6, a7, a8)); } }; template class FunctionMocker : public internal::FunctionMockerBase { public: typedef R F(A1, A2, A3, A4, A5, A6, A7, A8, A9); typedef typename internal::Function::ArgumentTuple ArgumentTuple; MockSpec& With(const Matcher& m1, const Matcher& m2, const Matcher& m3, const Matcher& m4, const Matcher& m5, const Matcher& m6, const Matcher& m7, const Matcher& m8, const Matcher& m9) { this->current_spec().SetMatchers(::testing::make_tuple(m1, m2, m3, m4, m5, m6, m7, m8, m9)); return this->current_spec(); } R Invoke(A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7, A8 a8, A9 a9) { // Even though gcc and MSVC don't enforce it, 'this->' is required // by the C++ standard [14.6.4] here, as the base class type is // dependent on the template argument (and thus shouldn't be // looked into when resolving InvokeWith). return this->InvokeWith(ArgumentTuple(a1, a2, a3, a4, a5, a6, a7, a8, a9)); } }; template class FunctionMocker : public internal::FunctionMockerBase { public: typedef R F(A1, A2, A3, A4, A5, A6, A7, A8, A9, A10); typedef typename internal::Function::ArgumentTuple ArgumentTuple; MockSpec& With(const Matcher& m1, const Matcher& m2, const Matcher& m3, const Matcher& m4, const Matcher& m5, const Matcher& m6, const Matcher& m7, const Matcher& m8, const Matcher& m9, const Matcher& m10) { this->current_spec().SetMatchers(::testing::make_tuple(m1, m2, m3, m4, m5, m6, m7, m8, m9, m10)); return this->current_spec(); } R Invoke(A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7, A8 a8, A9 a9, A10 a10) { // Even though gcc and MSVC don't enforce it, 'this->' is required // by the C++ standard [14.6.4] here, as the base class type is // dependent on the template argument (and thus shouldn't be // looked into when resolving InvokeWith). return this->InvokeWith(ArgumentTuple(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)); } }; } // namespace internal // The style guide prohibits "using" statements in a namespace scope // inside a header file. However, the FunctionMocker class template // is meant to be defined in the ::testing namespace. The following // line is just a trick for working around a bug in MSVC 8.0, which // cannot handle it if we define FunctionMocker in ::testing. using internal::FunctionMocker; // GMOCK_RESULT_(tn, F) expands to the result type of function type F. // We define this as a variadic macro in case F contains unprotected // commas (the same reason that we use variadic macros in other places // in this file). // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_RESULT_(tn, ...) \ tn ::testing::internal::Function<__VA_ARGS__>::Result // The type of argument N of the given function type. // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_ARG_(tn, N, ...) \ tn ::testing::internal::Function<__VA_ARGS__>::Argument##N // The matcher type for argument N of the given function type. // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_MATCHER_(tn, N, ...) \ const ::testing::Matcher& // The variable for mocking the given method. // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_MOCKER_(arity, constness, Method) \ GTEST_CONCAT_TOKEN_(gmock##constness##arity##_##Method##_, __LINE__) // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_METHOD0_(tn, constness, ct, Method, ...) \ GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \ ) constness { \ GTEST_COMPILE_ASSERT_((::testing::tuple_size< \ tn ::testing::internal::Function<__VA_ARGS__>::ArgumentTuple>::value \ == 0), \ this_method_does_not_take_0_arguments); \ GMOCK_MOCKER_(0, constness, Method).SetOwnerAndName(this, #Method); \ return GMOCK_MOCKER_(0, constness, Method).Invoke(); \ } \ ::testing::MockSpec<__VA_ARGS__>& \ gmock_##Method() constness { \ GMOCK_MOCKER_(0, constness, Method).RegisterOwner(this); \ return GMOCK_MOCKER_(0, constness, Method).With(); \ } \ mutable ::testing::FunctionMocker<__VA_ARGS__> GMOCK_MOCKER_(0, constness, \ Method) // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_METHOD1_(tn, constness, ct, Method, ...) \ GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \ GMOCK_ARG_(tn, 1, __VA_ARGS__) gmock_a1) constness { \ GTEST_COMPILE_ASSERT_((::testing::tuple_size< \ tn ::testing::internal::Function<__VA_ARGS__>::ArgumentTuple>::value \ == 1), \ this_method_does_not_take_1_argument); \ GMOCK_MOCKER_(1, constness, Method).SetOwnerAndName(this, #Method); \ return GMOCK_MOCKER_(1, constness, Method).Invoke(gmock_a1); \ } \ ::testing::MockSpec<__VA_ARGS__>& \ gmock_##Method(GMOCK_MATCHER_(tn, 1, __VA_ARGS__) gmock_a1) constness { \ GMOCK_MOCKER_(1, constness, Method).RegisterOwner(this); \ return GMOCK_MOCKER_(1, constness, Method).With(gmock_a1); \ } \ mutable ::testing::FunctionMocker<__VA_ARGS__> GMOCK_MOCKER_(1, constness, \ Method) // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_METHOD2_(tn, constness, ct, Method, ...) \ GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \ GMOCK_ARG_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_ARG_(tn, 2, __VA_ARGS__) gmock_a2) constness { \ GTEST_COMPILE_ASSERT_((::testing::tuple_size< \ tn ::testing::internal::Function<__VA_ARGS__>::ArgumentTuple>::value \ == 2), \ this_method_does_not_take_2_arguments); \ GMOCK_MOCKER_(2, constness, Method).SetOwnerAndName(this, #Method); \ return GMOCK_MOCKER_(2, constness, Method).Invoke(gmock_a1, gmock_a2); \ } \ ::testing::MockSpec<__VA_ARGS__>& \ gmock_##Method(GMOCK_MATCHER_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_MATCHER_(tn, 2, __VA_ARGS__) gmock_a2) constness { \ GMOCK_MOCKER_(2, constness, Method).RegisterOwner(this); \ return GMOCK_MOCKER_(2, constness, Method).With(gmock_a1, gmock_a2); \ } \ mutable ::testing::FunctionMocker<__VA_ARGS__> GMOCK_MOCKER_(2, constness, \ Method) // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_METHOD3_(tn, constness, ct, Method, ...) \ GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \ GMOCK_ARG_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_ARG_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_ARG_(tn, 3, __VA_ARGS__) gmock_a3) constness { \ GTEST_COMPILE_ASSERT_((::testing::tuple_size< \ tn ::testing::internal::Function<__VA_ARGS__>::ArgumentTuple>::value \ == 3), \ this_method_does_not_take_3_arguments); \ GMOCK_MOCKER_(3, constness, Method).SetOwnerAndName(this, #Method); \ return GMOCK_MOCKER_(3, constness, Method).Invoke(gmock_a1, gmock_a2, \ gmock_a3); \ } \ ::testing::MockSpec<__VA_ARGS__>& \ gmock_##Method(GMOCK_MATCHER_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_MATCHER_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_MATCHER_(tn, 3, __VA_ARGS__) gmock_a3) constness { \ GMOCK_MOCKER_(3, constness, Method).RegisterOwner(this); \ return GMOCK_MOCKER_(3, constness, Method).With(gmock_a1, gmock_a2, \ gmock_a3); \ } \ mutable ::testing::FunctionMocker<__VA_ARGS__> GMOCK_MOCKER_(3, constness, \ Method) // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_METHOD4_(tn, constness, ct, Method, ...) \ GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \ GMOCK_ARG_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_ARG_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_ARG_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_ARG_(tn, 4, __VA_ARGS__) gmock_a4) constness { \ GTEST_COMPILE_ASSERT_((::testing::tuple_size< \ tn ::testing::internal::Function<__VA_ARGS__>::ArgumentTuple>::value \ == 4), \ this_method_does_not_take_4_arguments); \ GMOCK_MOCKER_(4, constness, Method).SetOwnerAndName(this, #Method); \ return GMOCK_MOCKER_(4, constness, Method).Invoke(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4); \ } \ ::testing::MockSpec<__VA_ARGS__>& \ gmock_##Method(GMOCK_MATCHER_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_MATCHER_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_MATCHER_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_MATCHER_(tn, 4, __VA_ARGS__) gmock_a4) constness { \ GMOCK_MOCKER_(4, constness, Method).RegisterOwner(this); \ return GMOCK_MOCKER_(4, constness, Method).With(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4); \ } \ mutable ::testing::FunctionMocker<__VA_ARGS__> GMOCK_MOCKER_(4, constness, \ Method) // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_METHOD5_(tn, constness, ct, Method, ...) \ GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \ GMOCK_ARG_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_ARG_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_ARG_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_ARG_(tn, 4, __VA_ARGS__) gmock_a4, \ GMOCK_ARG_(tn, 5, __VA_ARGS__) gmock_a5) constness { \ GTEST_COMPILE_ASSERT_((::testing::tuple_size< \ tn ::testing::internal::Function<__VA_ARGS__>::ArgumentTuple>::value \ == 5), \ this_method_does_not_take_5_arguments); \ GMOCK_MOCKER_(5, constness, Method).SetOwnerAndName(this, #Method); \ return GMOCK_MOCKER_(5, constness, Method).Invoke(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4, gmock_a5); \ } \ ::testing::MockSpec<__VA_ARGS__>& \ gmock_##Method(GMOCK_MATCHER_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_MATCHER_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_MATCHER_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_MATCHER_(tn, 4, __VA_ARGS__) gmock_a4, \ GMOCK_MATCHER_(tn, 5, __VA_ARGS__) gmock_a5) constness { \ GMOCK_MOCKER_(5, constness, Method).RegisterOwner(this); \ return GMOCK_MOCKER_(5, constness, Method).With(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4, gmock_a5); \ } \ mutable ::testing::FunctionMocker<__VA_ARGS__> GMOCK_MOCKER_(5, constness, \ Method) // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_METHOD6_(tn, constness, ct, Method, ...) \ GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \ GMOCK_ARG_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_ARG_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_ARG_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_ARG_(tn, 4, __VA_ARGS__) gmock_a4, \ GMOCK_ARG_(tn, 5, __VA_ARGS__) gmock_a5, \ GMOCK_ARG_(tn, 6, __VA_ARGS__) gmock_a6) constness { \ GTEST_COMPILE_ASSERT_((::testing::tuple_size< \ tn ::testing::internal::Function<__VA_ARGS__>::ArgumentTuple>::value \ == 6), \ this_method_does_not_take_6_arguments); \ GMOCK_MOCKER_(6, constness, Method).SetOwnerAndName(this, #Method); \ return GMOCK_MOCKER_(6, constness, Method).Invoke(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4, gmock_a5, gmock_a6); \ } \ ::testing::MockSpec<__VA_ARGS__>& \ gmock_##Method(GMOCK_MATCHER_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_MATCHER_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_MATCHER_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_MATCHER_(tn, 4, __VA_ARGS__) gmock_a4, \ GMOCK_MATCHER_(tn, 5, __VA_ARGS__) gmock_a5, \ GMOCK_MATCHER_(tn, 6, __VA_ARGS__) gmock_a6) constness { \ GMOCK_MOCKER_(6, constness, Method).RegisterOwner(this); \ return GMOCK_MOCKER_(6, constness, Method).With(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4, gmock_a5, gmock_a6); \ } \ mutable ::testing::FunctionMocker<__VA_ARGS__> GMOCK_MOCKER_(6, constness, \ Method) // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_METHOD7_(tn, constness, ct, Method, ...) \ GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \ GMOCK_ARG_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_ARG_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_ARG_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_ARG_(tn, 4, __VA_ARGS__) gmock_a4, \ GMOCK_ARG_(tn, 5, __VA_ARGS__) gmock_a5, \ GMOCK_ARG_(tn, 6, __VA_ARGS__) gmock_a6, \ GMOCK_ARG_(tn, 7, __VA_ARGS__) gmock_a7) constness { \ GTEST_COMPILE_ASSERT_((::testing::tuple_size< \ tn ::testing::internal::Function<__VA_ARGS__>::ArgumentTuple>::value \ == 7), \ this_method_does_not_take_7_arguments); \ GMOCK_MOCKER_(7, constness, Method).SetOwnerAndName(this, #Method); \ return GMOCK_MOCKER_(7, constness, Method).Invoke(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4, gmock_a5, gmock_a6, gmock_a7); \ } \ ::testing::MockSpec<__VA_ARGS__>& \ gmock_##Method(GMOCK_MATCHER_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_MATCHER_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_MATCHER_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_MATCHER_(tn, 4, __VA_ARGS__) gmock_a4, \ GMOCK_MATCHER_(tn, 5, __VA_ARGS__) gmock_a5, \ GMOCK_MATCHER_(tn, 6, __VA_ARGS__) gmock_a6, \ GMOCK_MATCHER_(tn, 7, __VA_ARGS__) gmock_a7) constness { \ GMOCK_MOCKER_(7, constness, Method).RegisterOwner(this); \ return GMOCK_MOCKER_(7, constness, Method).With(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4, gmock_a5, gmock_a6, gmock_a7); \ } \ mutable ::testing::FunctionMocker<__VA_ARGS__> GMOCK_MOCKER_(7, constness, \ Method) // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_METHOD8_(tn, constness, ct, Method, ...) \ GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \ GMOCK_ARG_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_ARG_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_ARG_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_ARG_(tn, 4, __VA_ARGS__) gmock_a4, \ GMOCK_ARG_(tn, 5, __VA_ARGS__) gmock_a5, \ GMOCK_ARG_(tn, 6, __VA_ARGS__) gmock_a6, \ GMOCK_ARG_(tn, 7, __VA_ARGS__) gmock_a7, \ GMOCK_ARG_(tn, 8, __VA_ARGS__) gmock_a8) constness { \ GTEST_COMPILE_ASSERT_((::testing::tuple_size< \ tn ::testing::internal::Function<__VA_ARGS__>::ArgumentTuple>::value \ == 8), \ this_method_does_not_take_8_arguments); \ GMOCK_MOCKER_(8, constness, Method).SetOwnerAndName(this, #Method); \ return GMOCK_MOCKER_(8, constness, Method).Invoke(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4, gmock_a5, gmock_a6, gmock_a7, gmock_a8); \ } \ ::testing::MockSpec<__VA_ARGS__>& \ gmock_##Method(GMOCK_MATCHER_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_MATCHER_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_MATCHER_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_MATCHER_(tn, 4, __VA_ARGS__) gmock_a4, \ GMOCK_MATCHER_(tn, 5, __VA_ARGS__) gmock_a5, \ GMOCK_MATCHER_(tn, 6, __VA_ARGS__) gmock_a6, \ GMOCK_MATCHER_(tn, 7, __VA_ARGS__) gmock_a7, \ GMOCK_MATCHER_(tn, 8, __VA_ARGS__) gmock_a8) constness { \ GMOCK_MOCKER_(8, constness, Method).RegisterOwner(this); \ return GMOCK_MOCKER_(8, constness, Method).With(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4, gmock_a5, gmock_a6, gmock_a7, gmock_a8); \ } \ mutable ::testing::FunctionMocker<__VA_ARGS__> GMOCK_MOCKER_(8, constness, \ Method) // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_METHOD9_(tn, constness, ct, Method, ...) \ GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \ GMOCK_ARG_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_ARG_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_ARG_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_ARG_(tn, 4, __VA_ARGS__) gmock_a4, \ GMOCK_ARG_(tn, 5, __VA_ARGS__) gmock_a5, \ GMOCK_ARG_(tn, 6, __VA_ARGS__) gmock_a6, \ GMOCK_ARG_(tn, 7, __VA_ARGS__) gmock_a7, \ GMOCK_ARG_(tn, 8, __VA_ARGS__) gmock_a8, \ GMOCK_ARG_(tn, 9, __VA_ARGS__) gmock_a9) constness { \ GTEST_COMPILE_ASSERT_((::testing::tuple_size< \ tn ::testing::internal::Function<__VA_ARGS__>::ArgumentTuple>::value \ == 9), \ this_method_does_not_take_9_arguments); \ GMOCK_MOCKER_(9, constness, Method).SetOwnerAndName(this, #Method); \ return GMOCK_MOCKER_(9, constness, Method).Invoke(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4, gmock_a5, gmock_a6, gmock_a7, gmock_a8, \ gmock_a9); \ } \ ::testing::MockSpec<__VA_ARGS__>& \ gmock_##Method(GMOCK_MATCHER_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_MATCHER_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_MATCHER_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_MATCHER_(tn, 4, __VA_ARGS__) gmock_a4, \ GMOCK_MATCHER_(tn, 5, __VA_ARGS__) gmock_a5, \ GMOCK_MATCHER_(tn, 6, __VA_ARGS__) gmock_a6, \ GMOCK_MATCHER_(tn, 7, __VA_ARGS__) gmock_a7, \ GMOCK_MATCHER_(tn, 8, __VA_ARGS__) gmock_a8, \ GMOCK_MATCHER_(tn, 9, __VA_ARGS__) gmock_a9) constness { \ GMOCK_MOCKER_(9, constness, Method).RegisterOwner(this); \ return GMOCK_MOCKER_(9, constness, Method).With(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4, gmock_a5, gmock_a6, gmock_a7, gmock_a8, \ gmock_a9); \ } \ mutable ::testing::FunctionMocker<__VA_ARGS__> GMOCK_MOCKER_(9, constness, \ Method) // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_METHOD10_(tn, constness, ct, Method, ...) \ GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \ GMOCK_ARG_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_ARG_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_ARG_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_ARG_(tn, 4, __VA_ARGS__) gmock_a4, \ GMOCK_ARG_(tn, 5, __VA_ARGS__) gmock_a5, \ GMOCK_ARG_(tn, 6, __VA_ARGS__) gmock_a6, \ GMOCK_ARG_(tn, 7, __VA_ARGS__) gmock_a7, \ GMOCK_ARG_(tn, 8, __VA_ARGS__) gmock_a8, \ GMOCK_ARG_(tn, 9, __VA_ARGS__) gmock_a9, \ GMOCK_ARG_(tn, 10, __VA_ARGS__) gmock_a10) constness { \ GTEST_COMPILE_ASSERT_((::testing::tuple_size< \ tn ::testing::internal::Function<__VA_ARGS__>::ArgumentTuple>::value \ == 10), \ this_method_does_not_take_10_arguments); \ GMOCK_MOCKER_(10, constness, Method).SetOwnerAndName(this, #Method); \ return GMOCK_MOCKER_(10, constness, Method).Invoke(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4, gmock_a5, gmock_a6, gmock_a7, gmock_a8, gmock_a9, \ gmock_a10); \ } \ ::testing::MockSpec<__VA_ARGS__>& \ gmock_##Method(GMOCK_MATCHER_(tn, 1, __VA_ARGS__) gmock_a1, \ GMOCK_MATCHER_(tn, 2, __VA_ARGS__) gmock_a2, \ GMOCK_MATCHER_(tn, 3, __VA_ARGS__) gmock_a3, \ GMOCK_MATCHER_(tn, 4, __VA_ARGS__) gmock_a4, \ GMOCK_MATCHER_(tn, 5, __VA_ARGS__) gmock_a5, \ GMOCK_MATCHER_(tn, 6, __VA_ARGS__) gmock_a6, \ GMOCK_MATCHER_(tn, 7, __VA_ARGS__) gmock_a7, \ GMOCK_MATCHER_(tn, 8, __VA_ARGS__) gmock_a8, \ GMOCK_MATCHER_(tn, 9, __VA_ARGS__) gmock_a9, \ GMOCK_MATCHER_(tn, 10, \ __VA_ARGS__) gmock_a10) constness { \ GMOCK_MOCKER_(10, constness, Method).RegisterOwner(this); \ return GMOCK_MOCKER_(10, constness, Method).With(gmock_a1, gmock_a2, \ gmock_a3, gmock_a4, gmock_a5, gmock_a6, gmock_a7, gmock_a8, gmock_a9, \ gmock_a10); \ } \ mutable ::testing::FunctionMocker<__VA_ARGS__> GMOCK_MOCKER_(10, constness, \ Method) #define MOCK_METHOD0(m, ...) GMOCK_METHOD0_(, , , m, __VA_ARGS__) #define MOCK_METHOD1(m, ...) GMOCK_METHOD1_(, , , m, __VA_ARGS__) #define MOCK_METHOD2(m, ...) GMOCK_METHOD2_(, , , m, __VA_ARGS__) #define MOCK_METHOD3(m, ...) GMOCK_METHOD3_(, , , m, __VA_ARGS__) #define MOCK_METHOD4(m, ...) GMOCK_METHOD4_(, , , m, __VA_ARGS__) #define MOCK_METHOD5(m, ...) GMOCK_METHOD5_(, , , m, __VA_ARGS__) #define MOCK_METHOD6(m, ...) GMOCK_METHOD6_(, , , m, __VA_ARGS__) #define MOCK_METHOD7(m, ...) GMOCK_METHOD7_(, , , m, __VA_ARGS__) #define MOCK_METHOD8(m, ...) GMOCK_METHOD8_(, , , m, __VA_ARGS__) #define MOCK_METHOD9(m, ...) GMOCK_METHOD9_(, , , m, __VA_ARGS__) #define MOCK_METHOD10(m, ...) GMOCK_METHOD10_(, , , m, __VA_ARGS__) #define MOCK_CONST_METHOD0(m, ...) GMOCK_METHOD0_(, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD1(m, ...) GMOCK_METHOD1_(, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD2(m, ...) GMOCK_METHOD2_(, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD3(m, ...) GMOCK_METHOD3_(, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD4(m, ...) GMOCK_METHOD4_(, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD5(m, ...) GMOCK_METHOD5_(, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD6(m, ...) GMOCK_METHOD6_(, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD7(m, ...) GMOCK_METHOD7_(, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD8(m, ...) GMOCK_METHOD8_(, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD9(m, ...) GMOCK_METHOD9_(, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD10(m, ...) GMOCK_METHOD10_(, const, , m, __VA_ARGS__) #define MOCK_METHOD0_T(m, ...) GMOCK_METHOD0_(typename, , , m, __VA_ARGS__) #define MOCK_METHOD1_T(m, ...) GMOCK_METHOD1_(typename, , , m, __VA_ARGS__) #define MOCK_METHOD2_T(m, ...) GMOCK_METHOD2_(typename, , , m, __VA_ARGS__) #define MOCK_METHOD3_T(m, ...) GMOCK_METHOD3_(typename, , , m, __VA_ARGS__) #define MOCK_METHOD4_T(m, ...) GMOCK_METHOD4_(typename, , , m, __VA_ARGS__) #define MOCK_METHOD5_T(m, ...) GMOCK_METHOD5_(typename, , , m, __VA_ARGS__) #define MOCK_METHOD6_T(m, ...) GMOCK_METHOD6_(typename, , , m, __VA_ARGS__) #define MOCK_METHOD7_T(m, ...) GMOCK_METHOD7_(typename, , , m, __VA_ARGS__) #define MOCK_METHOD8_T(m, ...) GMOCK_METHOD8_(typename, , , m, __VA_ARGS__) #define MOCK_METHOD9_T(m, ...) GMOCK_METHOD9_(typename, , , m, __VA_ARGS__) #define MOCK_METHOD10_T(m, ...) GMOCK_METHOD10_(typename, , , m, __VA_ARGS__) #define MOCK_CONST_METHOD0_T(m, ...) \ GMOCK_METHOD0_(typename, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD1_T(m, ...) \ GMOCK_METHOD1_(typename, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD2_T(m, ...) \ GMOCK_METHOD2_(typename, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD3_T(m, ...) \ GMOCK_METHOD3_(typename, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD4_T(m, ...) \ GMOCK_METHOD4_(typename, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD5_T(m, ...) \ GMOCK_METHOD5_(typename, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD6_T(m, ...) \ GMOCK_METHOD6_(typename, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD7_T(m, ...) \ GMOCK_METHOD7_(typename, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD8_T(m, ...) \ GMOCK_METHOD8_(typename, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD9_T(m, ...) \ GMOCK_METHOD9_(typename, const, , m, __VA_ARGS__) #define MOCK_CONST_METHOD10_T(m, ...) \ GMOCK_METHOD10_(typename, const, , m, __VA_ARGS__) #define MOCK_METHOD0_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD0_(, , ct, m, __VA_ARGS__) #define MOCK_METHOD1_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD1_(, , ct, m, __VA_ARGS__) #define MOCK_METHOD2_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD2_(, , ct, m, __VA_ARGS__) #define MOCK_METHOD3_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD3_(, , ct, m, __VA_ARGS__) #define MOCK_METHOD4_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD4_(, , ct, m, __VA_ARGS__) #define MOCK_METHOD5_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD5_(, , ct, m, __VA_ARGS__) #define MOCK_METHOD6_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD6_(, , ct, m, __VA_ARGS__) #define MOCK_METHOD7_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD7_(, , ct, m, __VA_ARGS__) #define MOCK_METHOD8_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD8_(, , ct, m, __VA_ARGS__) #define MOCK_METHOD9_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD9_(, , ct, m, __VA_ARGS__) #define MOCK_METHOD10_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD10_(, , ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD0_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD0_(, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD1_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD1_(, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD2_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD2_(, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD3_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD3_(, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD4_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD4_(, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD5_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD5_(, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD6_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD6_(, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD7_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD7_(, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD8_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD8_(, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD9_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD9_(, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD10_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD10_(, const, ct, m, __VA_ARGS__) #define MOCK_METHOD0_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD0_(typename, , ct, m, __VA_ARGS__) #define MOCK_METHOD1_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD1_(typename, , ct, m, __VA_ARGS__) #define MOCK_METHOD2_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD2_(typename, , ct, m, __VA_ARGS__) #define MOCK_METHOD3_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD3_(typename, , ct, m, __VA_ARGS__) #define MOCK_METHOD4_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD4_(typename, , ct, m, __VA_ARGS__) #define MOCK_METHOD5_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD5_(typename, , ct, m, __VA_ARGS__) #define MOCK_METHOD6_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD6_(typename, , ct, m, __VA_ARGS__) #define MOCK_METHOD7_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD7_(typename, , ct, m, __VA_ARGS__) #define MOCK_METHOD8_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD8_(typename, , ct, m, __VA_ARGS__) #define MOCK_METHOD9_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD9_(typename, , ct, m, __VA_ARGS__) #define MOCK_METHOD10_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD10_(typename, , ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD0_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD0_(typename, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD1_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD1_(typename, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD2_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD2_(typename, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD3_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD3_(typename, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD4_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD4_(typename, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD5_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD5_(typename, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD6_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD6_(typename, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD7_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD7_(typename, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD8_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD8_(typename, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD9_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD9_(typename, const, ct, m, __VA_ARGS__) #define MOCK_CONST_METHOD10_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD10_(typename, const, ct, m, __VA_ARGS__) // A MockFunction class has one mock method whose type is F. It is // useful when you just want your test code to emit some messages and // have Google Mock verify the right messages are sent (and perhaps at // the right times). For example, if you are exercising code: // // Foo(1); // Foo(2); // Foo(3); // // and want to verify that Foo(1) and Foo(3) both invoke // mock.Bar("a"), but Foo(2) doesn't invoke anything, you can write: // // TEST(FooTest, InvokesBarCorrectly) { // MyMock mock; // MockFunction check; // { // InSequence s; // // EXPECT_CALL(mock, Bar("a")); // EXPECT_CALL(check, Call("1")); // EXPECT_CALL(check, Call("2")); // EXPECT_CALL(mock, Bar("a")); // } // Foo(1); // check.Call("1"); // Foo(2); // check.Call("2"); // Foo(3); // } // // The expectation spec says that the first Bar("a") must happen // before check point "1", the second Bar("a") must happen after check // point "2", and nothing should happen between the two check // points. The explicit check points make it easy to tell which // Bar("a") is called by which call to Foo(). // // MockFunction can also be used to exercise code that accepts // std::function callbacks. To do so, use AsStdFunction() method // to create std::function proxy forwarding to original object's Call. // Example: // // TEST(FooTest, RunsCallbackWithBarArgument) { // MockFunction callback; // EXPECT_CALL(callback, Call("bar")).WillOnce(Return(1)); // Foo(callback.AsStdFunction()); // } template class MockFunction; template class MockFunction { public: MockFunction() {} MOCK_METHOD0_T(Call, R()); #if GTEST_HAS_STD_FUNCTION_ std::function AsStdFunction() { return [this]() -> R { return this->Call(); }; } #endif // GTEST_HAS_STD_FUNCTION_ private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFunction); }; template class MockFunction { public: MockFunction() {} MOCK_METHOD1_T(Call, R(A0)); #if GTEST_HAS_STD_FUNCTION_ std::function AsStdFunction() { return [this](A0 a0) -> R { return this->Call(a0); }; } #endif // GTEST_HAS_STD_FUNCTION_ private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFunction); }; template class MockFunction { public: MockFunction() {} MOCK_METHOD2_T(Call, R(A0, A1)); #if GTEST_HAS_STD_FUNCTION_ std::function AsStdFunction() { return [this](A0 a0, A1 a1) -> R { return this->Call(a0, a1); }; } #endif // GTEST_HAS_STD_FUNCTION_ private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFunction); }; template class MockFunction { public: MockFunction() {} MOCK_METHOD3_T(Call, R(A0, A1, A2)); #if GTEST_HAS_STD_FUNCTION_ std::function AsStdFunction() { return [this](A0 a0, A1 a1, A2 a2) -> R { return this->Call(a0, a1, a2); }; } #endif // GTEST_HAS_STD_FUNCTION_ private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFunction); }; template class MockFunction { public: MockFunction() {} MOCK_METHOD4_T(Call, R(A0, A1, A2, A3)); #if GTEST_HAS_STD_FUNCTION_ std::function AsStdFunction() { return [this](A0 a0, A1 a1, A2 a2, A3 a3) -> R { return this->Call(a0, a1, a2, a3); }; } #endif // GTEST_HAS_STD_FUNCTION_ private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFunction); }; template class MockFunction { public: MockFunction() {} MOCK_METHOD5_T(Call, R(A0, A1, A2, A3, A4)); #if GTEST_HAS_STD_FUNCTION_ std::function AsStdFunction() { return [this](A0 a0, A1 a1, A2 a2, A3 a3, A4 a4) -> R { return this->Call(a0, a1, a2, a3, a4); }; } #endif // GTEST_HAS_STD_FUNCTION_ private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFunction); }; template class MockFunction { public: MockFunction() {} MOCK_METHOD6_T(Call, R(A0, A1, A2, A3, A4, A5)); #if GTEST_HAS_STD_FUNCTION_ std::function AsStdFunction() { return [this](A0 a0, A1 a1, A2 a2, A3 a3, A4 a4, A5 a5) -> R { return this->Call(a0, a1, a2, a3, a4, a5); }; } #endif // GTEST_HAS_STD_FUNCTION_ private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFunction); }; template class MockFunction { public: MockFunction() {} MOCK_METHOD7_T(Call, R(A0, A1, A2, A3, A4, A5, A6)); #if GTEST_HAS_STD_FUNCTION_ std::function AsStdFunction() { return [this](A0 a0, A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6) -> R { return this->Call(a0, a1, a2, a3, a4, a5, a6); }; } #endif // GTEST_HAS_STD_FUNCTION_ private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFunction); }; template class MockFunction { public: MockFunction() {} MOCK_METHOD8_T(Call, R(A0, A1, A2, A3, A4, A5, A6, A7)); #if GTEST_HAS_STD_FUNCTION_ std::function AsStdFunction() { return [this](A0 a0, A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7) -> R { return this->Call(a0, a1, a2, a3, a4, a5, a6, a7); }; } #endif // GTEST_HAS_STD_FUNCTION_ private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFunction); }; template class MockFunction { public: MockFunction() {} MOCK_METHOD9_T(Call, R(A0, A1, A2, A3, A4, A5, A6, A7, A8)); #if GTEST_HAS_STD_FUNCTION_ std::function AsStdFunction() { return [this](A0 a0, A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7, A8 a8) -> R { return this->Call(a0, a1, a2, a3, a4, a5, a6, a7, a8); }; } #endif // GTEST_HAS_STD_FUNCTION_ private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFunction); }; template class MockFunction { public: MockFunction() {} MOCK_METHOD10_T(Call, R(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9)); #if GTEST_HAS_STD_FUNCTION_ std::function AsStdFunction() { return [this](A0 a0, A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7, A8 a8, A9 a9) -> R { return this->Call(a0, a1, a2, a3, a4, a5, a6, a7, a8, a9); }; } #endif // GTEST_HAS_STD_FUNCTION_ private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFunction); }; } // namespace testing #endif // GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_FUNCTION_MOCKERS_H_ vendor/googletest/gtest-1.7.0/googlemock/include/gmock/gmock-generated-function-mockers.h.pump000066400000000000000000000221711300002025200326230ustar00rootroot00000000000000$$ -*- mode: c++; -*- $$ This is a Pump source file. Please use Pump to convert it to $$ gmock-generated-function-mockers.h. $$ $var n = 10 $$ The maximum arity we support. // Copyright 2007, Google Inc. // 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 Google Inc. 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. // // Author: wan@google.com (Zhanyong Wan) // Google Mock - a framework for writing C++ mock classes. // // This file implements function mockers of various arities. #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_FUNCTION_MOCKERS_H_ #define GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_FUNCTION_MOCKERS_H_ #include "gmock/gmock-spec-builders.h" #include "gmock/internal/gmock-internal-utils.h" #if GTEST_HAS_STD_FUNCTION_ # include #endif namespace testing { namespace internal { template class FunctionMockerBase; // Note: class FunctionMocker really belongs to the ::testing // namespace. However if we define it in ::testing, MSVC will // complain when classes in ::testing::internal declare it as a // friend class template. To workaround this compiler bug, we define // FunctionMocker in ::testing::internal and import it into ::testing. template class FunctionMocker; $range i 0..n $for i [[ $range j 1..i $var typename_As = [[$for j [[, typename A$j]]]] $var As = [[$for j, [[A$j]]]] $var as = [[$for j, [[a$j]]]] $var Aas = [[$for j, [[A$j a$j]]]] $var ms = [[$for j, [[m$j]]]] $var matchers = [[$for j, [[const Matcher& m$j]]]] template class FunctionMocker : public internal::FunctionMockerBase { public: typedef R F($As); typedef typename internal::Function::ArgumentTuple ArgumentTuple; MockSpec& With($matchers) { $if i >= 1 [[ this->current_spec().SetMatchers(::testing::make_tuple($ms)); ]] return this->current_spec(); } R Invoke($Aas) { // Even though gcc and MSVC don't enforce it, 'this->' is required // by the C++ standard [14.6.4] here, as the base class type is // dependent on the template argument (and thus shouldn't be // looked into when resolving InvokeWith). return this->InvokeWith(ArgumentTuple($as)); } }; ]] } // namespace internal // The style guide prohibits "using" statements in a namespace scope // inside a header file. However, the FunctionMocker class template // is meant to be defined in the ::testing namespace. The following // line is just a trick for working around a bug in MSVC 8.0, which // cannot handle it if we define FunctionMocker in ::testing. using internal::FunctionMocker; // GMOCK_RESULT_(tn, F) expands to the result type of function type F. // We define this as a variadic macro in case F contains unprotected // commas (the same reason that we use variadic macros in other places // in this file). // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_RESULT_(tn, ...) \ tn ::testing::internal::Function<__VA_ARGS__>::Result // The type of argument N of the given function type. // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_ARG_(tn, N, ...) \ tn ::testing::internal::Function<__VA_ARGS__>::Argument##N // The matcher type for argument N of the given function type. // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_MATCHER_(tn, N, ...) \ const ::testing::Matcher& // The variable for mocking the given method. // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_MOCKER_(arity, constness, Method) \ GTEST_CONCAT_TOKEN_(gmock##constness##arity##_##Method##_, __LINE__) $for i [[ $range j 1..i $var arg_as = [[$for j, \ [[GMOCK_ARG_(tn, $j, __VA_ARGS__) gmock_a$j]]]] $var as = [[$for j, [[gmock_a$j]]]] $var matcher_as = [[$for j, \ [[GMOCK_MATCHER_(tn, $j, __VA_ARGS__) gmock_a$j]]]] // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!! #define GMOCK_METHOD$i[[]]_(tn, constness, ct, Method, ...) \ GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \ $arg_as) constness { \ GTEST_COMPILE_ASSERT_((::testing::tuple_size< \ tn ::testing::internal::Function<__VA_ARGS__>::ArgumentTuple>::value == $i), \ this_method_does_not_take_$i[[]]_argument[[$if i != 1 [[s]]]]); \ GMOCK_MOCKER_($i, constness, Method).SetOwnerAndName(this, #Method); \ return GMOCK_MOCKER_($i, constness, Method).Invoke($as); \ } \ ::testing::MockSpec<__VA_ARGS__>& \ gmock_##Method($matcher_as) constness { \ GMOCK_MOCKER_($i, constness, Method).RegisterOwner(this); \ return GMOCK_MOCKER_($i, constness, Method).With($as); \ } \ mutable ::testing::FunctionMocker<__VA_ARGS__> GMOCK_MOCKER_($i, constness, Method) ]] $for i [[ #define MOCK_METHOD$i(m, ...) GMOCK_METHOD$i[[]]_(, , , m, __VA_ARGS__) ]] $for i [[ #define MOCK_CONST_METHOD$i(m, ...) GMOCK_METHOD$i[[]]_(, const, , m, __VA_ARGS__) ]] $for i [[ #define MOCK_METHOD$i[[]]_T(m, ...) GMOCK_METHOD$i[[]]_(typename, , , m, __VA_ARGS__) ]] $for i [[ #define MOCK_CONST_METHOD$i[[]]_T(m, ...) \ GMOCK_METHOD$i[[]]_(typename, const, , m, __VA_ARGS__) ]] $for i [[ #define MOCK_METHOD$i[[]]_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD$i[[]]_(, , ct, m, __VA_ARGS__) ]] $for i [[ #define MOCK_CONST_METHOD$i[[]]_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD$i[[]]_(, const, ct, m, __VA_ARGS__) ]] $for i [[ #define MOCK_METHOD$i[[]]_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD$i[[]]_(typename, , ct, m, __VA_ARGS__) ]] $for i [[ #define MOCK_CONST_METHOD$i[[]]_T_WITH_CALLTYPE(ct, m, ...) \ GMOCK_METHOD$i[[]]_(typename, const, ct, m, __VA_ARGS__) ]] // A MockFunction class has one mock method whose type is F. It is // useful when you just want your test code to emit some messages and // have Google Mock verify the right messages are sent (and perhaps at // the right times). For example, if you are exercising code: // // Foo(1); // Foo(2); // Foo(3); // // and want to verify that Foo(1) and Foo(3) both invoke // mock.Bar("a"), but Foo(2) doesn't invoke anything, you can write: // // TEST(FooTest, InvokesBarCorrectly) { // MyMock mock; // MockFunction check; // { // InSequence s; // // EXPECT_CALL(mock, Bar("a")); // EXPECT_CALL(check, Call("1")); // EXPECT_CALL(check, Call("2")); // EXPECT_CALL(mock, Bar("a")); // } // Foo(1); // check.Call("1"); // Foo(2); // check.Call("2"); // Foo(3); // } // // The expectation spec says that the first Bar("a") must happen // before check point "1", the second Bar("a") must happen after check // point "2", and nothing should happen between the two check // points. The explicit check points make it easy to tell which // Bar("a") is called by which call to Foo(). // // MockFunction can also be used to exercise code that accepts // std::function callbacks. To do so, use AsStdFunction() method // to create std::function proxy forwarding to original object's Call. // Example: // // TEST(FooTest, RunsCallbackWithBarArgument) { // MockFunction callback; // EXPECT_CALL(callback, Call("bar")).WillOnce(Return(1)); // Foo(callback.AsStdFunction()); // } template class MockFunction; $for i [[ $range j 0..i-1 $var ArgTypes = [[$for j, [[A$j]]]] $var ArgNames = [[$for j, [[a$j]]]] $var ArgDecls = [[$for j, [[A$j a$j]]]] template class MockFunction { public: MockFunction() {} MOCK_METHOD$i[[]]_T(Call, R($ArgTypes)); #if GTEST_HAS_STD_FUNCTION_ std::function AsStdFunction() { return [this]($ArgDecls) -> R { return this->Call($ArgNames); }; } #endif // GTEST_HAS_STD_FUNCTION_ private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFunction); }; ]] } // namespace testing #endif // GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_FUNCTION_MOCKERS_H_ vendor/googletest/gtest-1.7.0/googlemock/include/gmock/gmock-generated-matchers.h000066400000000000000000002504051300002025200301660ustar00rootroot00000000000000// This file was GENERATED by command: // pump.py gmock-generated-matchers.h.pump // DO NOT EDIT BY HAND!!! // Copyright 2008, Google Inc. // 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 Google Inc. 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. // Google Mock - a framework for writing C++ mock classes. // // This file implements some commonly used variadic matchers. #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_MATCHERS_H_ #define GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_MATCHERS_H_ #include #include #include #include #include "gmock/gmock-matchers.h" namespace testing { namespace internal { // The type of the i-th (0-based) field of Tuple. #define GMOCK_FIELD_TYPE_(Tuple, i) \ typename ::testing::tuple_element::type // TupleFields is for selecting fields from a // tuple of type Tuple. It has two members: // // type: a tuple type whose i-th field is the ki-th field of Tuple. // GetSelectedFields(t): returns fields k0, ..., and kn of t as a tuple. // // For example, in class TupleFields, 2, 0>, we have: // // type is tuple, and // GetSelectedFields(make_tuple(true, 'a', 42)) is (42, true). template class TupleFields; // This generic version is used when there are 10 selectors. template class TupleFields { public: typedef ::testing::tuple type; static type GetSelectedFields(const Tuple& t) { return type(get(t), get(t), get(t), get(t), get(t), get(t), get(t), get(t), get(t), get(t)); } }; // The following specialization is used for 0 ~ 9 selectors. template class TupleFields { public: typedef ::testing::tuple<> type; static type GetSelectedFields(const Tuple& /* t */) { return type(); } }; template class TupleFields { public: typedef ::testing::tuple type; static type GetSelectedFields(const Tuple& t) { return type(get(t)); } }; template class TupleFields { public: typedef ::testing::tuple type; static type GetSelectedFields(const Tuple& t) { return type(get(t), get(t)); } }; template class TupleFields { public: typedef ::testing::tuple type; static type GetSelectedFields(const Tuple& t) { return type(get(t), get(t), get(t)); } }; template class TupleFields { public: typedef ::testing::tuple type; static type GetSelectedFields(const Tuple& t) { return type(get(t), get(t), get(t), get(t)); } }; template class TupleFields { public: typedef ::testing::tuple type; static type GetSelectedFields(const Tuple& t) { return type(get(t), get(t), get(t), get(t), get(t)); } }; template class TupleFields { public: typedef ::testing::tuple type; static type GetSelectedFields(const Tuple& t) { return type(get(t), get(t), get(t), get(t), get(t), get(t)); } }; template class TupleFields { public: typedef ::testing::tuple type; static type GetSelectedFields(const Tuple& t) { return type(get(t), get(t), get(t), get(t), get(t), get(t), get(t)); } }; template class TupleFields { public: typedef ::testing::tuple type; static type GetSelectedFields(const Tuple& t) { return type(get(t), get(t), get(t), get(t), get(t), get(t), get(t), get(t)); } }; template class TupleFields { public: typedef ::testing::tuple type; static type GetSelectedFields(const Tuple& t) { return type(get(t), get(t), get(t), get(t), get(t), get(t), get(t), get(t), get(t)); } }; #undef GMOCK_FIELD_TYPE_ // Implements the Args() matcher. template class ArgsMatcherImpl : public MatcherInterface { public: // ArgsTuple may have top-level const or reference modifiers. typedef GTEST_REMOVE_REFERENCE_AND_CONST_(ArgsTuple) RawArgsTuple; typedef typename internal::TupleFields::type SelectedArgs; typedef Matcher MonomorphicInnerMatcher; template explicit ArgsMatcherImpl(const InnerMatcher& inner_matcher) : inner_matcher_(SafeMatcherCast(inner_matcher)) {} virtual bool MatchAndExplain(ArgsTuple args, MatchResultListener* listener) const { const SelectedArgs& selected_args = GetSelectedArgs(args); if (!listener->IsInterested()) return inner_matcher_.Matches(selected_args); PrintIndices(listener->stream()); *listener << "are " << PrintToString(selected_args); StringMatchResultListener inner_listener; const bool match = inner_matcher_.MatchAndExplain(selected_args, &inner_listener); PrintIfNotEmpty(inner_listener.str(), listener->stream()); return match; } virtual void DescribeTo(::std::ostream* os) const { *os << "are a tuple "; PrintIndices(os); inner_matcher_.DescribeTo(os); } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "are a tuple "; PrintIndices(os); inner_matcher_.DescribeNegationTo(os); } private: static SelectedArgs GetSelectedArgs(ArgsTuple args) { return TupleFields::GetSelectedFields(args); } // Prints the indices of the selected fields. static void PrintIndices(::std::ostream* os) { *os << "whose fields ("; const int indices[10] = { k0, k1, k2, k3, k4, k5, k6, k7, k8, k9 }; for (int i = 0; i < 10; i++) { if (indices[i] < 0) break; if (i >= 1) *os << ", "; *os << "#" << indices[i]; } *os << ") "; } const MonomorphicInnerMatcher inner_matcher_; GTEST_DISALLOW_ASSIGN_(ArgsMatcherImpl); }; template class ArgsMatcher { public: explicit ArgsMatcher(const InnerMatcher& inner_matcher) : inner_matcher_(inner_matcher) {} template operator Matcher() const { return MakeMatcher(new ArgsMatcherImpl(inner_matcher_)); } private: const InnerMatcher inner_matcher_; GTEST_DISALLOW_ASSIGN_(ArgsMatcher); }; // A set of metafunctions for computing the result type of AllOf. // AllOf(m1, ..., mN) returns // AllOfResultN::type. // Although AllOf isn't defined for one argument, AllOfResult1 is defined // to simplify the implementation. template struct AllOfResult1 { typedef M1 type; }; template struct AllOfResult2 { typedef BothOfMatcher< typename AllOfResult1::type, typename AllOfResult1::type > type; }; template struct AllOfResult3 { typedef BothOfMatcher< typename AllOfResult1::type, typename AllOfResult2::type > type; }; template struct AllOfResult4 { typedef BothOfMatcher< typename AllOfResult2::type, typename AllOfResult2::type > type; }; template struct AllOfResult5 { typedef BothOfMatcher< typename AllOfResult2::type, typename AllOfResult3::type > type; }; template struct AllOfResult6 { typedef BothOfMatcher< typename AllOfResult3::type, typename AllOfResult3::type > type; }; template struct AllOfResult7 { typedef BothOfMatcher< typename AllOfResult3::type, typename AllOfResult4::type > type; }; template struct AllOfResult8 { typedef BothOfMatcher< typename AllOfResult4::type, typename AllOfResult4::type > type; }; template struct AllOfResult9 { typedef BothOfMatcher< typename AllOfResult4::type, typename AllOfResult5::type > type; }; template struct AllOfResult10 { typedef BothOfMatcher< typename AllOfResult5::type, typename AllOfResult5::type > type; }; // A set of metafunctions for computing the result type of AnyOf. // AnyOf(m1, ..., mN) returns // AnyOfResultN::type. // Although AnyOf isn't defined for one argument, AnyOfResult1 is defined // to simplify the implementation. template struct AnyOfResult1 { typedef M1 type; }; template struct AnyOfResult2 { typedef EitherOfMatcher< typename AnyOfResult1::type, typename AnyOfResult1::type > type; }; template struct AnyOfResult3 { typedef EitherOfMatcher< typename AnyOfResult1::type, typename AnyOfResult2::type > type; }; template struct AnyOfResult4 { typedef EitherOfMatcher< typename AnyOfResult2::type, typename AnyOfResult2::type > type; }; template struct AnyOfResult5 { typedef EitherOfMatcher< typename AnyOfResult2::type, typename AnyOfResult3::type > type; }; template struct AnyOfResult6 { typedef EitherOfMatcher< typename AnyOfResult3::type, typename AnyOfResult3::type > type; }; template struct AnyOfResult7 { typedef EitherOfMatcher< typename AnyOfResult3::type, typename AnyOfResult4::type > type; }; template struct AnyOfResult8 { typedef EitherOfMatcher< typename AnyOfResult4::type, typename AnyOfResult4::type > type; }; template struct AnyOfResult9 { typedef EitherOfMatcher< typename AnyOfResult4::type, typename AnyOfResult5::type > type; }; template struct AnyOfResult10 { typedef EitherOfMatcher< typename AnyOfResult5::type, typename AnyOfResult5::type > type; }; } // namespace internal // Args(a_matcher) matches a tuple if the selected // fields of it matches a_matcher. C++ doesn't support default // arguments for function templates, so we have to overload it. template inline internal::ArgsMatcher Args(const InnerMatcher& matcher) { return internal::ArgsMatcher(matcher); } template inline internal::ArgsMatcher Args(const InnerMatcher& matcher) { return internal::ArgsMatcher(matcher); } template inline internal::ArgsMatcher Args(const InnerMatcher& matcher) { return internal::ArgsMatcher(matcher); } template inline internal::ArgsMatcher Args(const InnerMatcher& matcher) { return internal::ArgsMatcher(matcher); } template inline internal::ArgsMatcher Args(const InnerMatcher& matcher) { return internal::ArgsMatcher(matcher); } template inline internal::ArgsMatcher Args(const InnerMatcher& matcher) { return internal::ArgsMatcher(matcher); } template inline internal::ArgsMatcher Args(const InnerMatcher& matcher) { return internal::ArgsMatcher(matcher); } template inline internal::ArgsMatcher Args(const InnerMatcher& matcher) { return internal::ArgsMatcher(matcher); } template inline internal::ArgsMatcher Args(const InnerMatcher& matcher) { return internal::ArgsMatcher(matcher); } template inline internal::ArgsMatcher Args(const InnerMatcher& matcher) { return internal::ArgsMatcher(matcher); } template inline internal::ArgsMatcher Args(const InnerMatcher& matcher) { return internal::ArgsMatcher(matcher); } // ElementsAre(e_1, e_2, ... e_n) matches an STL-style container with // n elements, where the i-th element in the container must // match the i-th argument in the list. Each argument of // ElementsAre() can be either a value or a matcher. We support up to // 10 arguments. // // The use of DecayArray in the implementation allows ElementsAre() // to accept string literals, whose type is const char[N], but we // want to treat them as const char*. // // NOTE: Since ElementsAre() cares about the order of the elements, it // must not be used with containers whose elements's order is // undefined (e.g. hash_map). inline internal::ElementsAreMatcher< ::testing::tuple<> > ElementsAre() { typedef ::testing::tuple<> Args; return internal::ElementsAreMatcher(Args()); } template inline internal::ElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type> > ElementsAre(const T1& e1) { typedef ::testing::tuple< typename internal::DecayArray::type> Args; return internal::ElementsAreMatcher(Args(e1)); } template inline internal::ElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type> > ElementsAre(const T1& e1, const T2& e2) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::ElementsAreMatcher(Args(e1, e2)); } template inline internal::ElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > ElementsAre(const T1& e1, const T2& e2, const T3& e3) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::ElementsAreMatcher(Args(e1, e2, e3)); } template inline internal::ElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > ElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::ElementsAreMatcher(Args(e1, e2, e3, e4)); } template inline internal::ElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > ElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4, const T5& e5) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::ElementsAreMatcher(Args(e1, e2, e3, e4, e5)); } template inline internal::ElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > ElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4, const T5& e5, const T6& e6) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::ElementsAreMatcher(Args(e1, e2, e3, e4, e5, e6)); } template inline internal::ElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > ElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4, const T5& e5, const T6& e6, const T7& e7) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::ElementsAreMatcher(Args(e1, e2, e3, e4, e5, e6, e7)); } template inline internal::ElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > ElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4, const T5& e5, const T6& e6, const T7& e7, const T8& e8) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::ElementsAreMatcher(Args(e1, e2, e3, e4, e5, e6, e7, e8)); } template inline internal::ElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > ElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4, const T5& e5, const T6& e6, const T7& e7, const T8& e8, const T9& e9) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::ElementsAreMatcher(Args(e1, e2, e3, e4, e5, e6, e7, e8, e9)); } template inline internal::ElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > ElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4, const T5& e5, const T6& e6, const T7& e7, const T8& e8, const T9& e9, const T10& e10) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::ElementsAreMatcher(Args(e1, e2, e3, e4, e5, e6, e7, e8, e9, e10)); } // UnorderedElementsAre(e_1, e_2, ..., e_n) is an ElementsAre extension // that matches n elements in any order. We support up to n=10 arguments. inline internal::UnorderedElementsAreMatcher< ::testing::tuple<> > UnorderedElementsAre() { typedef ::testing::tuple<> Args; return internal::UnorderedElementsAreMatcher(Args()); } template inline internal::UnorderedElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type> > UnorderedElementsAre(const T1& e1) { typedef ::testing::tuple< typename internal::DecayArray::type> Args; return internal::UnorderedElementsAreMatcher(Args(e1)); } template inline internal::UnorderedElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type> > UnorderedElementsAre(const T1& e1, const T2& e2) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::UnorderedElementsAreMatcher(Args(e1, e2)); } template inline internal::UnorderedElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > UnorderedElementsAre(const T1& e1, const T2& e2, const T3& e3) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::UnorderedElementsAreMatcher(Args(e1, e2, e3)); } template inline internal::UnorderedElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > UnorderedElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::UnorderedElementsAreMatcher(Args(e1, e2, e3, e4)); } template inline internal::UnorderedElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > UnorderedElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4, const T5& e5) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::UnorderedElementsAreMatcher(Args(e1, e2, e3, e4, e5)); } template inline internal::UnorderedElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > UnorderedElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4, const T5& e5, const T6& e6) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::UnorderedElementsAreMatcher(Args(e1, e2, e3, e4, e5, e6)); } template inline internal::UnorderedElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > UnorderedElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4, const T5& e5, const T6& e6, const T7& e7) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::UnorderedElementsAreMatcher(Args(e1, e2, e3, e4, e5, e6, e7)); } template inline internal::UnorderedElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > UnorderedElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4, const T5& e5, const T6& e6, const T7& e7, const T8& e8) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::UnorderedElementsAreMatcher(Args(e1, e2, e3, e4, e5, e6, e7, e8)); } template inline internal::UnorderedElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > UnorderedElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4, const T5& e5, const T6& e6, const T7& e7, const T8& e8, const T9& e9) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::UnorderedElementsAreMatcher(Args(e1, e2, e3, e4, e5, e6, e7, e8, e9)); } template inline internal::UnorderedElementsAreMatcher< ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> > UnorderedElementsAre(const T1& e1, const T2& e2, const T3& e3, const T4& e4, const T5& e5, const T6& e6, const T7& e7, const T8& e8, const T9& e9, const T10& e10) { typedef ::testing::tuple< typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type, typename internal::DecayArray::type> Args; return internal::UnorderedElementsAreMatcher(Args(e1, e2, e3, e4, e5, e6, e7, e8, e9, e10)); } // AllOf(m1, m2, ..., mk) matches any value that matches all of the given // sub-matchers. AllOf is called fully qualified to prevent ADL from firing. template inline typename internal::AllOfResult2::type AllOf(M1 m1, M2 m2) { return typename internal::AllOfResult2::type( m1, m2); } template inline typename internal::AllOfResult3::type AllOf(M1 m1, M2 m2, M3 m3) { return typename internal::AllOfResult3::type( m1, ::testing::AllOf(m2, m3)); } template inline typename internal::AllOfResult4::type AllOf(M1 m1, M2 m2, M3 m3, M4 m4) { return typename internal::AllOfResult4::type( ::testing::AllOf(m1, m2), ::testing::AllOf(m3, m4)); } template inline typename internal::AllOfResult5::type AllOf(M1 m1, M2 m2, M3 m3, M4 m4, M5 m5) { return typename internal::AllOfResult5::type( ::testing::AllOf(m1, m2), ::testing::AllOf(m3, m4, m5)); } template inline typename internal::AllOfResult6::type AllOf(M1 m1, M2 m2, M3 m3, M4 m4, M5 m5, M6 m6) { return typename internal::AllOfResult6::type( ::testing::AllOf(m1, m2, m3), ::testing::AllOf(m4, m5, m6)); } template inline typename internal::AllOfResult7::type AllOf(M1 m1, M2 m2, M3 m3, M4 m4, M5 m5, M6 m6, M7 m7) { return typename internal::AllOfResult7::type( ::testing::AllOf(m1, m2, m3), ::testing::AllOf(m4, m5, m6, m7)); } template inline typename internal::AllOfResult8::type AllOf(M1 m1, M2 m2, M3 m3, M4 m4, M5 m5, M6 m6, M7 m7, M8 m8) { return typename internal::AllOfResult8::type( ::testing::AllOf(m1, m2, m3, m4), ::testing::AllOf(m5, m6, m7, m8)); } template inline typename internal::AllOfResult9::type AllOf(M1 m1, M2 m2, M3 m3, M4 m4, M5 m5, M6 m6, M7 m7, M8 m8, M9 m9) { return typename internal::AllOfResult9::type( ::testing::AllOf(m1, m2, m3, m4), ::testing::AllOf(m5, m6, m7, m8, m9)); } template inline typename internal::AllOfResult10::type AllOf(M1 m1, M2 m2, M3 m3, M4 m4, M5 m5, M6 m6, M7 m7, M8 m8, M9 m9, M10 m10) { return typename internal::AllOfResult10::type( ::testing::AllOf(m1, m2, m3, m4, m5), ::testing::AllOf(m6, m7, m8, m9, m10)); } // AnyOf(m1, m2, ..., mk) matches any value that matches any of the given // sub-matchers. AnyOf is called fully qualified to prevent ADL from firing. template inline typename internal::AnyOfResult2::type AnyOf(M1 m1, M2 m2) { return typename internal::AnyOfResult2::type( m1, m2); } template inline typename internal::AnyOfResult3::type AnyOf(M1 m1, M2 m2, M3 m3) { return typename internal::AnyOfResult3::type( m1, ::testing::AnyOf(m2, m3)); } template inline typename internal::AnyOfResult4::type AnyOf(M1 m1, M2 m2, M3 m3, M4 m4) { return typename internal::AnyOfResult4::type( ::testing::AnyOf(m1, m2), ::testing::AnyOf(m3, m4)); } template inline typename internal::AnyOfResult5::type AnyOf(M1 m1, M2 m2, M3 m3, M4 m4, M5 m5) { return typename internal::AnyOfResult5::type( ::testing::AnyOf(m1, m2), ::testing::AnyOf(m3, m4, m5)); } template inline typename internal::AnyOfResult6::type AnyOf(M1 m1, M2 m2, M3 m3, M4 m4, M5 m5, M6 m6) { return typename internal::AnyOfResult6::type( ::testing::AnyOf(m1, m2, m3), ::testing::AnyOf(m4, m5, m6)); } template inline typename internal::AnyOfResult7::type AnyOf(M1 m1, M2 m2, M3 m3, M4 m4, M5 m5, M6 m6, M7 m7) { return typename internal::AnyOfResult7::type( ::testing::AnyOf(m1, m2, m3), ::testing::AnyOf(m4, m5, m6, m7)); } template inline typename internal::AnyOfResult8::type AnyOf(M1 m1, M2 m2, M3 m3, M4 m4, M5 m5, M6 m6, M7 m7, M8 m8) { return typename internal::AnyOfResult8::type( ::testing::AnyOf(m1, m2, m3, m4), ::testing::AnyOf(m5, m6, m7, m8)); } template inline typename internal::AnyOfResult9::type AnyOf(M1 m1, M2 m2, M3 m3, M4 m4, M5 m5, M6 m6, M7 m7, M8 m8, M9 m9) { return typename internal::AnyOfResult9::type( ::testing::AnyOf(m1, m2, m3, m4), ::testing::AnyOf(m5, m6, m7, m8, m9)); } template inline typename internal::AnyOfResult10::type AnyOf(M1 m1, M2 m2, M3 m3, M4 m4, M5 m5, M6 m6, M7 m7, M8 m8, M9 m9, M10 m10) { return typename internal::AnyOfResult10::type( ::testing::AnyOf(m1, m2, m3, m4, m5), ::testing::AnyOf(m6, m7, m8, m9, m10)); } } // namespace testing // The MATCHER* family of macros can be used in a namespace scope to // define custom matchers easily. // // Basic Usage // =========== // // The syntax // // MATCHER(name, description_string) { statements; } // // defines a matcher with the given name that executes the statements, // which must return a bool to indicate if the match succeeds. Inside // the statements, you can refer to the value being matched by 'arg', // and refer to its type by 'arg_type'. // // The description string documents what the matcher does, and is used // to generate the failure message when the match fails. Since a // MATCHER() is usually defined in a header file shared by multiple // C++ source files, we require the description to be a C-string // literal to avoid possible side effects. It can be empty, in which // case we'll use the sequence of words in the matcher name as the // description. // // For example: // // MATCHER(IsEven, "") { return (arg % 2) == 0; } // // allows you to write // // // Expects mock_foo.Bar(n) to be called where n is even. // EXPECT_CALL(mock_foo, Bar(IsEven())); // // or, // // // Verifies that the value of some_expression is even. // EXPECT_THAT(some_expression, IsEven()); // // If the above assertion fails, it will print something like: // // Value of: some_expression // Expected: is even // Actual: 7 // // where the description "is even" is automatically calculated from the // matcher name IsEven. // // Argument Type // ============= // // Note that the type of the value being matched (arg_type) is // determined by the context in which you use the matcher and is // supplied to you by the compiler, so you don't need to worry about // declaring it (nor can you). This allows the matcher to be // polymorphic. For example, IsEven() can be used to match any type // where the value of "(arg % 2) == 0" can be implicitly converted to // a bool. In the "Bar(IsEven())" example above, if method Bar() // takes an int, 'arg_type' will be int; if it takes an unsigned long, // 'arg_type' will be unsigned long; and so on. // // Parameterizing Matchers // ======================= // // Sometimes you'll want to parameterize the matcher. For that you // can use another macro: // // MATCHER_P(name, param_name, description_string) { statements; } // // For example: // // MATCHER_P(HasAbsoluteValue, value, "") { return abs(arg) == value; } // // will allow you to write: // // EXPECT_THAT(Blah("a"), HasAbsoluteValue(n)); // // which may lead to this message (assuming n is 10): // // Value of: Blah("a") // Expected: has absolute value 10 // Actual: -9 // // Note that both the matcher description and its parameter are // printed, making the message human-friendly. // // In the matcher definition body, you can write 'foo_type' to // reference the type of a parameter named 'foo'. For example, in the // body of MATCHER_P(HasAbsoluteValue, value) above, you can write // 'value_type' to refer to the type of 'value'. // // We also provide MATCHER_P2, MATCHER_P3, ..., up to MATCHER_P10 to // support multi-parameter matchers. // // Describing Parameterized Matchers // ================================= // // The last argument to MATCHER*() is a string-typed expression. The // expression can reference all of the matcher's parameters and a // special bool-typed variable named 'negation'. When 'negation' is // false, the expression should evaluate to the matcher's description; // otherwise it should evaluate to the description of the negation of // the matcher. For example, // // using testing::PrintToString; // // MATCHER_P2(InClosedRange, low, hi, // string(negation ? "is not" : "is") + " in range [" + // PrintToString(low) + ", " + PrintToString(hi) + "]") { // return low <= arg && arg <= hi; // } // ... // EXPECT_THAT(3, InClosedRange(4, 6)); // EXPECT_THAT(3, Not(InClosedRange(2, 4))); // // would generate two failures that contain the text: // // Expected: is in range [4, 6] // ... // Expected: is not in range [2, 4] // // If you specify "" as the description, the failure message will // contain the sequence of words in the matcher name followed by the // parameter values printed as a tuple. For example, // // MATCHER_P2(InClosedRange, low, hi, "") { ... } // ... // EXPECT_THAT(3, InClosedRange(4, 6)); // EXPECT_THAT(3, Not(InClosedRange(2, 4))); // // would generate two failures that contain the text: // // Expected: in closed range (4, 6) // ... // Expected: not (in closed range (2, 4)) // // Types of Matcher Parameters // =========================== // // For the purpose of typing, you can view // // MATCHER_Pk(Foo, p1, ..., pk, description_string) { ... } // // as shorthand for // // template // FooMatcherPk // Foo(p1_type p1, ..., pk_type pk) { ... } // // When you write Foo(v1, ..., vk), the compiler infers the types of // the parameters v1, ..., and vk for you. If you are not happy with // the result of the type inference, you can specify the types by // explicitly instantiating the template, as in Foo(5, // false). As said earlier, you don't get to (or need to) specify // 'arg_type' as that's determined by the context in which the matcher // is used. You can assign the result of expression Foo(p1, ..., pk) // to a variable of type FooMatcherPk. This // can be useful when composing matchers. // // While you can instantiate a matcher template with reference types, // passing the parameters by pointer usually makes your code more // readable. If, however, you still want to pass a parameter by // reference, be aware that in the failure message generated by the // matcher you will see the value of the referenced object but not its // address. // // Explaining Match Results // ======================== // // Sometimes the matcher description alone isn't enough to explain why // the match has failed or succeeded. For example, when expecting a // long string, it can be very helpful to also print the diff between // the expected string and the actual one. To achieve that, you can // optionally stream additional information to a special variable // named result_listener, whose type is a pointer to class // MatchResultListener: // // MATCHER_P(EqualsLongString, str, "") { // if (arg == str) return true; // // *result_listener << "the difference: " /// << DiffStrings(str, arg); // return false; // } // // Overloading Matchers // ==================== // // You can overload matchers with different numbers of parameters: // // MATCHER_P(Blah, a, description_string1) { ... } // MATCHER_P2(Blah, a, b, description_string2) { ... } // // Caveats // ======= // // When defining a new matcher, you should also consider implementing // MatcherInterface or using MakePolymorphicMatcher(). These // approaches require more work than the MATCHER* macros, but also // give you more control on the types of the value being matched and // the matcher parameters, which may leads to better compiler error // messages when the matcher is used wrong. They also allow // overloading matchers based on parameter types (as opposed to just // based on the number of parameters). // // MATCHER*() can only be used in a namespace scope. The reason is // that C++ doesn't yet allow function-local types to be used to // instantiate templates. The up-coming C++0x standard will fix this. // Once that's done, we'll consider supporting using MATCHER*() inside // a function. // // More Information // ================ // // To learn more about using these macros, please search for 'MATCHER' // on http://code.google.com/p/googlemock/wiki/CookBook. #define MATCHER(name, description)\ class name##Matcher {\ public:\ template \ class gmock_Impl : public ::testing::MatcherInterface {\ public:\ gmock_Impl()\ {}\ virtual bool MatchAndExplain(\ arg_type arg, ::testing::MatchResultListener* result_listener) const;\ virtual void DescribeTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(false);\ }\ virtual void DescribeNegationTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(true);\ }\ private:\ ::testing::internal::string FormatDescription(bool negation) const {\ const ::testing::internal::string gmock_description = (description);\ if (!gmock_description.empty())\ return gmock_description;\ return ::testing::internal::FormatMatcherDescription(\ negation, #name, \ ::testing::internal::UniversalTersePrintTupleFieldsToStrings(\ ::testing::tuple<>()));\ }\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template \ operator ::testing::Matcher() const {\ return ::testing::Matcher(\ new gmock_Impl());\ }\ name##Matcher() {\ }\ private:\ GTEST_DISALLOW_ASSIGN_(name##Matcher);\ };\ inline name##Matcher name() {\ return name##Matcher();\ }\ template \ bool name##Matcher::gmock_Impl::MatchAndExplain(\ arg_type arg, \ ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_)\ const #define MATCHER_P(name, p0, description)\ template \ class name##MatcherP {\ public:\ template \ class gmock_Impl : public ::testing::MatcherInterface {\ public:\ explicit gmock_Impl(p0##_type gmock_p0)\ : p0(gmock_p0) {}\ virtual bool MatchAndExplain(\ arg_type arg, ::testing::MatchResultListener* result_listener) const;\ virtual void DescribeTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(false);\ }\ virtual void DescribeNegationTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(true);\ }\ p0##_type p0;\ private:\ ::testing::internal::string FormatDescription(bool negation) const {\ const ::testing::internal::string gmock_description = (description);\ if (!gmock_description.empty())\ return gmock_description;\ return ::testing::internal::FormatMatcherDescription(\ negation, #name, \ ::testing::internal::UniversalTersePrintTupleFieldsToStrings(\ ::testing::tuple(p0)));\ }\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template \ operator ::testing::Matcher() const {\ return ::testing::Matcher(\ new gmock_Impl(p0));\ }\ explicit name##MatcherP(p0##_type gmock_p0) : p0(gmock_p0) {\ }\ p0##_type p0;\ private:\ GTEST_DISALLOW_ASSIGN_(name##MatcherP);\ };\ template \ inline name##MatcherP name(p0##_type p0) {\ return name##MatcherP(p0);\ }\ template \ template \ bool name##MatcherP::gmock_Impl::MatchAndExplain(\ arg_type arg, \ ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_)\ const #define MATCHER_P2(name, p0, p1, description)\ template \ class name##MatcherP2 {\ public:\ template \ class gmock_Impl : public ::testing::MatcherInterface {\ public:\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1)\ : p0(gmock_p0), p1(gmock_p1) {}\ virtual bool MatchAndExplain(\ arg_type arg, ::testing::MatchResultListener* result_listener) const;\ virtual void DescribeTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(false);\ }\ virtual void DescribeNegationTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(true);\ }\ p0##_type p0;\ p1##_type p1;\ private:\ ::testing::internal::string FormatDescription(bool negation) const {\ const ::testing::internal::string gmock_description = (description);\ if (!gmock_description.empty())\ return gmock_description;\ return ::testing::internal::FormatMatcherDescription(\ negation, #name, \ ::testing::internal::UniversalTersePrintTupleFieldsToStrings(\ ::testing::tuple(p0, p1)));\ }\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template \ operator ::testing::Matcher() const {\ return ::testing::Matcher(\ new gmock_Impl(p0, p1));\ }\ name##MatcherP2(p0##_type gmock_p0, p1##_type gmock_p1) : p0(gmock_p0), \ p1(gmock_p1) {\ }\ p0##_type p0;\ p1##_type p1;\ private:\ GTEST_DISALLOW_ASSIGN_(name##MatcherP2);\ };\ template \ inline name##MatcherP2 name(p0##_type p0, \ p1##_type p1) {\ return name##MatcherP2(p0, p1);\ }\ template \ template \ bool name##MatcherP2::gmock_Impl::MatchAndExplain(\ arg_type arg, \ ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_)\ const #define MATCHER_P3(name, p0, p1, p2, description)\ template \ class name##MatcherP3 {\ public:\ template \ class gmock_Impl : public ::testing::MatcherInterface {\ public:\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2)\ : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2) {}\ virtual bool MatchAndExplain(\ arg_type arg, ::testing::MatchResultListener* result_listener) const;\ virtual void DescribeTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(false);\ }\ virtual void DescribeNegationTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(true);\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ private:\ ::testing::internal::string FormatDescription(bool negation) const {\ const ::testing::internal::string gmock_description = (description);\ if (!gmock_description.empty())\ return gmock_description;\ return ::testing::internal::FormatMatcherDescription(\ negation, #name, \ ::testing::internal::UniversalTersePrintTupleFieldsToStrings(\ ::testing::tuple(p0, p1, \ p2)));\ }\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template \ operator ::testing::Matcher() const {\ return ::testing::Matcher(\ new gmock_Impl(p0, p1, p2));\ }\ name##MatcherP3(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2) {\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ private:\ GTEST_DISALLOW_ASSIGN_(name##MatcherP3);\ };\ template \ inline name##MatcherP3 name(p0##_type p0, \ p1##_type p1, p2##_type p2) {\ return name##MatcherP3(p0, p1, p2);\ }\ template \ template \ bool name##MatcherP3::gmock_Impl::MatchAndExplain(\ arg_type arg, \ ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_)\ const #define MATCHER_P4(name, p0, p1, p2, p3, description)\ template \ class name##MatcherP4 {\ public:\ template \ class gmock_Impl : public ::testing::MatcherInterface {\ public:\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3)\ : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), p3(gmock_p3) {}\ virtual bool MatchAndExplain(\ arg_type arg, ::testing::MatchResultListener* result_listener) const;\ virtual void DescribeTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(false);\ }\ virtual void DescribeNegationTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(true);\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ private:\ ::testing::internal::string FormatDescription(bool negation) const {\ const ::testing::internal::string gmock_description = (description);\ if (!gmock_description.empty())\ return gmock_description;\ return ::testing::internal::FormatMatcherDescription(\ negation, #name, \ ::testing::internal::UniversalTersePrintTupleFieldsToStrings(\ ::testing::tuple(p0, p1, p2, p3)));\ }\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template \ operator ::testing::Matcher() const {\ return ::testing::Matcher(\ new gmock_Impl(p0, p1, p2, p3));\ }\ name##MatcherP4(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3) : p0(gmock_p0), p1(gmock_p1), \ p2(gmock_p2), p3(gmock_p3) {\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ private:\ GTEST_DISALLOW_ASSIGN_(name##MatcherP4);\ };\ template \ inline name##MatcherP4 name(p0##_type p0, p1##_type p1, p2##_type p2, \ p3##_type p3) {\ return name##MatcherP4(p0, \ p1, p2, p3);\ }\ template \ template \ bool name##MatcherP4::gmock_Impl::MatchAndExplain(\ arg_type arg, \ ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_)\ const #define MATCHER_P5(name, p0, p1, p2, p3, p4, description)\ template \ class name##MatcherP5 {\ public:\ template \ class gmock_Impl : public ::testing::MatcherInterface {\ public:\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4)\ : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), p3(gmock_p3), \ p4(gmock_p4) {}\ virtual bool MatchAndExplain(\ arg_type arg, ::testing::MatchResultListener* result_listener) const;\ virtual void DescribeTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(false);\ }\ virtual void DescribeNegationTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(true);\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ private:\ ::testing::internal::string FormatDescription(bool negation) const {\ const ::testing::internal::string gmock_description = (description);\ if (!gmock_description.empty())\ return gmock_description;\ return ::testing::internal::FormatMatcherDescription(\ negation, #name, \ ::testing::internal::UniversalTersePrintTupleFieldsToStrings(\ ::testing::tuple(p0, p1, p2, p3, p4)));\ }\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template \ operator ::testing::Matcher() const {\ return ::testing::Matcher(\ new gmock_Impl(p0, p1, p2, p3, p4));\ }\ name##MatcherP5(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3, \ p4##_type gmock_p4) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4) {\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ private:\ GTEST_DISALLOW_ASSIGN_(name##MatcherP5);\ };\ template \ inline name##MatcherP5 name(p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, \ p4##_type p4) {\ return name##MatcherP5(p0, p1, p2, p3, p4);\ }\ template \ template \ bool name##MatcherP5::gmock_Impl::MatchAndExplain(\ arg_type arg, \ ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_)\ const #define MATCHER_P6(name, p0, p1, p2, p3, p4, p5, description)\ template \ class name##MatcherP6 {\ public:\ template \ class gmock_Impl : public ::testing::MatcherInterface {\ public:\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5)\ : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), p3(gmock_p3), \ p4(gmock_p4), p5(gmock_p5) {}\ virtual bool MatchAndExplain(\ arg_type arg, ::testing::MatchResultListener* result_listener) const;\ virtual void DescribeTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(false);\ }\ virtual void DescribeNegationTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(true);\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ private:\ ::testing::internal::string FormatDescription(bool negation) const {\ const ::testing::internal::string gmock_description = (description);\ if (!gmock_description.empty())\ return gmock_description;\ return ::testing::internal::FormatMatcherDescription(\ negation, #name, \ ::testing::internal::UniversalTersePrintTupleFieldsToStrings(\ ::testing::tuple(p0, p1, p2, p3, p4, p5)));\ }\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template \ operator ::testing::Matcher() const {\ return ::testing::Matcher(\ new gmock_Impl(p0, p1, p2, p3, p4, p5));\ }\ name##MatcherP6(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3, p4##_type gmock_p4, \ p5##_type gmock_p5) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5) {\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ private:\ GTEST_DISALLOW_ASSIGN_(name##MatcherP6);\ };\ template \ inline name##MatcherP6 name(p0##_type p0, p1##_type p1, p2##_type p2, \ p3##_type p3, p4##_type p4, p5##_type p5) {\ return name##MatcherP6(p0, p1, p2, p3, p4, p5);\ }\ template \ template \ bool name##MatcherP6::gmock_Impl::MatchAndExplain(\ arg_type arg, \ ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_)\ const #define MATCHER_P7(name, p0, p1, p2, p3, p4, p5, p6, description)\ template \ class name##MatcherP7 {\ public:\ template \ class gmock_Impl : public ::testing::MatcherInterface {\ public:\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \ p6##_type gmock_p6)\ : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), p3(gmock_p3), \ p4(gmock_p4), p5(gmock_p5), p6(gmock_p6) {}\ virtual bool MatchAndExplain(\ arg_type arg, ::testing::MatchResultListener* result_listener) const;\ virtual void DescribeTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(false);\ }\ virtual void DescribeNegationTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(true);\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ private:\ ::testing::internal::string FormatDescription(bool negation) const {\ const ::testing::internal::string gmock_description = (description);\ if (!gmock_description.empty())\ return gmock_description;\ return ::testing::internal::FormatMatcherDescription(\ negation, #name, \ ::testing::internal::UniversalTersePrintTupleFieldsToStrings(\ ::testing::tuple(p0, p1, p2, p3, p4, p5, \ p6)));\ }\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template \ operator ::testing::Matcher() const {\ return ::testing::Matcher(\ new gmock_Impl(p0, p1, p2, p3, p4, p5, p6));\ }\ name##MatcherP7(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3, p4##_type gmock_p4, \ p5##_type gmock_p5, p6##_type gmock_p6) : p0(gmock_p0), p1(gmock_p1), \ p2(gmock_p2), p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), \ p6(gmock_p6) {\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ private:\ GTEST_DISALLOW_ASSIGN_(name##MatcherP7);\ };\ template \ inline name##MatcherP7 name(p0##_type p0, p1##_type p1, \ p2##_type p2, p3##_type p3, p4##_type p4, p5##_type p5, \ p6##_type p6) {\ return name##MatcherP7(p0, p1, p2, p3, p4, p5, p6);\ }\ template \ template \ bool name##MatcherP7::gmock_Impl::MatchAndExplain(\ arg_type arg, \ ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_)\ const #define MATCHER_P8(name, p0, p1, p2, p3, p4, p5, p6, p7, description)\ template \ class name##MatcherP8 {\ public:\ template \ class gmock_Impl : public ::testing::MatcherInterface {\ public:\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \ p6##_type gmock_p6, p7##_type gmock_p7)\ : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), p3(gmock_p3), \ p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), p7(gmock_p7) {}\ virtual bool MatchAndExplain(\ arg_type arg, ::testing::MatchResultListener* result_listener) const;\ virtual void DescribeTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(false);\ }\ virtual void DescribeNegationTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(true);\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ p7##_type p7;\ private:\ ::testing::internal::string FormatDescription(bool negation) const {\ const ::testing::internal::string gmock_description = (description);\ if (!gmock_description.empty())\ return gmock_description;\ return ::testing::internal::FormatMatcherDescription(\ negation, #name, \ ::testing::internal::UniversalTersePrintTupleFieldsToStrings(\ ::testing::tuple(p0, p1, p2, \ p3, p4, p5, p6, p7)));\ }\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template \ operator ::testing::Matcher() const {\ return ::testing::Matcher(\ new gmock_Impl(p0, p1, p2, p3, p4, p5, p6, p7));\ }\ name##MatcherP8(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3, p4##_type gmock_p4, \ p5##_type gmock_p5, p6##_type gmock_p6, \ p7##_type gmock_p7) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), \ p7(gmock_p7) {\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ p7##_type p7;\ private:\ GTEST_DISALLOW_ASSIGN_(name##MatcherP8);\ };\ template \ inline name##MatcherP8 name(p0##_type p0, \ p1##_type p1, p2##_type p2, p3##_type p3, p4##_type p4, p5##_type p5, \ p6##_type p6, p7##_type p7) {\ return name##MatcherP8(p0, p1, p2, p3, p4, p5, \ p6, p7);\ }\ template \ template \ bool name##MatcherP8::gmock_Impl::MatchAndExplain(\ arg_type arg, \ ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_)\ const #define MATCHER_P9(name, p0, p1, p2, p3, p4, p5, p6, p7, p8, description)\ template \ class name##MatcherP9 {\ public:\ template \ class gmock_Impl : public ::testing::MatcherInterface {\ public:\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \ p6##_type gmock_p6, p7##_type gmock_p7, p8##_type gmock_p8)\ : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), p3(gmock_p3), \ p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), p7(gmock_p7), \ p8(gmock_p8) {}\ virtual bool MatchAndExplain(\ arg_type arg, ::testing::MatchResultListener* result_listener) const;\ virtual void DescribeTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(false);\ }\ virtual void DescribeNegationTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(true);\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ p7##_type p7;\ p8##_type p8;\ private:\ ::testing::internal::string FormatDescription(bool negation) const {\ const ::testing::internal::string gmock_description = (description);\ if (!gmock_description.empty())\ return gmock_description;\ return ::testing::internal::FormatMatcherDescription(\ negation, #name, \ ::testing::internal::UniversalTersePrintTupleFieldsToStrings(\ ::testing::tuple(p0, p1, p2, p3, p4, p5, p6, p7, p8)));\ }\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template \ operator ::testing::Matcher() const {\ return ::testing::Matcher(\ new gmock_Impl(p0, p1, p2, p3, p4, p5, p6, p7, p8));\ }\ name##MatcherP9(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3, p4##_type gmock_p4, \ p5##_type gmock_p5, p6##_type gmock_p6, p7##_type gmock_p7, \ p8##_type gmock_p8) : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), \ p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), p7(gmock_p7), \ p8(gmock_p8) {\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ p7##_type p7;\ p8##_type p8;\ private:\ GTEST_DISALLOW_ASSIGN_(name##MatcherP9);\ };\ template \ inline name##MatcherP9 name(p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, \ p4##_type p4, p5##_type p5, p6##_type p6, p7##_type p7, \ p8##_type p8) {\ return name##MatcherP9(p0, p1, p2, \ p3, p4, p5, p6, p7, p8);\ }\ template \ template \ bool name##MatcherP9::gmock_Impl::MatchAndExplain(\ arg_type arg, \ ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_)\ const #define MATCHER_P10(name, p0, p1, p2, p3, p4, p5, p6, p7, p8, p9, description)\ template \ class name##MatcherP10 {\ public:\ template \ class gmock_Impl : public ::testing::MatcherInterface {\ public:\ gmock_Impl(p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \ p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \ p6##_type gmock_p6, p7##_type gmock_p7, p8##_type gmock_p8, \ p9##_type gmock_p9)\ : p0(gmock_p0), p1(gmock_p1), p2(gmock_p2), p3(gmock_p3), \ p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), p7(gmock_p7), \ p8(gmock_p8), p9(gmock_p9) {}\ virtual bool MatchAndExplain(\ arg_type arg, ::testing::MatchResultListener* result_listener) const;\ virtual void DescribeTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(false);\ }\ virtual void DescribeNegationTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(true);\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ p7##_type p7;\ p8##_type p8;\ p9##_type p9;\ private:\ ::testing::internal::string FormatDescription(bool negation) const {\ const ::testing::internal::string gmock_description = (description);\ if (!gmock_description.empty())\ return gmock_description;\ return ::testing::internal::FormatMatcherDescription(\ negation, #name, \ ::testing::internal::UniversalTersePrintTupleFieldsToStrings(\ ::testing::tuple(p0, p1, p2, p3, p4, p5, p6, p7, p8, p9)));\ }\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template \ operator ::testing::Matcher() const {\ return ::testing::Matcher(\ new gmock_Impl(p0, p1, p2, p3, p4, p5, p6, p7, p8, p9));\ }\ name##MatcherP10(p0##_type gmock_p0, p1##_type gmock_p1, \ p2##_type gmock_p2, p3##_type gmock_p3, p4##_type gmock_p4, \ p5##_type gmock_p5, p6##_type gmock_p6, p7##_type gmock_p7, \ p8##_type gmock_p8, p9##_type gmock_p9) : p0(gmock_p0), p1(gmock_p1), \ p2(gmock_p2), p3(gmock_p3), p4(gmock_p4), p5(gmock_p5), p6(gmock_p6), \ p7(gmock_p7), p8(gmock_p8), p9(gmock_p9) {\ }\ p0##_type p0;\ p1##_type p1;\ p2##_type p2;\ p3##_type p3;\ p4##_type p4;\ p5##_type p5;\ p6##_type p6;\ p7##_type p7;\ p8##_type p8;\ p9##_type p9;\ private:\ GTEST_DISALLOW_ASSIGN_(name##MatcherP10);\ };\ template \ inline name##MatcherP10 name(p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, \ p4##_type p4, p5##_type p5, p6##_type p6, p7##_type p7, p8##_type p8, \ p9##_type p9) {\ return name##MatcherP10(p0, \ p1, p2, p3, p4, p5, p6, p7, p8, p9);\ }\ template \ template \ bool name##MatcherP10::gmock_Impl::MatchAndExplain(\ arg_type arg, \ ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_)\ const #endif // GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_MATCHERS_H_ vendor/googletest/gtest-1.7.0/googlemock/include/gmock/gmock-generated-matchers.h.pump000066400000000000000000000523511300002025200311460ustar00rootroot00000000000000$$ -*- mode: c++; -*- $$ This is a Pump source file. Please use Pump to convert it to $$ gmock-generated-actions.h. $$ $var n = 10 $$ The maximum arity we support. $$ }} This line fixes auto-indentation of the following code in Emacs. // Copyright 2008, Google Inc. // 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 Google Inc. 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. // Google Mock - a framework for writing C++ mock classes. // // This file implements some commonly used variadic matchers. #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_MATCHERS_H_ #define GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_MATCHERS_H_ #include #include #include #include #include "gmock/gmock-matchers.h" namespace testing { namespace internal { $range i 0..n-1 // The type of the i-th (0-based) field of Tuple. #define GMOCK_FIELD_TYPE_(Tuple, i) \ typename ::testing::tuple_element::type // TupleFields is for selecting fields from a // tuple of type Tuple. It has two members: // // type: a tuple type whose i-th field is the ki-th field of Tuple. // GetSelectedFields(t): returns fields k0, ..., and kn of t as a tuple. // // For example, in class TupleFields, 2, 0>, we have: // // type is tuple, and // GetSelectedFields(make_tuple(true, 'a', 42)) is (42, true). template class TupleFields; // This generic version is used when there are $n selectors. template class TupleFields { public: typedef ::testing::tuple<$for i, [[GMOCK_FIELD_TYPE_(Tuple, k$i)]]> type; static type GetSelectedFields(const Tuple& t) { return type($for i, [[get(t)]]); } }; // The following specialization is used for 0 ~ $(n-1) selectors. $for i [[ $$ }}} $range j 0..i-1 $range k 0..n-1 template class TupleFields { public: typedef ::testing::tuple<$for j, [[GMOCK_FIELD_TYPE_(Tuple, k$j)]]> type; static type GetSelectedFields(const Tuple& $if i==0 [[/* t */]] $else [[t]]) { return type($for j, [[get(t)]]); } }; ]] #undef GMOCK_FIELD_TYPE_ // Implements the Args() matcher. $var ks = [[$for i, [[k$i]]]] template class ArgsMatcherImpl : public MatcherInterface { public: // ArgsTuple may have top-level const or reference modifiers. typedef GTEST_REMOVE_REFERENCE_AND_CONST_(ArgsTuple) RawArgsTuple; typedef typename internal::TupleFields::type SelectedArgs; typedef Matcher MonomorphicInnerMatcher; template explicit ArgsMatcherImpl(const InnerMatcher& inner_matcher) : inner_matcher_(SafeMatcherCast(inner_matcher)) {} virtual bool MatchAndExplain(ArgsTuple args, MatchResultListener* listener) const { const SelectedArgs& selected_args = GetSelectedArgs(args); if (!listener->IsInterested()) return inner_matcher_.Matches(selected_args); PrintIndices(listener->stream()); *listener << "are " << PrintToString(selected_args); StringMatchResultListener inner_listener; const bool match = inner_matcher_.MatchAndExplain(selected_args, &inner_listener); PrintIfNotEmpty(inner_listener.str(), listener->stream()); return match; } virtual void DescribeTo(::std::ostream* os) const { *os << "are a tuple "; PrintIndices(os); inner_matcher_.DescribeTo(os); } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "are a tuple "; PrintIndices(os); inner_matcher_.DescribeNegationTo(os); } private: static SelectedArgs GetSelectedArgs(ArgsTuple args) { return TupleFields::GetSelectedFields(args); } // Prints the indices of the selected fields. static void PrintIndices(::std::ostream* os) { *os << "whose fields ("; const int indices[$n] = { $ks }; for (int i = 0; i < $n; i++) { if (indices[i] < 0) break; if (i >= 1) *os << ", "; *os << "#" << indices[i]; } *os << ") "; } const MonomorphicInnerMatcher inner_matcher_; GTEST_DISALLOW_ASSIGN_(ArgsMatcherImpl); }; template class ArgsMatcher { public: explicit ArgsMatcher(const InnerMatcher& inner_matcher) : inner_matcher_(inner_matcher) {} template operator Matcher() const { return MakeMatcher(new ArgsMatcherImpl(inner_matcher_)); } private: const InnerMatcher inner_matcher_; GTEST_DISALLOW_ASSIGN_(ArgsMatcher); }; // A set of metafunctions for computing the result type of AllOf. // AllOf(m1, ..., mN) returns // AllOfResultN::type. // Although AllOf isn't defined for one argument, AllOfResult1 is defined // to simplify the implementation. template struct AllOfResult1 { typedef M1 type; }; $range i 1..n $range i 2..n $for i [[ $range j 2..i $var m = i/2 $range k 1..m $range t m+1..i template struct AllOfResult$i { typedef BothOfMatcher< typename AllOfResult$m<$for k, [[M$k]]>::type, typename AllOfResult$(i-m)<$for t, [[M$t]]>::type > type; }; ]] // A set of metafunctions for computing the result type of AnyOf. // AnyOf(m1, ..., mN) returns // AnyOfResultN::type. // Although AnyOf isn't defined for one argument, AnyOfResult1 is defined // to simplify the implementation. template struct AnyOfResult1 { typedef M1 type; }; $range i 1..n $range i 2..n $for i [[ $range j 2..i $var m = i/2 $range k 1..m $range t m+1..i template struct AnyOfResult$i { typedef EitherOfMatcher< typename AnyOfResult$m<$for k, [[M$k]]>::type, typename AnyOfResult$(i-m)<$for t, [[M$t]]>::type > type; }; ]] } // namespace internal // Args(a_matcher) matches a tuple if the selected // fields of it matches a_matcher. C++ doesn't support default // arguments for function templates, so we have to overload it. $range i 0..n $for i [[ $range j 1..i template <$for j [[int k$j, ]]typename InnerMatcher> inline internal::ArgsMatcher Args(const InnerMatcher& matcher) { return internal::ArgsMatcher(matcher); } ]] // ElementsAre(e_1, e_2, ... e_n) matches an STL-style container with // n elements, where the i-th element in the container must // match the i-th argument in the list. Each argument of // ElementsAre() can be either a value or a matcher. We support up to // $n arguments. // // The use of DecayArray in the implementation allows ElementsAre() // to accept string literals, whose type is const char[N], but we // want to treat them as const char*. // // NOTE: Since ElementsAre() cares about the order of the elements, it // must not be used with containers whose elements's order is // undefined (e.g. hash_map). $range i 0..n $for i [[ $range j 1..i $if i>0 [[ template <$for j, [[typename T$j]]> ]] inline internal::ElementsAreMatcher< ::testing::tuple< $for j, [[ typename internal::DecayArray::type]]> > ElementsAre($for j, [[const T$j& e$j]]) { typedef ::testing::tuple< $for j, [[ typename internal::DecayArray::type]]> Args; return internal::ElementsAreMatcher(Args($for j, [[e$j]])); } ]] // UnorderedElementsAre(e_1, e_2, ..., e_n) is an ElementsAre extension // that matches n elements in any order. We support up to n=$n arguments. $range i 0..n $for i [[ $range j 1..i $if i>0 [[ template <$for j, [[typename T$j]]> ]] inline internal::UnorderedElementsAreMatcher< ::testing::tuple< $for j, [[ typename internal::DecayArray::type]]> > UnorderedElementsAre($for j, [[const T$j& e$j]]) { typedef ::testing::tuple< $for j, [[ typename internal::DecayArray::type]]> Args; return internal::UnorderedElementsAreMatcher(Args($for j, [[e$j]])); } ]] // AllOf(m1, m2, ..., mk) matches any value that matches all of the given // sub-matchers. AllOf is called fully qualified to prevent ADL from firing. $range i 2..n $for i [[ $range j 1..i $var m = i/2 $range k 1..m $range t m+1..i template <$for j, [[typename M$j]]> inline typename internal::AllOfResult$i<$for j, [[M$j]]>::type AllOf($for j, [[M$j m$j]]) { return typename internal::AllOfResult$i<$for j, [[M$j]]>::type( $if m == 1 [[m1]] $else [[::testing::AllOf($for k, [[m$k]])]], $if m+1 == i [[m$i]] $else [[::testing::AllOf($for t, [[m$t]])]]); } ]] // AnyOf(m1, m2, ..., mk) matches any value that matches any of the given // sub-matchers. AnyOf is called fully qualified to prevent ADL from firing. $range i 2..n $for i [[ $range j 1..i $var m = i/2 $range k 1..m $range t m+1..i template <$for j, [[typename M$j]]> inline typename internal::AnyOfResult$i<$for j, [[M$j]]>::type AnyOf($for j, [[M$j m$j]]) { return typename internal::AnyOfResult$i<$for j, [[M$j]]>::type( $if m == 1 [[m1]] $else [[::testing::AnyOf($for k, [[m$k]])]], $if m+1 == i [[m$i]] $else [[::testing::AnyOf($for t, [[m$t]])]]); } ]] } // namespace testing $$ } // This Pump meta comment fixes auto-indentation in Emacs. It will not $$ // show up in the generated code. // The MATCHER* family of macros can be used in a namespace scope to // define custom matchers easily. // // Basic Usage // =========== // // The syntax // // MATCHER(name, description_string) { statements; } // // defines a matcher with the given name that executes the statements, // which must return a bool to indicate if the match succeeds. Inside // the statements, you can refer to the value being matched by 'arg', // and refer to its type by 'arg_type'. // // The description string documents what the matcher does, and is used // to generate the failure message when the match fails. Since a // MATCHER() is usually defined in a header file shared by multiple // C++ source files, we require the description to be a C-string // literal to avoid possible side effects. It can be empty, in which // case we'll use the sequence of words in the matcher name as the // description. // // For example: // // MATCHER(IsEven, "") { return (arg % 2) == 0; } // // allows you to write // // // Expects mock_foo.Bar(n) to be called where n is even. // EXPECT_CALL(mock_foo, Bar(IsEven())); // // or, // // // Verifies that the value of some_expression is even. // EXPECT_THAT(some_expression, IsEven()); // // If the above assertion fails, it will print something like: // // Value of: some_expression // Expected: is even // Actual: 7 // // where the description "is even" is automatically calculated from the // matcher name IsEven. // // Argument Type // ============= // // Note that the type of the value being matched (arg_type) is // determined by the context in which you use the matcher and is // supplied to you by the compiler, so you don't need to worry about // declaring it (nor can you). This allows the matcher to be // polymorphic. For example, IsEven() can be used to match any type // where the value of "(arg % 2) == 0" can be implicitly converted to // a bool. In the "Bar(IsEven())" example above, if method Bar() // takes an int, 'arg_type' will be int; if it takes an unsigned long, // 'arg_type' will be unsigned long; and so on. // // Parameterizing Matchers // ======================= // // Sometimes you'll want to parameterize the matcher. For that you // can use another macro: // // MATCHER_P(name, param_name, description_string) { statements; } // // For example: // // MATCHER_P(HasAbsoluteValue, value, "") { return abs(arg) == value; } // // will allow you to write: // // EXPECT_THAT(Blah("a"), HasAbsoluteValue(n)); // // which may lead to this message (assuming n is 10): // // Value of: Blah("a") // Expected: has absolute value 10 // Actual: -9 // // Note that both the matcher description and its parameter are // printed, making the message human-friendly. // // In the matcher definition body, you can write 'foo_type' to // reference the type of a parameter named 'foo'. For example, in the // body of MATCHER_P(HasAbsoluteValue, value) above, you can write // 'value_type' to refer to the type of 'value'. // // We also provide MATCHER_P2, MATCHER_P3, ..., up to MATCHER_P$n to // support multi-parameter matchers. // // Describing Parameterized Matchers // ================================= // // The last argument to MATCHER*() is a string-typed expression. The // expression can reference all of the matcher's parameters and a // special bool-typed variable named 'negation'. When 'negation' is // false, the expression should evaluate to the matcher's description; // otherwise it should evaluate to the description of the negation of // the matcher. For example, // // using testing::PrintToString; // // MATCHER_P2(InClosedRange, low, hi, // string(negation ? "is not" : "is") + " in range [" + // PrintToString(low) + ", " + PrintToString(hi) + "]") { // return low <= arg && arg <= hi; // } // ... // EXPECT_THAT(3, InClosedRange(4, 6)); // EXPECT_THAT(3, Not(InClosedRange(2, 4))); // // would generate two failures that contain the text: // // Expected: is in range [4, 6] // ... // Expected: is not in range [2, 4] // // If you specify "" as the description, the failure message will // contain the sequence of words in the matcher name followed by the // parameter values printed as a tuple. For example, // // MATCHER_P2(InClosedRange, low, hi, "") { ... } // ... // EXPECT_THAT(3, InClosedRange(4, 6)); // EXPECT_THAT(3, Not(InClosedRange(2, 4))); // // would generate two failures that contain the text: // // Expected: in closed range (4, 6) // ... // Expected: not (in closed range (2, 4)) // // Types of Matcher Parameters // =========================== // // For the purpose of typing, you can view // // MATCHER_Pk(Foo, p1, ..., pk, description_string) { ... } // // as shorthand for // // template // FooMatcherPk // Foo(p1_type p1, ..., pk_type pk) { ... } // // When you write Foo(v1, ..., vk), the compiler infers the types of // the parameters v1, ..., and vk for you. If you are not happy with // the result of the type inference, you can specify the types by // explicitly instantiating the template, as in Foo(5, // false). As said earlier, you don't get to (or need to) specify // 'arg_type' as that's determined by the context in which the matcher // is used. You can assign the result of expression Foo(p1, ..., pk) // to a variable of type FooMatcherPk. This // can be useful when composing matchers. // // While you can instantiate a matcher template with reference types, // passing the parameters by pointer usually makes your code more // readable. If, however, you still want to pass a parameter by // reference, be aware that in the failure message generated by the // matcher you will see the value of the referenced object but not its // address. // // Explaining Match Results // ======================== // // Sometimes the matcher description alone isn't enough to explain why // the match has failed or succeeded. For example, when expecting a // long string, it can be very helpful to also print the diff between // the expected string and the actual one. To achieve that, you can // optionally stream additional information to a special variable // named result_listener, whose type is a pointer to class // MatchResultListener: // // MATCHER_P(EqualsLongString, str, "") { // if (arg == str) return true; // // *result_listener << "the difference: " /// << DiffStrings(str, arg); // return false; // } // // Overloading Matchers // ==================== // // You can overload matchers with different numbers of parameters: // // MATCHER_P(Blah, a, description_string1) { ... } // MATCHER_P2(Blah, a, b, description_string2) { ... } // // Caveats // ======= // // When defining a new matcher, you should also consider implementing // MatcherInterface or using MakePolymorphicMatcher(). These // approaches require more work than the MATCHER* macros, but also // give you more control on the types of the value being matched and // the matcher parameters, which may leads to better compiler error // messages when the matcher is used wrong. They also allow // overloading matchers based on parameter types (as opposed to just // based on the number of parameters). // // MATCHER*() can only be used in a namespace scope. The reason is // that C++ doesn't yet allow function-local types to be used to // instantiate templates. The up-coming C++0x standard will fix this. // Once that's done, we'll consider supporting using MATCHER*() inside // a function. // // More Information // ================ // // To learn more about using these macros, please search for 'MATCHER' // on http://code.google.com/p/googlemock/wiki/CookBook. $range i 0..n $for i [[ $var macro_name = [[$if i==0 [[MATCHER]] $elif i==1 [[MATCHER_P]] $else [[MATCHER_P$i]]]] $var class_name = [[name##Matcher[[$if i==0 [[]] $elif i==1 [[P]] $else [[P$i]]]]]] $range j 0..i-1 $var template = [[$if i==0 [[]] $else [[ template <$for j, [[typename p$j##_type]]>\ ]]]] $var ctor_param_list = [[$for j, [[p$j##_type gmock_p$j]]]] $var impl_ctor_param_list = [[$for j, [[p$j##_type gmock_p$j]]]] $var impl_inits = [[$if i==0 [[]] $else [[ : $for j, [[p$j(gmock_p$j)]]]]]] $var inits = [[$if i==0 [[]] $else [[ : $for j, [[p$j(gmock_p$j)]]]]]] $var params = [[$for j, [[p$j]]]] $var param_types = [[$if i==0 [[]] $else [[<$for j, [[p$j##_type]]>]]]] $var param_types_and_names = [[$for j, [[p$j##_type p$j]]]] $var param_field_decls = [[$for j [[ p$j##_type p$j;\ ]]]] $var param_field_decls2 = [[$for j [[ p$j##_type p$j;\ ]]]] #define $macro_name(name$for j [[, p$j]], description)\$template class $class_name {\ public:\ template \ class gmock_Impl : public ::testing::MatcherInterface {\ public:\ [[$if i==1 [[explicit ]]]]gmock_Impl($impl_ctor_param_list)\ $impl_inits {}\ virtual bool MatchAndExplain(\ arg_type arg, ::testing::MatchResultListener* result_listener) const;\ virtual void DescribeTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(false);\ }\ virtual void DescribeNegationTo(::std::ostream* gmock_os) const {\ *gmock_os << FormatDescription(true);\ }\$param_field_decls private:\ ::testing::internal::string FormatDescription(bool negation) const {\ const ::testing::internal::string gmock_description = (description);\ if (!gmock_description.empty())\ return gmock_description;\ return ::testing::internal::FormatMatcherDescription(\ negation, #name, \ ::testing::internal::UniversalTersePrintTupleFieldsToStrings(\ ::testing::tuple<$for j, [[p$j##_type]]>($for j, [[p$j]])));\ }\ GTEST_DISALLOW_ASSIGN_(gmock_Impl);\ };\ template \ operator ::testing::Matcher() const {\ return ::testing::Matcher(\ new gmock_Impl($params));\ }\ [[$if i==1 [[explicit ]]]]$class_name($ctor_param_list)$inits {\ }\$param_field_decls2 private:\ GTEST_DISALLOW_ASSIGN_($class_name);\ };\$template inline $class_name$param_types name($param_types_and_names) {\ return $class_name$param_types($params);\ }\$template template \ bool $class_name$param_types::gmock_Impl::MatchAndExplain(\ arg_type arg, \ ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_)\ const ]] #endif // GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_MATCHERS_H_ vendor/googletest/gtest-1.7.0/googlemock/include/gmock/gmock-generated-nice-strict.h000066400000000000000000000374701300002025200306110ustar00rootroot00000000000000// This file was GENERATED by command: // pump.py gmock-generated-nice-strict.h.pump // DO NOT EDIT BY HAND!!! // Copyright 2008, Google Inc. // 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 Google Inc. 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. // // Author: wan@google.com (Zhanyong Wan) // Implements class templates NiceMock, NaggyMock, and StrictMock. // // Given a mock class MockFoo that is created using Google Mock, // NiceMock is a subclass of MockFoo that allows // uninteresting calls (i.e. calls to mock methods that have no // EXPECT_CALL specs), NaggyMock is a subclass of MockFoo // that prints a warning when an uninteresting call occurs, and // StrictMock is a subclass of MockFoo that treats all // uninteresting calls as errors. // // Currently a mock is naggy by default, so MockFoo and // NaggyMock behave like the same. However, we will soon // switch the default behavior of mocks to be nice, as that in general // leads to more maintainable tests. When that happens, MockFoo will // stop behaving like NaggyMock and start behaving like // NiceMock. // // NiceMock, NaggyMock, and StrictMock "inherit" the constructors of // their respective base class, with up-to 10 arguments. Therefore // you can write NiceMock(5, "a") to construct a nice mock // where MockFoo has a constructor that accepts (int, const char*), // for example. // // A known limitation is that NiceMock, NaggyMock, // and StrictMock only works for mock methods defined using // the MOCK_METHOD* family of macros DIRECTLY in the MockFoo class. // If a mock method is defined in a base class of MockFoo, the "nice" // or "strict" modifier may not affect it, depending on the compiler. // In particular, nesting NiceMock, NaggyMock, and StrictMock is NOT // supported. // // Another known limitation is that the constructors of the base mock // cannot have arguments passed by non-const reference, which are // banned by the Google C++ style guide anyway. #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_NICE_STRICT_H_ #define GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_NICE_STRICT_H_ #include "gmock/gmock-spec-builders.h" #include "gmock/internal/gmock-port.h" namespace testing { template class NiceMock : public MockClass { public: // We don't factor out the constructor body to a common method, as // we have to avoid a possible clash with members of MockClass. NiceMock() { ::testing::Mock::AllowUninterestingCalls( internal::ImplicitCast_(this)); } // C++ doesn't (yet) allow inheritance of constructors, so we have // to define it for each arity. template explicit NiceMock(const A1& a1) : MockClass(a1) { ::testing::Mock::AllowUninterestingCalls( internal::ImplicitCast_(this)); } template NiceMock(const A1& a1, const A2& a2) : MockClass(a1, a2) { ::testing::Mock::AllowUninterestingCalls( internal::ImplicitCast_(this)); } template NiceMock(const A1& a1, const A2& a2, const A3& a3) : MockClass(a1, a2, a3) { ::testing::Mock::AllowUninterestingCalls( internal::ImplicitCast_(this)); } template NiceMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4) : MockClass(a1, a2, a3, a4) { ::testing::Mock::AllowUninterestingCalls( internal::ImplicitCast_(this)); } template NiceMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5) : MockClass(a1, a2, a3, a4, a5) { ::testing::Mock::AllowUninterestingCalls( internal::ImplicitCast_(this)); } template NiceMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6) : MockClass(a1, a2, a3, a4, a5, a6) { ::testing::Mock::AllowUninterestingCalls( internal::ImplicitCast_(this)); } template NiceMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6, const A7& a7) : MockClass(a1, a2, a3, a4, a5, a6, a7) { ::testing::Mock::AllowUninterestingCalls( internal::ImplicitCast_(this)); } template NiceMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6, const A7& a7, const A8& a8) : MockClass(a1, a2, a3, a4, a5, a6, a7, a8) { ::testing::Mock::AllowUninterestingCalls( internal::ImplicitCast_(this)); } template NiceMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6, const A7& a7, const A8& a8, const A9& a9) : MockClass(a1, a2, a3, a4, a5, a6, a7, a8, a9) { ::testing::Mock::AllowUninterestingCalls( internal::ImplicitCast_(this)); } template NiceMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6, const A7& a7, const A8& a8, const A9& a9, const A10& a10) : MockClass(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) { ::testing::Mock::AllowUninterestingCalls( internal::ImplicitCast_(this)); } virtual ~NiceMock() { ::testing::Mock::UnregisterCallReaction( internal::ImplicitCast_(this)); } private: GTEST_DISALLOW_COPY_AND_ASSIGN_(NiceMock); }; template class NaggyMock : public MockClass { public: // We don't factor out the constructor body to a common method, as // we have to avoid a possible clash with members of MockClass. NaggyMock() { ::testing::Mock::WarnUninterestingCalls( internal::ImplicitCast_(this)); } // C++ doesn't (yet) allow inheritance of constructors, so we have // to define it for each arity. template explicit NaggyMock(const A1& a1) : MockClass(a1) { ::testing::Mock::WarnUninterestingCalls( internal::ImplicitCast_(this)); } template NaggyMock(const A1& a1, const A2& a2) : MockClass(a1, a2) { ::testing::Mock::WarnUninterestingCalls( internal::ImplicitCast_(this)); } template NaggyMock(const A1& a1, const A2& a2, const A3& a3) : MockClass(a1, a2, a3) { ::testing::Mock::WarnUninterestingCalls( internal::ImplicitCast_(this)); } template NaggyMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4) : MockClass(a1, a2, a3, a4) { ::testing::Mock::WarnUninterestingCalls( internal::ImplicitCast_(this)); } template NaggyMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5) : MockClass(a1, a2, a3, a4, a5) { ::testing::Mock::WarnUninterestingCalls( internal::ImplicitCast_(this)); } template NaggyMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6) : MockClass(a1, a2, a3, a4, a5, a6) { ::testing::Mock::WarnUninterestingCalls( internal::ImplicitCast_(this)); } template NaggyMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6, const A7& a7) : MockClass(a1, a2, a3, a4, a5, a6, a7) { ::testing::Mock::WarnUninterestingCalls( internal::ImplicitCast_(this)); } template NaggyMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6, const A7& a7, const A8& a8) : MockClass(a1, a2, a3, a4, a5, a6, a7, a8) { ::testing::Mock::WarnUninterestingCalls( internal::ImplicitCast_(this)); } template NaggyMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6, const A7& a7, const A8& a8, const A9& a9) : MockClass(a1, a2, a3, a4, a5, a6, a7, a8, a9) { ::testing::Mock::WarnUninterestingCalls( internal::ImplicitCast_(this)); } template NaggyMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6, const A7& a7, const A8& a8, const A9& a9, const A10& a10) : MockClass(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) { ::testing::Mock::WarnUninterestingCalls( internal::ImplicitCast_(this)); } virtual ~NaggyMock() { ::testing::Mock::UnregisterCallReaction( internal::ImplicitCast_(this)); } private: GTEST_DISALLOW_COPY_AND_ASSIGN_(NaggyMock); }; template class StrictMock : public MockClass { public: // We don't factor out the constructor body to a common method, as // we have to avoid a possible clash with members of MockClass. StrictMock() { ::testing::Mock::FailUninterestingCalls( internal::ImplicitCast_(this)); } // C++ doesn't (yet) allow inheritance of constructors, so we have // to define it for each arity. template explicit StrictMock(const A1& a1) : MockClass(a1) { ::testing::Mock::FailUninterestingCalls( internal::ImplicitCast_(this)); } template StrictMock(const A1& a1, const A2& a2) : MockClass(a1, a2) { ::testing::Mock::FailUninterestingCalls( internal::ImplicitCast_(this)); } template StrictMock(const A1& a1, const A2& a2, const A3& a3) : MockClass(a1, a2, a3) { ::testing::Mock::FailUninterestingCalls( internal::ImplicitCast_(this)); } template StrictMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4) : MockClass(a1, a2, a3, a4) { ::testing::Mock::FailUninterestingCalls( internal::ImplicitCast_(this)); } template StrictMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5) : MockClass(a1, a2, a3, a4, a5) { ::testing::Mock::FailUninterestingCalls( internal::ImplicitCast_(this)); } template StrictMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6) : MockClass(a1, a2, a3, a4, a5, a6) { ::testing::Mock::FailUninterestingCalls( internal::ImplicitCast_(this)); } template StrictMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6, const A7& a7) : MockClass(a1, a2, a3, a4, a5, a6, a7) { ::testing::Mock::FailUninterestingCalls( internal::ImplicitCast_(this)); } template StrictMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6, const A7& a7, const A8& a8) : MockClass(a1, a2, a3, a4, a5, a6, a7, a8) { ::testing::Mock::FailUninterestingCalls( internal::ImplicitCast_(this)); } template StrictMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6, const A7& a7, const A8& a8, const A9& a9) : MockClass(a1, a2, a3, a4, a5, a6, a7, a8, a9) { ::testing::Mock::FailUninterestingCalls( internal::ImplicitCast_(this)); } template StrictMock(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6, const A7& a7, const A8& a8, const A9& a9, const A10& a10) : MockClass(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) { ::testing::Mock::FailUninterestingCalls( internal::ImplicitCast_(this)); } virtual ~StrictMock() { ::testing::Mock::UnregisterCallReaction( internal::ImplicitCast_(this)); } private: GTEST_DISALLOW_COPY_AND_ASSIGN_(StrictMock); }; // The following specializations catch some (relatively more common) // user errors of nesting nice and strict mocks. They do NOT catch // all possible errors. // These specializations are declared but not defined, as NiceMock, // NaggyMock, and StrictMock cannot be nested. template class NiceMock >; template class NiceMock >; template class NiceMock >; template class NaggyMock >; template class NaggyMock >; template class NaggyMock >; template class StrictMock >; template class StrictMock >; template class StrictMock >; } // namespace testing #endif // GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_NICE_STRICT_H_ vendor/googletest/gtest-1.7.0/googlemock/include/gmock/gmock-generated-nice-strict.h.pump000066400000000000000000000136221300002025200315620ustar00rootroot00000000000000$$ -*- mode: c++; -*- $$ This is a Pump source file. Please use Pump to convert it to $$ gmock-generated-nice-strict.h. $$ $var n = 10 $$ The maximum arity we support. // Copyright 2008, Google Inc. // 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 Google Inc. 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. // // Author: wan@google.com (Zhanyong Wan) // Implements class templates NiceMock, NaggyMock, and StrictMock. // // Given a mock class MockFoo that is created using Google Mock, // NiceMock is a subclass of MockFoo that allows // uninteresting calls (i.e. calls to mock methods that have no // EXPECT_CALL specs), NaggyMock is a subclass of MockFoo // that prints a warning when an uninteresting call occurs, and // StrictMock is a subclass of MockFoo that treats all // uninteresting calls as errors. // // Currently a mock is naggy by default, so MockFoo and // NaggyMock behave like the same. However, we will soon // switch the default behavior of mocks to be nice, as that in general // leads to more maintainable tests. When that happens, MockFoo will // stop behaving like NaggyMock and start behaving like // NiceMock. // // NiceMock, NaggyMock, and StrictMock "inherit" the constructors of // their respective base class, with up-to $n arguments. Therefore // you can write NiceMock(5, "a") to construct a nice mock // where MockFoo has a constructor that accepts (int, const char*), // for example. // // A known limitation is that NiceMock, NaggyMock, // and StrictMock only works for mock methods defined using // the MOCK_METHOD* family of macros DIRECTLY in the MockFoo class. // If a mock method is defined in a base class of MockFoo, the "nice" // or "strict" modifier may not affect it, depending on the compiler. // In particular, nesting NiceMock, NaggyMock, and StrictMock is NOT // supported. // // Another known limitation is that the constructors of the base mock // cannot have arguments passed by non-const reference, which are // banned by the Google C++ style guide anyway. #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_NICE_STRICT_H_ #define GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_NICE_STRICT_H_ #include "gmock/gmock-spec-builders.h" #include "gmock/internal/gmock-port.h" namespace testing { $range kind 0..2 $for kind [[ $var clazz=[[$if kind==0 [[NiceMock]] $elif kind==1 [[NaggyMock]] $else [[StrictMock]]]] $var method=[[$if kind==0 [[AllowUninterestingCalls]] $elif kind==1 [[WarnUninterestingCalls]] $else [[FailUninterestingCalls]]]] template class $clazz : public MockClass { public: // We don't factor out the constructor body to a common method, as // we have to avoid a possible clash with members of MockClass. $clazz() { ::testing::Mock::$method( internal::ImplicitCast_(this)); } // C++ doesn't (yet) allow inheritance of constructors, so we have // to define it for each arity. template explicit $clazz(const A1& a1) : MockClass(a1) { ::testing::Mock::$method( internal::ImplicitCast_(this)); } $range i 2..n $for i [[ $range j 1..i template <$for j, [[typename A$j]]> $clazz($for j, [[const A$j& a$j]]) : MockClass($for j, [[a$j]]) { ::testing::Mock::$method( internal::ImplicitCast_(this)); } ]] virtual ~$clazz() { ::testing::Mock::UnregisterCallReaction( internal::ImplicitCast_(this)); } private: GTEST_DISALLOW_COPY_AND_ASSIGN_($clazz); }; ]] // The following specializations catch some (relatively more common) // user errors of nesting nice and strict mocks. They do NOT catch // all possible errors. // These specializations are declared but not defined, as NiceMock, // NaggyMock, and StrictMock cannot be nested. template class NiceMock >; template class NiceMock >; template class NiceMock >; template class NaggyMock >; template class NaggyMock >; template class NaggyMock >; template class StrictMock >; template class StrictMock >; template class StrictMock >; } // namespace testing #endif // GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_NICE_STRICT_H_ vendor/googletest/gtest-1.7.0/googlemock/include/gmock/gmock-matchers.h000066400000000000000000004672571300002025200262510ustar00rootroot00000000000000// Copyright 2007, Google Inc. // 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 Google Inc. 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. // // Author: wan@google.com (Zhanyong Wan) // Google Mock - a framework for writing C++ mock classes. // // This file implements some commonly used argument matchers. More // matchers can be defined by the user implementing the // MatcherInterface interface if necessary. #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_MATCHERS_H_ #define GMOCK_INCLUDE_GMOCK_GMOCK_MATCHERS_H_ #include #include #include #include #include // NOLINT #include #include #include #include #include "gmock/internal/gmock-internal-utils.h" #include "gmock/internal/gmock-port.h" #include "gtest/gtest.h" #if GTEST_HAS_STD_INITIALIZER_LIST_ # include // NOLINT -- must be after gtest.h #endif namespace testing { // To implement a matcher Foo for type T, define: // 1. a class FooMatcherImpl that implements the // MatcherInterface interface, and // 2. a factory function that creates a Matcher object from a // FooMatcherImpl*. // // The two-level delegation design makes it possible to allow a user // to write "v" instead of "Eq(v)" where a Matcher is expected, which // is impossible if we pass matchers by pointers. It also eases // ownership management as Matcher objects can now be copied like // plain values. // MatchResultListener is an abstract class. Its << operator can be // used by a matcher to explain why a value matches or doesn't match. // // TODO(wan@google.com): add method // bool InterestedInWhy(bool result) const; // to indicate whether the listener is interested in why the match // result is 'result'. class MatchResultListener { public: // Creates a listener object with the given underlying ostream. The // listener does not own the ostream, and does not dereference it // in the constructor or destructor. explicit MatchResultListener(::std::ostream* os) : stream_(os) {} virtual ~MatchResultListener() = 0; // Makes this class abstract. // Streams x to the underlying ostream; does nothing if the ostream // is NULL. template MatchResultListener& operator<<(const T& x) { if (stream_ != NULL) *stream_ << x; return *this; } // Returns the underlying ostream. ::std::ostream* stream() { return stream_; } // Returns true iff the listener is interested in an explanation of // the match result. A matcher's MatchAndExplain() method can use // this information to avoid generating the explanation when no one // intends to hear it. bool IsInterested() const { return stream_ != NULL; } private: ::std::ostream* const stream_; GTEST_DISALLOW_COPY_AND_ASSIGN_(MatchResultListener); }; inline MatchResultListener::~MatchResultListener() { } // An instance of a subclass of this knows how to describe itself as a // matcher. class MatcherDescriberInterface { public: virtual ~MatcherDescriberInterface() {} // Describes this matcher to an ostream. The function should print // a verb phrase that describes the property a value matching this // matcher should have. The subject of the verb phrase is the value // being matched. For example, the DescribeTo() method of the Gt(7) // matcher prints "is greater than 7". virtual void DescribeTo(::std::ostream* os) const = 0; // Describes the negation of this matcher to an ostream. For // example, if the description of this matcher is "is greater than // 7", the negated description could be "is not greater than 7". // You are not required to override this when implementing // MatcherInterface, but it is highly advised so that your matcher // can produce good error messages. virtual void DescribeNegationTo(::std::ostream* os) const { *os << "not ("; DescribeTo(os); *os << ")"; } }; // The implementation of a matcher. template class MatcherInterface : public MatcherDescriberInterface { public: // Returns true iff the matcher matches x; also explains the match // result to 'listener' if necessary (see the next paragraph), in // the form of a non-restrictive relative clause ("which ...", // "whose ...", etc) that describes x. For example, the // MatchAndExplain() method of the Pointee(...) matcher should // generate an explanation like "which points to ...". // // Implementations of MatchAndExplain() should add an explanation of // the match result *if and only if* they can provide additional // information that's not already present (or not obvious) in the // print-out of x and the matcher's description. Whether the match // succeeds is not a factor in deciding whether an explanation is // needed, as sometimes the caller needs to print a failure message // when the match succeeds (e.g. when the matcher is used inside // Not()). // // For example, a "has at least 10 elements" matcher should explain // what the actual element count is, regardless of the match result, // as it is useful information to the reader; on the other hand, an // "is empty" matcher probably only needs to explain what the actual // size is when the match fails, as it's redundant to say that the // size is 0 when the value is already known to be empty. // // You should override this method when defining a new matcher. // // It's the responsibility of the caller (Google Mock) to guarantee // that 'listener' is not NULL. This helps to simplify a matcher's // implementation when it doesn't care about the performance, as it // can talk to 'listener' without checking its validity first. // However, in order to implement dummy listeners efficiently, // listener->stream() may be NULL. virtual bool MatchAndExplain(T x, MatchResultListener* listener) const = 0; // Inherits these methods from MatcherDescriberInterface: // virtual void DescribeTo(::std::ostream* os) const = 0; // virtual void DescribeNegationTo(::std::ostream* os) const; }; // A match result listener that stores the explanation in a string. class StringMatchResultListener : public MatchResultListener { public: StringMatchResultListener() : MatchResultListener(&ss_) {} // Returns the explanation accumulated so far. internal::string str() const { return ss_.str(); } // Clears the explanation accumulated so far. void Clear() { ss_.str(""); } private: ::std::stringstream ss_; GTEST_DISALLOW_COPY_AND_ASSIGN_(StringMatchResultListener); }; namespace internal { struct AnyEq { template bool operator()(const A& a, const B& b) const { return a == b; } }; struct AnyNe { template bool operator()(const A& a, const B& b) const { return a != b; } }; struct AnyLt { template bool operator()(const A& a, const B& b) const { return a < b; } }; struct AnyGt { template bool operator()(const A& a, const B& b) const { return a > b; } }; struct AnyLe { template bool operator()(const A& a, const B& b) const { return a <= b; } }; struct AnyGe { template bool operator()(const A& a, const B& b) const { return a >= b; } }; // A match result listener that ignores the explanation. class DummyMatchResultListener : public MatchResultListener { public: DummyMatchResultListener() : MatchResultListener(NULL) {} private: GTEST_DISALLOW_COPY_AND_ASSIGN_(DummyMatchResultListener); }; // A match result listener that forwards the explanation to a given // ostream. The difference between this and MatchResultListener is // that the former is concrete. class StreamMatchResultListener : public MatchResultListener { public: explicit StreamMatchResultListener(::std::ostream* os) : MatchResultListener(os) {} private: GTEST_DISALLOW_COPY_AND_ASSIGN_(StreamMatchResultListener); }; // An internal class for implementing Matcher, which will derive // from it. We put functionalities common to all Matcher // specializations here to avoid code duplication. template class MatcherBase { public: // Returns true iff the matcher matches x; also explains the match // result to 'listener'. bool MatchAndExplain(T x, MatchResultListener* listener) const { return impl_->MatchAndExplain(x, listener); } // Returns true iff this matcher matches x. bool Matches(T x) const { DummyMatchResultListener dummy; return MatchAndExplain(x, &dummy); } // Describes this matcher to an ostream. void DescribeTo(::std::ostream* os) const { impl_->DescribeTo(os); } // Describes the negation of this matcher to an ostream. void DescribeNegationTo(::std::ostream* os) const { impl_->DescribeNegationTo(os); } // Explains why x matches, or doesn't match, the matcher. void ExplainMatchResultTo(T x, ::std::ostream* os) const { StreamMatchResultListener listener(os); MatchAndExplain(x, &listener); } // Returns the describer for this matcher object; retains ownership // of the describer, which is only guaranteed to be alive when // this matcher object is alive. const MatcherDescriberInterface* GetDescriber() const { return impl_.get(); } protected: MatcherBase() {} // Constructs a matcher from its implementation. explicit MatcherBase(const MatcherInterface* impl) : impl_(impl) {} virtual ~MatcherBase() {} private: // shared_ptr (util/gtl/shared_ptr.h) and linked_ptr have similar // interfaces. The former dynamically allocates a chunk of memory // to hold the reference count, while the latter tracks all // references using a circular linked list without allocating // memory. It has been observed that linked_ptr performs better in // typical scenarios. However, shared_ptr can out-perform // linked_ptr when there are many more uses of the copy constructor // than the default constructor. // // If performance becomes a problem, we should see if using // shared_ptr helps. ::testing::internal::linked_ptr > impl_; }; } // namespace internal // A Matcher is a copyable and IMMUTABLE (except by assignment) // object that can check whether a value of type T matches. The // implementation of Matcher is just a linked_ptr to const // MatcherInterface, so copying is fairly cheap. Don't inherit // from Matcher! template class Matcher : public internal::MatcherBase { public: // Constructs a null matcher. Needed for storing Matcher objects in STL // containers. A default-constructed matcher is not yet initialized. You // cannot use it until a valid value has been assigned to it. explicit Matcher() {} // NOLINT // Constructs a matcher from its implementation. explicit Matcher(const MatcherInterface* impl) : internal::MatcherBase(impl) {} // Implicit constructor here allows people to write // EXPECT_CALL(foo, Bar(5)) instead of EXPECT_CALL(foo, Bar(Eq(5))) sometimes Matcher(T value); // NOLINT }; // The following two specializations allow the user to write str // instead of Eq(str) and "foo" instead of Eq("foo") when a string // matcher is expected. template <> class GTEST_API_ Matcher : public internal::MatcherBase { public: Matcher() {} explicit Matcher(const MatcherInterface* impl) : internal::MatcherBase(impl) {} // Allows the user to write str instead of Eq(str) sometimes, where // str is a string object. Matcher(const internal::string& s); // NOLINT // Allows the user to write "foo" instead of Eq("foo") sometimes. Matcher(const char* s); // NOLINT }; template <> class GTEST_API_ Matcher : public internal::MatcherBase { public: Matcher() {} explicit Matcher(const MatcherInterface* impl) : internal::MatcherBase(impl) {} // Allows the user to write str instead of Eq(str) sometimes, where // str is a string object. Matcher(const internal::string& s); // NOLINT // Allows the user to write "foo" instead of Eq("foo") sometimes. Matcher(const char* s); // NOLINT }; #if GTEST_HAS_STRING_PIECE_ // The following two specializations allow the user to write str // instead of Eq(str) and "foo" instead of Eq("foo") when a StringPiece // matcher is expected. template <> class GTEST_API_ Matcher : public internal::MatcherBase { public: Matcher() {} explicit Matcher(const MatcherInterface* impl) : internal::MatcherBase(impl) {} // Allows the user to write str instead of Eq(str) sometimes, where // str is a string object. Matcher(const internal::string& s); // NOLINT // Allows the user to write "foo" instead of Eq("foo") sometimes. Matcher(const char* s); // NOLINT // Allows the user to pass StringPieces directly. Matcher(StringPiece s); // NOLINT }; template <> class GTEST_API_ Matcher : public internal::MatcherBase { public: Matcher() {} explicit Matcher(const MatcherInterface* impl) : internal::MatcherBase(impl) {} // Allows the user to write str instead of Eq(str) sometimes, where // str is a string object. Matcher(const internal::string& s); // NOLINT // Allows the user to write "foo" instead of Eq("foo") sometimes. Matcher(const char* s); // NOLINT // Allows the user to pass StringPieces directly. Matcher(StringPiece s); // NOLINT }; #endif // GTEST_HAS_STRING_PIECE_ // The PolymorphicMatcher class template makes it easy to implement a // polymorphic matcher (i.e. a matcher that can match values of more // than one type, e.g. Eq(n) and NotNull()). // // To define a polymorphic matcher, a user should provide an Impl // class that has a DescribeTo() method and a DescribeNegationTo() // method, and define a member function (or member function template) // // bool MatchAndExplain(const Value& value, // MatchResultListener* listener) const; // // See the definition of NotNull() for a complete example. template class PolymorphicMatcher { public: explicit PolymorphicMatcher(const Impl& an_impl) : impl_(an_impl) {} // Returns a mutable reference to the underlying matcher // implementation object. Impl& mutable_impl() { return impl_; } // Returns an immutable reference to the underlying matcher // implementation object. const Impl& impl() const { return impl_; } template operator Matcher() const { return Matcher(new MonomorphicImpl(impl_)); } private: template class MonomorphicImpl : public MatcherInterface { public: explicit MonomorphicImpl(const Impl& impl) : impl_(impl) {} virtual void DescribeTo(::std::ostream* os) const { impl_.DescribeTo(os); } virtual void DescribeNegationTo(::std::ostream* os) const { impl_.DescribeNegationTo(os); } virtual bool MatchAndExplain(T x, MatchResultListener* listener) const { return impl_.MatchAndExplain(x, listener); } private: const Impl impl_; GTEST_DISALLOW_ASSIGN_(MonomorphicImpl); }; Impl impl_; GTEST_DISALLOW_ASSIGN_(PolymorphicMatcher); }; // Creates a matcher from its implementation. This is easier to use // than the Matcher constructor as it doesn't require you to // explicitly write the template argument, e.g. // // MakeMatcher(foo); // vs // Matcher(foo); template inline Matcher MakeMatcher(const MatcherInterface* impl) { return Matcher(impl); } // Creates a polymorphic matcher from its implementation. This is // easier to use than the PolymorphicMatcher constructor as it // doesn't require you to explicitly write the template argument, e.g. // // MakePolymorphicMatcher(foo); // vs // PolymorphicMatcher(foo); template inline PolymorphicMatcher MakePolymorphicMatcher(const Impl& impl) { return PolymorphicMatcher(impl); } // Anything inside the 'internal' namespace IS INTERNAL IMPLEMENTATION // and MUST NOT BE USED IN USER CODE!!! namespace internal { // The MatcherCastImpl class template is a helper for implementing // MatcherCast(). We need this helper in order to partially // specialize the implementation of MatcherCast() (C++ allows // class/struct templates to be partially specialized, but not // function templates.). // This general version is used when MatcherCast()'s argument is a // polymorphic matcher (i.e. something that can be converted to a // Matcher but is not one yet; for example, Eq(value)) or a value (for // example, "hello"). template class MatcherCastImpl { public: static Matcher Cast(const M& polymorphic_matcher_or_value) { // M can be a polymorhic matcher, in which case we want to use // its conversion operator to create Matcher. Or it can be a value // that should be passed to the Matcher's constructor. // // We can't call Matcher(polymorphic_matcher_or_value) when M is a // polymorphic matcher because it'll be ambiguous if T has an implicit // constructor from M (this usually happens when T has an implicit // constructor from any type). // // It won't work to unconditionally implict_cast // polymorphic_matcher_or_value to Matcher because it won't trigger // a user-defined conversion from M to T if one exists (assuming M is // a value). return CastImpl( polymorphic_matcher_or_value, BooleanConstant< internal::ImplicitlyConvertible >::value>()); } private: static Matcher CastImpl(const M& value, BooleanConstant) { // M can't be implicitly converted to Matcher, so M isn't a polymorphic // matcher. It must be a value then. Use direct initialization to create // a matcher. return Matcher(ImplicitCast_(value)); } static Matcher CastImpl(const M& polymorphic_matcher_or_value, BooleanConstant) { // M is implicitly convertible to Matcher, which means that either // M is a polymorhpic matcher or Matcher has an implicit constructor // from M. In both cases using the implicit conversion will produce a // matcher. // // Even if T has an implicit constructor from M, it won't be called because // creating Matcher would require a chain of two user-defined conversions // (first to create T from M and then to create Matcher from T). return polymorphic_matcher_or_value; } }; // This more specialized version is used when MatcherCast()'s argument // is already a Matcher. This only compiles when type T can be // statically converted to type U. template class MatcherCastImpl > { public: static Matcher Cast(const Matcher& source_matcher) { return Matcher(new Impl(source_matcher)); } private: class Impl : public MatcherInterface { public: explicit Impl(const Matcher& source_matcher) : source_matcher_(source_matcher) {} // We delegate the matching logic to the source matcher. virtual bool MatchAndExplain(T x, MatchResultListener* listener) const { return source_matcher_.MatchAndExplain(static_cast(x), listener); } virtual void DescribeTo(::std::ostream* os) const { source_matcher_.DescribeTo(os); } virtual void DescribeNegationTo(::std::ostream* os) const { source_matcher_.DescribeNegationTo(os); } private: const Matcher source_matcher_; GTEST_DISALLOW_ASSIGN_(Impl); }; }; // This even more specialized version is used for efficiently casting // a matcher to its own type. template class MatcherCastImpl > { public: static Matcher Cast(const Matcher& matcher) { return matcher; } }; } // namespace internal // In order to be safe and clear, casting between different matcher // types is done explicitly via MatcherCast(m), which takes a // matcher m and returns a Matcher. It compiles only when T can be // statically converted to the argument type of m. template inline Matcher MatcherCast(const M& matcher) { return internal::MatcherCastImpl::Cast(matcher); } // Implements SafeMatcherCast(). // // We use an intermediate class to do the actual safe casting as Nokia's // Symbian compiler cannot decide between // template ... (M) and // template ... (const Matcher&) // for function templates but can for member function templates. template class SafeMatcherCastImpl { public: // This overload handles polymorphic matchers and values only since // monomorphic matchers are handled by the next one. template static inline Matcher Cast(const M& polymorphic_matcher_or_value) { return internal::MatcherCastImpl::Cast(polymorphic_matcher_or_value); } // This overload handles monomorphic matchers. // // In general, if type T can be implicitly converted to type U, we can // safely convert a Matcher to a Matcher (i.e. Matcher is // contravariant): just keep a copy of the original Matcher, convert the // argument from type T to U, and then pass it to the underlying Matcher. // The only exception is when U is a reference and T is not, as the // underlying Matcher may be interested in the argument's address, which // is not preserved in the conversion from T to U. template static inline Matcher Cast(const Matcher& matcher) { // Enforce that T can be implicitly converted to U. GTEST_COMPILE_ASSERT_((internal::ImplicitlyConvertible::value), T_must_be_implicitly_convertible_to_U); // Enforce that we are not converting a non-reference type T to a reference // type U. GTEST_COMPILE_ASSERT_( internal::is_reference::value || !internal::is_reference::value, cannot_convert_non_referentce_arg_to_reference); // In case both T and U are arithmetic types, enforce that the // conversion is not lossy. typedef GTEST_REMOVE_REFERENCE_AND_CONST_(T) RawT; typedef GTEST_REMOVE_REFERENCE_AND_CONST_(U) RawU; const bool kTIsOther = GMOCK_KIND_OF_(RawT) == internal::kOther; const bool kUIsOther = GMOCK_KIND_OF_(RawU) == internal::kOther; GTEST_COMPILE_ASSERT_( kTIsOther || kUIsOther || (internal::LosslessArithmeticConvertible::value), conversion_of_arithmetic_types_must_be_lossless); return MatcherCast(matcher); } }; template inline Matcher SafeMatcherCast(const M& polymorphic_matcher) { return SafeMatcherCastImpl::Cast(polymorphic_matcher); } // A() returns a matcher that matches any value of type T. template Matcher A(); // Anything inside the 'internal' namespace IS INTERNAL IMPLEMENTATION // and MUST NOT BE USED IN USER CODE!!! namespace internal { // If the explanation is not empty, prints it to the ostream. inline void PrintIfNotEmpty(const internal::string& explanation, ::std::ostream* os) { if (explanation != "" && os != NULL) { *os << ", " << explanation; } } // Returns true if the given type name is easy to read by a human. // This is used to decide whether printing the type of a value might // be helpful. inline bool IsReadableTypeName(const string& type_name) { // We consider a type name readable if it's short or doesn't contain // a template or function type. return (type_name.length() <= 20 || type_name.find_first_of("<(") == string::npos); } // Matches the value against the given matcher, prints the value and explains // the match result to the listener. Returns the match result. // 'listener' must not be NULL. // Value cannot be passed by const reference, because some matchers take a // non-const argument. template bool MatchPrintAndExplain(Value& value, const Matcher& matcher, MatchResultListener* listener) { if (!listener->IsInterested()) { // If the listener is not interested, we do not need to construct the // inner explanation. return matcher.Matches(value); } StringMatchResultListener inner_listener; const bool match = matcher.MatchAndExplain(value, &inner_listener); UniversalPrint(value, listener->stream()); #if GTEST_HAS_RTTI const string& type_name = GetTypeName(); if (IsReadableTypeName(type_name)) *listener->stream() << " (of type " << type_name << ")"; #endif PrintIfNotEmpty(inner_listener.str(), listener->stream()); return match; } // An internal helper class for doing compile-time loop on a tuple's // fields. template class TuplePrefix { public: // TuplePrefix::Matches(matcher_tuple, value_tuple) returns true // iff the first N fields of matcher_tuple matches the first N // fields of value_tuple, respectively. template static bool Matches(const MatcherTuple& matcher_tuple, const ValueTuple& value_tuple) { return TuplePrefix::Matches(matcher_tuple, value_tuple) && get(matcher_tuple).Matches(get(value_tuple)); } // TuplePrefix::ExplainMatchFailuresTo(matchers, values, os) // describes failures in matching the first N fields of matchers // against the first N fields of values. If there is no failure, // nothing will be streamed to os. template static void ExplainMatchFailuresTo(const MatcherTuple& matchers, const ValueTuple& values, ::std::ostream* os) { // First, describes failures in the first N - 1 fields. TuplePrefix::ExplainMatchFailuresTo(matchers, values, os); // Then describes the failure (if any) in the (N - 1)-th (0-based) // field. typename tuple_element::type matcher = get(matchers); typedef typename tuple_element::type Value; Value value = get(values); StringMatchResultListener listener; if (!matcher.MatchAndExplain(value, &listener)) { // TODO(wan): include in the message the name of the parameter // as used in MOCK_METHOD*() when possible. *os << " Expected arg #" << N - 1 << ": "; get(matchers).DescribeTo(os); *os << "\n Actual: "; // We remove the reference in type Value to prevent the // universal printer from printing the address of value, which // isn't interesting to the user most of the time. The // matcher's MatchAndExplain() method handles the case when // the address is interesting. internal::UniversalPrint(value, os); PrintIfNotEmpty(listener.str(), os); *os << "\n"; } } }; // The base case. template <> class TuplePrefix<0> { public: template static bool Matches(const MatcherTuple& /* matcher_tuple */, const ValueTuple& /* value_tuple */) { return true; } template static void ExplainMatchFailuresTo(const MatcherTuple& /* matchers */, const ValueTuple& /* values */, ::std::ostream* /* os */) {} }; // TupleMatches(matcher_tuple, value_tuple) returns true iff all // matchers in matcher_tuple match the corresponding fields in // value_tuple. It is a compiler error if matcher_tuple and // value_tuple have different number of fields or incompatible field // types. template bool TupleMatches(const MatcherTuple& matcher_tuple, const ValueTuple& value_tuple) { // Makes sure that matcher_tuple and value_tuple have the same // number of fields. GTEST_COMPILE_ASSERT_(tuple_size::value == tuple_size::value, matcher_and_value_have_different_numbers_of_fields); return TuplePrefix::value>:: Matches(matcher_tuple, value_tuple); } // Describes failures in matching matchers against values. If there // is no failure, nothing will be streamed to os. template void ExplainMatchFailureTupleTo(const MatcherTuple& matchers, const ValueTuple& values, ::std::ostream* os) { TuplePrefix::value>::ExplainMatchFailuresTo( matchers, values, os); } // TransformTupleValues and its helper. // // TransformTupleValuesHelper hides the internal machinery that // TransformTupleValues uses to implement a tuple traversal. template class TransformTupleValuesHelper { private: typedef ::testing::tuple_size TupleSize; public: // For each member of tuple 't', taken in order, evaluates '*out++ = f(t)'. // Returns the final value of 'out' in case the caller needs it. static OutIter Run(Func f, const Tuple& t, OutIter out) { return IterateOverTuple()(f, t, out); } private: template struct IterateOverTuple { OutIter operator() (Func f, const Tup& t, OutIter out) const { *out++ = f(::testing::get(t)); return IterateOverTuple()(f, t, out); } }; template struct IterateOverTuple { OutIter operator() (Func /* f */, const Tup& /* t */, OutIter out) const { return out; } }; }; // Successively invokes 'f(element)' on each element of the tuple 't', // appending each result to the 'out' iterator. Returns the final value // of 'out'. template OutIter TransformTupleValues(Func f, const Tuple& t, OutIter out) { return TransformTupleValuesHelper::Run(f, t, out); } // Implements A(). template class AnyMatcherImpl : public MatcherInterface { public: virtual bool MatchAndExplain( T /* x */, MatchResultListener* /* listener */) const { return true; } virtual void DescribeTo(::std::ostream* os) const { *os << "is anything"; } virtual void DescribeNegationTo(::std::ostream* os) const { // This is mostly for completeness' safe, as it's not very useful // to write Not(A()). However we cannot completely rule out // such a possibility, and it doesn't hurt to be prepared. *os << "never matches"; } }; // Implements _, a matcher that matches any value of any // type. This is a polymorphic matcher, so we need a template type // conversion operator to make it appearing as a Matcher for any // type T. class AnythingMatcher { public: template operator Matcher() const { return A(); } }; // Implements a matcher that compares a given value with a // pre-supplied value using one of the ==, <=, <, etc, operators. The // two values being compared don't have to have the same type. // // The matcher defined here is polymorphic (for example, Eq(5) can be // used to match an int, a short, a double, etc). Therefore we use // a template type conversion operator in the implementation. // // The following template definition assumes that the Rhs parameter is // a "bare" type (i.e. neither 'const T' nor 'T&'). template class ComparisonBase { public: explicit ComparisonBase(const Rhs& rhs) : rhs_(rhs) {} template operator Matcher() const { return MakeMatcher(new Impl(rhs_)); } private: template class Impl : public MatcherInterface { public: explicit Impl(const Rhs& rhs) : rhs_(rhs) {} virtual bool MatchAndExplain( Lhs lhs, MatchResultListener* /* listener */) const { return Op()(lhs, rhs_); } virtual void DescribeTo(::std::ostream* os) const { *os << D::Desc() << " "; UniversalPrint(rhs_, os); } virtual void DescribeNegationTo(::std::ostream* os) const { *os << D::NegatedDesc() << " "; UniversalPrint(rhs_, os); } private: Rhs rhs_; GTEST_DISALLOW_ASSIGN_(Impl); }; Rhs rhs_; GTEST_DISALLOW_ASSIGN_(ComparisonBase); }; template class EqMatcher : public ComparisonBase, Rhs, AnyEq> { public: explicit EqMatcher(const Rhs& rhs) : ComparisonBase, Rhs, AnyEq>(rhs) { } static const char* Desc() { return "is equal to"; } static const char* NegatedDesc() { return "isn't equal to"; } }; template class NeMatcher : public ComparisonBase, Rhs, AnyNe> { public: explicit NeMatcher(const Rhs& rhs) : ComparisonBase, Rhs, AnyNe>(rhs) { } static const char* Desc() { return "isn't equal to"; } static const char* NegatedDesc() { return "is equal to"; } }; template class LtMatcher : public ComparisonBase, Rhs, AnyLt> { public: explicit LtMatcher(const Rhs& rhs) : ComparisonBase, Rhs, AnyLt>(rhs) { } static const char* Desc() { return "is <"; } static const char* NegatedDesc() { return "isn't <"; } }; template class GtMatcher : public ComparisonBase, Rhs, AnyGt> { public: explicit GtMatcher(const Rhs& rhs) : ComparisonBase, Rhs, AnyGt>(rhs) { } static const char* Desc() { return "is >"; } static const char* NegatedDesc() { return "isn't >"; } }; template class LeMatcher : public ComparisonBase, Rhs, AnyLe> { public: explicit LeMatcher(const Rhs& rhs) : ComparisonBase, Rhs, AnyLe>(rhs) { } static const char* Desc() { return "is <="; } static const char* NegatedDesc() { return "isn't <="; } }; template class GeMatcher : public ComparisonBase, Rhs, AnyGe> { public: explicit GeMatcher(const Rhs& rhs) : ComparisonBase, Rhs, AnyGe>(rhs) { } static const char* Desc() { return "is >="; } static const char* NegatedDesc() { return "isn't >="; } }; // Implements the polymorphic IsNull() matcher, which matches any raw or smart // pointer that is NULL. class IsNullMatcher { public: template bool MatchAndExplain(const Pointer& p, MatchResultListener* /* listener */) const { #if GTEST_LANG_CXX11 return p == nullptr; #else // GTEST_LANG_CXX11 return GetRawPointer(p) == NULL; #endif // GTEST_LANG_CXX11 } void DescribeTo(::std::ostream* os) const { *os << "is NULL"; } void DescribeNegationTo(::std::ostream* os) const { *os << "isn't NULL"; } }; // Implements the polymorphic NotNull() matcher, which matches any raw or smart // pointer that is not NULL. class NotNullMatcher { public: template bool MatchAndExplain(const Pointer& p, MatchResultListener* /* listener */) const { #if GTEST_LANG_CXX11 return p != nullptr; #else // GTEST_LANG_CXX11 return GetRawPointer(p) != NULL; #endif // GTEST_LANG_CXX11 } void DescribeTo(::std::ostream* os) const { *os << "isn't NULL"; } void DescribeNegationTo(::std::ostream* os) const { *os << "is NULL"; } }; // Ref(variable) matches any argument that is a reference to // 'variable'. This matcher is polymorphic as it can match any // super type of the type of 'variable'. // // The RefMatcher template class implements Ref(variable). It can // only be instantiated with a reference type. This prevents a user // from mistakenly using Ref(x) to match a non-reference function // argument. For example, the following will righteously cause a // compiler error: // // int n; // Matcher m1 = Ref(n); // This won't compile. // Matcher m2 = Ref(n); // This will compile. template class RefMatcher; template class RefMatcher { // Google Mock is a generic framework and thus needs to support // mocking any function types, including those that take non-const // reference arguments. Therefore the template parameter T (and // Super below) can be instantiated to either a const type or a // non-const type. public: // RefMatcher() takes a T& instead of const T&, as we want the // compiler to catch using Ref(const_value) as a matcher for a // non-const reference. explicit RefMatcher(T& x) : object_(x) {} // NOLINT template operator Matcher() const { // By passing object_ (type T&) to Impl(), which expects a Super&, // we make sure that Super is a super type of T. In particular, // this catches using Ref(const_value) as a matcher for a // non-const reference, as you cannot implicitly convert a const // reference to a non-const reference. return MakeMatcher(new Impl(object_)); } private: template class Impl : public MatcherInterface { public: explicit Impl(Super& x) : object_(x) {} // NOLINT // MatchAndExplain() takes a Super& (as opposed to const Super&) // in order to match the interface MatcherInterface. virtual bool MatchAndExplain( Super& x, MatchResultListener* listener) const { *listener << "which is located @" << static_cast(&x); return &x == &object_; } virtual void DescribeTo(::std::ostream* os) const { *os << "references the variable "; UniversalPrinter::Print(object_, os); } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "does not reference the variable "; UniversalPrinter::Print(object_, os); } private: const Super& object_; GTEST_DISALLOW_ASSIGN_(Impl); }; T& object_; GTEST_DISALLOW_ASSIGN_(RefMatcher); }; // Polymorphic helper functions for narrow and wide string matchers. inline bool CaseInsensitiveCStringEquals(const char* lhs, const char* rhs) { return String::CaseInsensitiveCStringEquals(lhs, rhs); } inline bool CaseInsensitiveCStringEquals(const wchar_t* lhs, const wchar_t* rhs) { return String::CaseInsensitiveWideCStringEquals(lhs, rhs); } // String comparison for narrow or wide strings that can have embedded NUL // characters. template bool CaseInsensitiveStringEquals(const StringType& s1, const StringType& s2) { // Are the heads equal? if (!CaseInsensitiveCStringEquals(s1.c_str(), s2.c_str())) { return false; } // Skip the equal heads. const typename StringType::value_type nul = 0; const size_t i1 = s1.find(nul), i2 = s2.find(nul); // Are we at the end of either s1 or s2? if (i1 == StringType::npos || i2 == StringType::npos) { return i1 == i2; } // Are the tails equal? return CaseInsensitiveStringEquals(s1.substr(i1 + 1), s2.substr(i2 + 1)); } // String matchers. // Implements equality-based string matchers like StrEq, StrCaseNe, and etc. template class StrEqualityMatcher { public: StrEqualityMatcher(const StringType& str, bool expect_eq, bool case_sensitive) : string_(str), expect_eq_(expect_eq), case_sensitive_(case_sensitive) {} // Accepts pointer types, particularly: // const char* // char* // const wchar_t* // wchar_t* template bool MatchAndExplain(CharType* s, MatchResultListener* listener) const { if (s == NULL) { return !expect_eq_; } return MatchAndExplain(StringType(s), listener); } // Matches anything that can convert to StringType. // // This is a template, not just a plain function with const StringType&, // because StringPiece has some interfering non-explicit constructors. template bool MatchAndExplain(const MatcheeStringType& s, MatchResultListener* /* listener */) const { const StringType& s2(s); const bool eq = case_sensitive_ ? s2 == string_ : CaseInsensitiveStringEquals(s2, string_); return expect_eq_ == eq; } void DescribeTo(::std::ostream* os) const { DescribeToHelper(expect_eq_, os); } void DescribeNegationTo(::std::ostream* os) const { DescribeToHelper(!expect_eq_, os); } private: void DescribeToHelper(bool expect_eq, ::std::ostream* os) const { *os << (expect_eq ? "is " : "isn't "); *os << "equal to "; if (!case_sensitive_) { *os << "(ignoring case) "; } UniversalPrint(string_, os); } const StringType string_; const bool expect_eq_; const bool case_sensitive_; GTEST_DISALLOW_ASSIGN_(StrEqualityMatcher); }; // Implements the polymorphic HasSubstr(substring) matcher, which // can be used as a Matcher as long as T can be converted to a // string. template class HasSubstrMatcher { public: explicit HasSubstrMatcher(const StringType& substring) : substring_(substring) {} // Accepts pointer types, particularly: // const char* // char* // const wchar_t* // wchar_t* template bool MatchAndExplain(CharType* s, MatchResultListener* listener) const { return s != NULL && MatchAndExplain(StringType(s), listener); } // Matches anything that can convert to StringType. // // This is a template, not just a plain function with const StringType&, // because StringPiece has some interfering non-explicit constructors. template bool MatchAndExplain(const MatcheeStringType& s, MatchResultListener* /* listener */) const { const StringType& s2(s); return s2.find(substring_) != StringType::npos; } // Describes what this matcher matches. void DescribeTo(::std::ostream* os) const { *os << "has substring "; UniversalPrint(substring_, os); } void DescribeNegationTo(::std::ostream* os) const { *os << "has no substring "; UniversalPrint(substring_, os); } private: const StringType substring_; GTEST_DISALLOW_ASSIGN_(HasSubstrMatcher); }; // Implements the polymorphic StartsWith(substring) matcher, which // can be used as a Matcher as long as T can be converted to a // string. template class StartsWithMatcher { public: explicit StartsWithMatcher(const StringType& prefix) : prefix_(prefix) { } // Accepts pointer types, particularly: // const char* // char* // const wchar_t* // wchar_t* template bool MatchAndExplain(CharType* s, MatchResultListener* listener) const { return s != NULL && MatchAndExplain(StringType(s), listener); } // Matches anything that can convert to StringType. // // This is a template, not just a plain function with const StringType&, // because StringPiece has some interfering non-explicit constructors. template bool MatchAndExplain(const MatcheeStringType& s, MatchResultListener* /* listener */) const { const StringType& s2(s); return s2.length() >= prefix_.length() && s2.substr(0, prefix_.length()) == prefix_; } void DescribeTo(::std::ostream* os) const { *os << "starts with "; UniversalPrint(prefix_, os); } void DescribeNegationTo(::std::ostream* os) const { *os << "doesn't start with "; UniversalPrint(prefix_, os); } private: const StringType prefix_; GTEST_DISALLOW_ASSIGN_(StartsWithMatcher); }; // Implements the polymorphic EndsWith(substring) matcher, which // can be used as a Matcher as long as T can be converted to a // string. template class EndsWithMatcher { public: explicit EndsWithMatcher(const StringType& suffix) : suffix_(suffix) {} // Accepts pointer types, particularly: // const char* // char* // const wchar_t* // wchar_t* template bool MatchAndExplain(CharType* s, MatchResultListener* listener) const { return s != NULL && MatchAndExplain(StringType(s), listener); } // Matches anything that can convert to StringType. // // This is a template, not just a plain function with const StringType&, // because StringPiece has some interfering non-explicit constructors. template bool MatchAndExplain(const MatcheeStringType& s, MatchResultListener* /* listener */) const { const StringType& s2(s); return s2.length() >= suffix_.length() && s2.substr(s2.length() - suffix_.length()) == suffix_; } void DescribeTo(::std::ostream* os) const { *os << "ends with "; UniversalPrint(suffix_, os); } void DescribeNegationTo(::std::ostream* os) const { *os << "doesn't end with "; UniversalPrint(suffix_, os); } private: const StringType suffix_; GTEST_DISALLOW_ASSIGN_(EndsWithMatcher); }; // Implements polymorphic matchers MatchesRegex(regex) and // ContainsRegex(regex), which can be used as a Matcher as long as // T can be converted to a string. class MatchesRegexMatcher { public: MatchesRegexMatcher(const RE* regex, bool full_match) : regex_(regex), full_match_(full_match) {} // Accepts pointer types, particularly: // const char* // char* // const wchar_t* // wchar_t* template bool MatchAndExplain(CharType* s, MatchResultListener* listener) const { return s != NULL && MatchAndExplain(internal::string(s), listener); } // Matches anything that can convert to internal::string. // // This is a template, not just a plain function with const internal::string&, // because StringPiece has some interfering non-explicit constructors. template bool MatchAndExplain(const MatcheeStringType& s, MatchResultListener* /* listener */) const { const internal::string& s2(s); return full_match_ ? RE::FullMatch(s2, *regex_) : RE::PartialMatch(s2, *regex_); } void DescribeTo(::std::ostream* os) const { *os << (full_match_ ? "matches" : "contains") << " regular expression "; UniversalPrinter::Print(regex_->pattern(), os); } void DescribeNegationTo(::std::ostream* os) const { *os << "doesn't " << (full_match_ ? "match" : "contain") << " regular expression "; UniversalPrinter::Print(regex_->pattern(), os); } private: const internal::linked_ptr regex_; const bool full_match_; GTEST_DISALLOW_ASSIGN_(MatchesRegexMatcher); }; // Implements a matcher that compares the two fields of a 2-tuple // using one of the ==, <=, <, etc, operators. The two fields being // compared don't have to have the same type. // // The matcher defined here is polymorphic (for example, Eq() can be // used to match a tuple, a tuple, // etc). Therefore we use a template type conversion operator in the // implementation. template class PairMatchBase { public: template operator Matcher< ::testing::tuple >() const { return MakeMatcher(new Impl< ::testing::tuple >); } template operator Matcher&>() const { return MakeMatcher(new Impl&>); } private: static ::std::ostream& GetDesc(::std::ostream& os) { // NOLINT return os << D::Desc(); } template class Impl : public MatcherInterface { public: virtual bool MatchAndExplain( Tuple args, MatchResultListener* /* listener */) const { return Op()(::testing::get<0>(args), ::testing::get<1>(args)); } virtual void DescribeTo(::std::ostream* os) const { *os << "are " << GetDesc; } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "aren't " << GetDesc; } }; }; class Eq2Matcher : public PairMatchBase { public: static const char* Desc() { return "an equal pair"; } }; class Ne2Matcher : public PairMatchBase { public: static const char* Desc() { return "an unequal pair"; } }; class Lt2Matcher : public PairMatchBase { public: static const char* Desc() { return "a pair where the first < the second"; } }; class Gt2Matcher : public PairMatchBase { public: static const char* Desc() { return "a pair where the first > the second"; } }; class Le2Matcher : public PairMatchBase { public: static const char* Desc() { return "a pair where the first <= the second"; } }; class Ge2Matcher : public PairMatchBase { public: static const char* Desc() { return "a pair where the first >= the second"; } }; // Implements the Not(...) matcher for a particular argument type T. // We do not nest it inside the NotMatcher class template, as that // will prevent different instantiations of NotMatcher from sharing // the same NotMatcherImpl class. template class NotMatcherImpl : public MatcherInterface { public: explicit NotMatcherImpl(const Matcher& matcher) : matcher_(matcher) {} virtual bool MatchAndExplain(T x, MatchResultListener* listener) const { return !matcher_.MatchAndExplain(x, listener); } virtual void DescribeTo(::std::ostream* os) const { matcher_.DescribeNegationTo(os); } virtual void DescribeNegationTo(::std::ostream* os) const { matcher_.DescribeTo(os); } private: const Matcher matcher_; GTEST_DISALLOW_ASSIGN_(NotMatcherImpl); }; // Implements the Not(m) matcher, which matches a value that doesn't // match matcher m. template class NotMatcher { public: explicit NotMatcher(InnerMatcher matcher) : matcher_(matcher) {} // This template type conversion operator allows Not(m) to be used // to match any type m can match. template operator Matcher() const { return Matcher(new NotMatcherImpl(SafeMatcherCast(matcher_))); } private: InnerMatcher matcher_; GTEST_DISALLOW_ASSIGN_(NotMatcher); }; // Implements the AllOf(m1, m2) matcher for a particular argument type // T. We do not nest it inside the BothOfMatcher class template, as // that will prevent different instantiations of BothOfMatcher from // sharing the same BothOfMatcherImpl class. template class BothOfMatcherImpl : public MatcherInterface { public: BothOfMatcherImpl(const Matcher& matcher1, const Matcher& matcher2) : matcher1_(matcher1), matcher2_(matcher2) {} virtual void DescribeTo(::std::ostream* os) const { *os << "("; matcher1_.DescribeTo(os); *os << ") and ("; matcher2_.DescribeTo(os); *os << ")"; } virtual void DescribeNegationTo(::std::ostream* os) const { *os << "("; matcher1_.DescribeNegationTo(os); *os << ") or ("; matcher2_.DescribeNegationTo(os); *os << ")"; } virtual bool MatchAndExplain(T x, MatchResultListener* listener) const { // If either matcher1_ or matcher2_ doesn't match x, we only need // to explain why one of them fails. StringMatchResultListener listener1; if (!matcher1_.MatchAndExplain(x, &listener1)) { *listener << listener1.str(); return false; } StringMatchResultListener listener2; if (!matcher2_.MatchAndExplain(x, &listener2)) { *listener << listener2.str(); return false; } // Otherwise we need to explain why *both* of them match. const internal::string s1 = listener1.str(); const internal::string s2 = listener2.str(); if (s1 == "") { *listener << s2; } else { *listener << s1; if (s2 != "") { *listener << ", and " << s2; } } return true; } private: const Matcher matcher1_; const Matcher matcher2_; GTEST_DISALLOW_ASSIGN_(BothOfMatcherImpl); }; #if GTEST_LANG_CXX11 // MatcherList provides mechanisms for storing a variable number of matchers in // a list structure (ListType) and creating a combining matcher from such a // list. // The template is defined recursively using the following template paramters: // * kSize is the length of the MatcherList. // * Head is the type of the first matcher of the list. // * Tail denotes the types of the remaining matchers of the list. template struct MatcherList { typedef MatcherList MatcherListTail; typedef ::std::pair ListType; // BuildList stores variadic type values in a nested pair structure. // Example: // MatcherList<3, int, string, float>::BuildList(5, "foo", 2.0) will return // the corresponding result of type pair>. static ListType BuildList(const Head& matcher, const Tail&... tail) { return ListType(matcher, MatcherListTail::BuildList(tail...)); } // CreateMatcher creates a Matcher from a given list of matchers (built // by BuildList()). CombiningMatcher is used to combine the matchers of the // list. CombiningMatcher must implement MatcherInterface and have a // constructor taking two Matchers as input. template class CombiningMatcher> static Matcher CreateMatcher(const ListType& matchers) { return Matcher(new CombiningMatcher( SafeMatcherCast(matchers.first), MatcherListTail::template CreateMatcher( matchers.second))); } }; // The following defines the base case for the recursive definition of // MatcherList. template struct MatcherList<2, Matcher1, Matcher2> { typedef ::std::pair ListType; static ListType BuildList(const Matcher1& matcher1, const Matcher2& matcher2) { return ::std::pair(matcher1, matcher2); } template class CombiningMatcher> static Matcher CreateMatcher(const ListType& matchers) { return Matcher(new CombiningMatcher( SafeMatcherCast(matchers.first), SafeMatcherCast(matchers.second))); } }; // VariadicMatcher is used for the variadic implementation of // AllOf(m_1, m_2, ...) and AnyOf(m_1, m_2, ...). // CombiningMatcher is used to recursively combine the provided matchers // (of type Args...). template