If you run the tests locally, you will probably want to run them without the
store-* cargo features, because many of the DataStore tests rely on outside
services like S3, Redis, etc.
You will almost always want to run the tests with the encryption and
compression features enabled, because the way the test suite is architectured
means that most of the tests require those features.
If you want to run tests for the different DataStore implementations, you will
need to provide the necessary services, either mocked or real, for them to test
against. You can configure the following environment variables to do this.
Below is a table of what those environment variables are and what Cargo features they are associated with. The variables only need to be set if their corresponding Cargo features are enabled when running the test suite. You can specify these environment variables in a dotenv file and they will be loaded automatically.
| Variable | Description | Feature |
|---|---|---|
REDIS_URL |
The redis:// URL of the Redis server to test against. |
store-redis |
S3_BUCKET |
The name of the S3 bucket to test against. | store-s3 |
S3_REGION |
The name of the AWS region containing the S3 bucket. | store-s3 |
S3_ACCESS_KEY |
The access key ID for accessing the S3 bucket. | store-s3 |
S3_SECRET_KEY |
The secret access key for accessing the S3 bucket. | store-s3 |
RCLONE_REMOTE |
The <remote>:<path> string for the rclone remote to test against. |
store-rclone |
SFTP_SERVER |
The URL of the SFTP server to test against. | store-sftp |
SFTP_PATH |
The path to use on the SFTP server. | store-sftp |
SFTP_USERNAME |
The username to access the SFTP server. | store-sftp |
SFTP_PASSWORD |
The password to access the SFTP server. | store-sftp |
To test the FUSE file system implementation provided by this library, the
/fuse-test directory contains a Dockerfile which provides a test environment
containing a number of file system testing
tools. The Dockerfile builds your
local clone of acid-store and provides a binary which mounts a FUSE file
system backed by an in-memory data store. To mount the FUSE file system, the
container needs special permissions and access to the host's /dev/fuse device.
Depending on your system configuration, these commands may need to be run as root.
To build the docker image:
docker build -t fuse-test -f ./fuse-test/Dockerfile .fstest is a file system testing tool originally written by Pawel Jakub Dawidek
for FreeBSD and since ported to Linux. It tests compliance with a wide range of
POSIX system calls. To run it against the FUSE file system with some patches
applied to support acid-store, run:
docker run -it --rm --device /dev/fuse --cap-add SYS_ADMIN --security-opt apparmor:unconfined fuse-test ./fstest.shfsx is a file system testing tool by Apple that specifically tests reading and
writing to files. You'll probably want to take a look at its usage
documentation, which you can see by running the ./fsx.sh script with no
arguments. This is a stress testing tool, so by default it runs indefinitely. It
requires the path of a regular file to test against, and there is one provided
in the script's working directory at ./test-file.
To run this tool in verbose mode, run:
docker run -it --rm --device /dev/fuse --cap-add SYS_ADMIN --security-opt apparmor:unconfined fuse-test ./fsx.sh -v ./test-fileIf you want to play with some of the other tools provided in the environment, you can run this command to start an interactive shell.
docker run -it --rm --device /dev/fuse --cap-add SYS_ADMIN --security-opt apparmor:unconfined fuse-test bashFrom there, you can mount the FUSE file system in the container using the
provided fuse-mount binary.
mkdir ./mnt
./fuse-mount ./mnt &When building the documentation normally, markers which identify which features are required to use various parts of the library will be missing. That is because this is an unstable feature of rustdoc that happens to be enabled in docs.rs. To build the documentation with these markers, run the following command:
RUSTDOCFLAGS='--cfg docsrs' cargo +nightly doc --all-features