par/test/test_filecache.c

#include "describe.h"

#define PAR_FILECACHE_IMPLEMENTATION
#include "par_filecache.h"

#include <fcntl.h>
#include <unistd.h>

#if ENABLE_LZ4
#define PREFIX "build/tfc.lz4."
#else
#define PREFIX "build/tfc.unc."
#endif

int main()
{
    describe("the basics") {
        it("should be able to initialize and evict") {
            par_filecache_init(PREFIX, 1200);
            par_filecache_evict_all();
            par_filecache_evict_all();
        }
        it("should save and load small files") {
            char const* payload = "01234";
            par_filecache_save("small", (uint8_t*) payload, 5, 0, 0);
            uint8_t* received = 0;
            int nbytes = 0;
            int loaded = par_filecache_load("small", &received, &nbytes, 0, 0);
            assert_ok(loaded);
            assert_ok(received);
            assert_equal(nbytes, 5);
            assert_ok(!memcmp(received, payload, 5));
            free(received);
        }
        it("should save and load larger files") {
            char* payload = calloc(1024, 1);
            srand(1);
            for (int i = 0; i < 512; i++) {
                payload[i] = rand() % 256;
            }
            par_filecache_save("big", (uint8_t*) payload, 1024, 0, 0);
            uint8_t* received = 0;
            int nbytes = 0;
            int loaded = par_filecache_load("big", &received, &nbytes, 0, 0);
            assert_ok(loaded);
            assert_ok(received);
            assert_equal(nbytes, 1024);
            assert_ok(!memcmp(received, payload, 1024));
            free(received);
            free(payload);
        }
        it("should evict the oldest file when exceeding max size") {
            uint8_t* received = 0;
            int nbytes = 0;
            char* payload = calloc(1024, 1);
            par_filecache_save("second", (uint8_t*) payload, 1024, 0, 0);
            free(payload);
            int loaded = par_filecache_load("big", &received, &nbytes, 0, 0);
            #if ENABLE_LZ4
            assert_equal(loaded, 1);
            free(received);
            #else
            assert_equal(loaded, 0);
            #endif
        }
        it("returns false when not found") {
            uint8_t* received = 0;
            int nbytes = 0;
            int loaded = par_filecache_load("bar", &received, &nbytes, 0, 0);
            assert_equal(loaded, 0);
        }
        it("supports a fixed-size header (e.g., version number)") {
            char* payload = "philip";
            char* header = "v0001";
            par_filecache_save("versioned", (uint8_t*) payload,
                strlen(payload), (uint8_t*) header, 5);
            char* loaded_payload;
            char loaded_header[5] = {0};
            int nbytes = 0;
            int loaded = par_filecache_load("versioned",
                (uint8_t**) &loaded_payload, &nbytes,
                (uint8_t*) loaded_header, 5);
            assert_equal(loaded, 1);
            assert_equal(nbytes, 6);
            assert_ok(!memcmp(loaded_header, header, 5));
            assert_ok(!memcmp(loaded_payload, payload, 6));
            free(loaded_payload);
        }
    }

    describe("robustness") {
        it("is graceful when files are deleted") {
            int error = remove(PREFIX "versioned");
            assert_equal(error, 0);
            char* loaded_payload;
            char loaded_header[5] = {0};
            int nbytes = 0;
            int loaded = par_filecache_load("versioned",
                (uint8_t**) &loaded_payload, &nbytes,
                (uint8_t*) loaded_header, 5);
            assert_equal(loaded, 0);
        }
        it("is graceful when file content vanishes") {
            int error = remove(PREFIX "second");
            assert_equal(error, 0);
            FILE* cachefile = fopen(PREFIX "second", "wt");
            fclose(cachefile);
            char* loaded_payload;
            char loaded_header[5] = {0};
            int nbytes = 0;
            int loaded = par_filecache_load("second",
                (uint8_t**) &loaded_payload, &nbytes,
                (uint8_t*) loaded_header, 5);
            assert_equal(loaded, 0);
        }
    }

    return assert_failures();
}