mirror of
https://github.com/ceph/ceph
synced 2024-12-20 02:13:04 +00:00
Ceph is a distributed object, block, and file storage platform
fb472a57c6
Implement unit tests covering most lines of code ( > 92% ) and all methods as show by the output of make check-coverage : http://dachary.org/wp-uploads/2013/03/ceph-lcov/ . The following static constructors are implemented by opaque classes defined in buffer.cc ( buffer::raw_char, buffer::raw_posix_aligned etc. ). Testing the implementation of these classes is done by variations of the calls to the static constructors. copy(const char *c, unsigned len); create(unsigned len); claim_char(unsigned len, char *buf); create_malloc(unsigned len); claim_malloc(unsigned len, char *buf); create_static(unsigned len, char *buf); create_page_aligned(unsigned len); The raw_mmap_pages class cannot be tested because it is commented out in raw_posix_aligned. The raw_hack_aligned class is only tested under Cygwin. The raw_posix_aligned class is not tested under Cygwin. The unittest_bufferlist.sh script calls unittest_bufferlist with the CEPH_BUFFER_TRACK=true environment variable to enable the code tracking the memory usage. It cannot be done within the bufferlist.cc file itself because it relies on the initialization of a global variable ( buffer_track_alloc ). When raw_posix_aligned is called on DARWIN, the data is not aligned on CEPH_PAGE_SIZE because it calls valloc(size) which is the equivalent of memalign(sysconf(_SC_PAGESIZE),size) and not memalign(CEPH_PAGE_SIZE,size). For this reason the alignment test is de-activated on DARWIN. The tests are grouped in TEST(BufferPtr, ... ) for buffer::ptr TEST(BufferListIterator, ...) for buffer::list::iterator TEST(BufferList, ...) for buffer::list TEST(BufferHash, ...) for buffer::hash and each method ( and all variations of the prototype ) are included into a single TEST() function. Although most aspects of the methods are tested, including exceptions and border cases, inconsistencies are not highlighted . For instance buffer::list::iterator i; i.advance(1); would dereference a buffer::raw NULL pointer although buffer::ptr p; p.wasted() asserts instead of dereferencing the buffer::raw NULL pointer. It would be better to always assert in case a NULL pointer is about to be used. But this is a minor inconsistency that is probably not worth a test. The following buffer::list methods ssize_t read_fd(int fd, size_t len); int write_fd(int fd) const; are not fully tested because the border cases cannot be reliably reproduced. Going thru a pointer indirection when calling the ::writev or safe_read functions would allow the test to create mockups to synthetize the conditions for border cases. tracker.ceph.com/issues/4066 refs #4066 Signed-off-by: Loic Dachary <loic@dachary.org> |
||
|---|---|---|
| admin | ||
| ceph-object-corpus@7f23ee1127 | ||
| debian | ||
| doc | ||
| fusetrace | ||
| keys | ||
| m4 | ||
| man | ||
| qa | ||
| src | ||
| udev | ||
| wireshark | ||
| .gitignore | ||
| .gitmodules | ||
| AUTHORS | ||
| autogen.sh | ||
| ceph.spec.in | ||
| ChangeLog | ||
| CodingStyle | ||
| configure.ac | ||
| COPYING | ||
| COPYING-LGPL2.1 | ||
| do_autogen.sh | ||
| Doxyfile | ||
| INSTALL | ||
| Makefile.am | ||
| NEWS | ||
| PendingReleaseNotes | ||
| README | ||
| RELEASE_CHECKLIST | ||
| SubmittingPatches | ||
============================================ Ceph - a scalable distributed storage system ============================================ Please see http://ceph.com/ for current info. Contributing Code ================= Most of Ceph is licensed under the LGPL version 2.1. Some miscellaneous code is under BSD-style license or is public domain. The documentation is licensed under Creative Commons Attribution-ShareAlike (CC BY-SA). There are a handful of headers included here that are licensed under the GPL. Please see the file COPYING for a full inventory of licenses by file. Code contributions must include a valid "Signed-off-by" acknowledging the license for the modified or contributed file. Please see the file SubmittingPatches for details on what that means and on how to generate and submit patches. We do not require assignment of copyright to contribute code; code is contributed under the terms of the applicable license. Building Ceph ============= To prepare the source tree after it has been git cloned, $ git submodule update --init To build the server daemons, and FUSE client, execute the following: $ ./autogen.sh $ ./configure $ make (Note that the FUSE client will only be built if libfuse is present.) Dependencies ------------ The configure script will complain about any missing dependencies as it goes. You can also refer to debian/control or ceph.spec.in for the package build dependencies on those platforms. In many cases, dependencies can be avoided with --with-foo or --without-bar switches. For example, $ ./configure --with-nss # use libnss instead of libcrypto++ $ ./configure --without-radosgw # do not build radosgw and avoid libfcgi-dev $ ./configure --without-tcmalloc # avoid google-perftools dependency Building packages ----------------- You can build packages for Debian or Debian-derived (e.g., Ubuntu) systems with $ sudo apt-get dpkg-dev $ dpkg-checkbuilddeps # make sure we have all dependencies $ dpkg-buildpackage For RPM-based systems (Redhat, Suse, etc.), $ rpmbuild Building the Documentation ========================== Prerequisites ------------- To build the documentation, you must install the following: - python-dev - python-pip - python-virualenv - doxygen - ditaa - libxml2-dev - libxslt-dev - dot - graphviz For example: sudo apt-get install python-dev python-pip python-virualenv doxygen ditaa libxml2-dev libxslt-dev dot graphviz Building the Documentation -------------------------- To build the documentation, ensure that you are in the top-level `/ceph directory, and execute the build script. For example: $ admin/build-doc Build Prerequisites ------------------- To build the source code, you must install the following: - automake - autoconf - automake - gcc - g++ - libboost-dev - libedit-dev - libssl-dev - libtool - libfcgi - libfcgi-dev - libfuse-dev - linux-kernel-headers - libcrypto++-dev - libaio-dev - libgoogle-perftools-dev - libkeyutils-dev - uuid-dev - libatomic-ops-dev - libboost-program-options-dev - libboost-thread-dev - libexpat1-dev For example: $ apt-get install automake autoconf automake gcc g++ libboost-dev libedit-dev libssl-dev libtool libfcgi libfcgi-dev libfuse-dev linux-kernel-headers libcrypto++-dev libaio-dev libgoogle-perftools-dev libkeyutils-dev uuid-dev libatomic-ops-dev libboost-program-options-dev libboost-thread-dev libexpat1-dev