1 Programs and scripts for automated testing of LZ4 2 ======================================================= 3 4 This directory contains the following programs and scripts: 5 - `datagen` : Synthetic and parametrable data generator, for tests 6 - `frametest` : Test tool that checks lz4frame integrity on target platform 7 - `fullbench` : Precisely measure speed for each lz4 inner functions 8 - `fuzzer` : Test tool, to check lz4 integrity on target platform 9 - `test-lz4-speed.py` : script for testing lz4 speed difference between commits 10 - `test-lz4-versions.py` : compatibility test between lz4 versions stored on Github 11 12 13 #### `test-lz4-versions.py` - script for testing lz4 interoperability between versions 14 15 This script creates `versionsTest` directory to which lz4 repository is cloned. 16 Then all taged (released) versions of lz4 are compiled. 17 In the following step interoperability between lz4 versions is checked. 18 19 20 #### `test-lz4-speed.py` - script for testing lz4 speed difference between commits 21 22 This script creates `speedTest` directory to which lz4 repository is cloned. 23 Then it compiles all branches of lz4 and performs a speed benchmark for a given list of files (the `testFileNames` parameter). 24 After `sleepTime` (an optional parameter, default 300 seconds) seconds the script checks repository for new commits. 25 If a new commit is found it is compiled and a speed benchmark for this commit is performed. 26 The results of the speed benchmark are compared to the previous results. 27 If compression or decompression speed for one of lz4 levels is lower than `lowerLimit` (an optional parameter, default 0.98) the speed benchmark is restarted. 28 If second results are also lower than `lowerLimit` the warning e-mail is send to recipients from the list (the `emails` parameter). 29 30 Additional remarks: 31 - To be sure that speed results are accurate the script should be run on a "stable" target system with no other jobs running in parallel 32 - Using the script with virtual machines can lead to large variations of speed results 33 - The speed benchmark is not performed until computers' load average is lower than `maxLoadAvg` (an optional parameter, default 0.75) 34 - The script sends e-mails using `mutt`; if `mutt` is not available it sends e-mails without attachments using `mail`; if both are not available it only prints a warning 35 36 37 The example usage with two test files, one e-mail address, and with an additional message: 38 ``` 39 ./test-lz4-speed.py "silesia.tar calgary.tar" "email (a] gmail.com" --message "tested on my laptop" --sleepTime 60 40 ``` 41 42 To run the script in background please use: 43 ``` 44 nohup ./test-lz4-speed.py testFileNames emails & 45 ``` 46 47 The full list of parameters: 48 ``` 49 positional arguments: 50 testFileNames file names list for speed benchmark 51 emails list of e-mail addresses to send warnings 52 53 optional arguments: 54 -h, --help show this help message and exit 55 --message MESSAGE attach an additional message to e-mail 56 --lowerLimit LOWERLIMIT 57 send email if speed is lower than given limit 58 --maxLoadAvg MAXLOADAVG 59 maximum load average to start testing 60 --lastCLevel LASTCLEVEL 61 last compression level for testing 62 --sleepTime SLEEPTIME 63 frequency of repository checking in seconds 64 ``` 65 66 67 #### License 68 69 All files in this directory are licensed under GPL-v2. 70 See [COPYING](COPYING) for details. 71 The text of the license is also included at the top of each source file. 72
