unittests: add spiffs unittests

tests/unittests/Makefile

@@ -2,15 +2,17 @@ APPLICATION = unittests
 include ../Makefile.tests_common
 
 BOARD_INSUFFICIENT_MEMORY := airfy-beacon arduino-duemilanove arduino-mega2560 \
-                             arduino-uno arduino-zero calliope-mini cc2650stk \
+                             arduino-uno arduino-zero calliope-mini cc2538dk \
-                             chronos ek-lm4f120xl limifrog-v1 maple-mini microbit \
+                             cc2650stk chronos ek-lm4f120xl limifrog-v1 maple-mini \
-                             msb-430 msb-430h nrf51dongle nrf6310 nucleo32-f031 \
+                             mbed_lpc1768 microbit msb-430 msb-430h nrf51dongle \
-                             nucleo32-f042 nucleo32-f303 nucleo32-l031 nucleo-f030 \
+                             nrf6310 nucleo32-f031 nucleo32-f042 nucleo32-f303 \
-                             nucleo-f070 nucleo-f072 nucleo-f091 nucleo-f103 nucleo-f302 \
+                             nucleo32-l031 nucleo-f030 nucleo-f070 nucleo-f072 \
-                             nucleo-f334 nucleo-f410 nucleo-l053 nucleo-l073 opencm904 \
+                             nucleo-f091 nucleo-f103 nucleo-f302 nucleo-f334 \
-                             pba-d-01-kw2x pca10000 pca10005 remote-pa remote-reva \
+                             nucleo-f410 nucleo-l053 nucleo-l073 opencm904 openmote \
-                             remote-revb saml21-xpro samr21-xpro seeeduino_arch-pro \
+                             openmote-cc2538 pba-d-01-kw2x pca10000 pca10005 \
-                             slwstk6220a sodaq-autonomo spark-core stm32f0discovery \
+                             remote-pa remote-reva remote-revb saml21-xpro \
+                             samr21-xpro seeeduino_arch-pro slwstk6220a \
+                             sodaq-autonomo spark-core stm32f0discovery \
                              stm32f3discovery telosb waspmote-pro weio wsn430-v1_3b \
                              wsn430-v1_4 yunjia-nrf51822 z1
 
@@ -41,7 +43,7 @@ AVR_BOARDS := arduino-mega2560 waspmote-pro arduino-uno arduino-duemilanove
 DISABLE_TEST_FOR_AVR := tests-relic
 
 MSP430_BOARDS :=  chronos msb-430 msb-430h telosb wsn430-v1_3b wsn430-v1_4 z1
-DISABLE_TEST_FOR_MSP430 := tests-relic
+DISABLE_TEST_FOR_MSP430 := tests-relic tests-spiffs
 
 ifneq (, $(filter $(ARM7_BOARDS), $(BOARD)))
 UNIT_TESTS := $(filter-out $(DISABLE_TEST_FOR_ARM7), $(UNIT_TESTS))
@@ -56,7 +58,7 @@ UNIT_TESTS := $(filter-out $(DISABLE_TEST_FOR_AVR), $(UNIT_TESTS))
 endif
 
 ifneq (, $(filter $(MSP430_BOARDS), $(BOARD)))
-UNIT_TESTS := $(filter-out $(DISABLE_TEST_FOR_AVR), $(UNIT_TESTS))
+UNIT_TESTS := $(filter-out $(DISABLE_TEST_FOR_MSP430), $(UNIT_TESTS))
 endif
 
 DISABLE_MODULE += auto_init

tests/unittests/tests-spiffs/Makefile

@@ -0,0 +1 @@
+include $(RIOTBASE)/Makefile.base

tests/unittests/tests-spiffs/Makefile.include

@@ -0,0 +1 @@
+USEMODULE += spiffs

tests/unittests/tests-spiffs/tests-spiffs.c

@@ -0,0 +1,348 @@
+/*
+ * Copyright (C) 2016 OTA keys S.A.
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+ */
+
+/**
+ * @{
+ *
+ * @file
+ */
+#include "fs/spiffs_fs.h"
+#include "vfs.h"
+#include "mtd.h"
+#include "board.h"
+
+#include <fcntl.h>
+#include <errno.h>
+
+#include "embUnit/embUnit.h"
+
+#include "tests-spiffs.h"
+
+/* Define MTD_0 in board.h to use the board mtd if any */
+#ifdef MTD_0
+#define _dev (MTD_0)
+#else
+/* Test mock object implementing a simple RAM-based mtd */
+#ifndef SECTOR_COUNT
+#define SECTOR_COUNT 8
+#endif
+#ifndef PAGE_PER_SECTOR
+#define PAGE_PER_SECTOR 4
+#endif
+#ifndef PAGE_SIZE
+#define PAGE_SIZE 128
+#endif
+
+static uint8_t dummy_memory[PAGE_PER_SECTOR * PAGE_SIZE * SECTOR_COUNT];
+
+static int _init(mtd_dev_t *dev)
+{
+    (void)dev;
+
+    memset(dummy_memory, 0xff, sizeof(dummy_memory));
+    return 0;
+}
+
+static int _read(mtd_dev_t *dev, void *buff, uint32_t addr, uint32_t size)
+{
+    (void)dev;
+
+    if (addr + size > sizeof(dummy_memory)) {
+        return -EOVERFLOW;
+    }
+    memcpy(buff, dummy_memory + addr, size);
+
+    return size;
+}
+
+static int _write(mtd_dev_t *dev, const void *buff, uint32_t addr, uint32_t size)
+{
+    (void)dev;
+
+    if (addr + size > sizeof(dummy_memory)) {
+        return -EOVERFLOW;
+    }
+    if (size > PAGE_SIZE) {
+        return -EOVERFLOW;
+    }
+    memcpy(dummy_memory + addr, buff, size);
+
+    return size;
+}
+
+static int _erase(mtd_dev_t *dev, uint32_t addr, uint32_t size)
+{
+    (void)dev;
+
+    if (size % (PAGE_PER_SECTOR * PAGE_SIZE) != 0) {
+        return -EOVERFLOW;
+    }
+    if (addr % (PAGE_PER_SECTOR * PAGE_SIZE) != 0) {
+        return -EOVERFLOW;
+    }
+    if (addr + size > sizeof(dummy_memory)) {
+        return -EOVERFLOW;
+    }
+    memset(dummy_memory + addr, 0xff, size);
+
+    return 0;
+}
+
+static int _power(mtd_dev_t *dev, enum mtd_power_state power)
+{
+    (void)dev;
+    (void)power;
+    return 0;
+}
+
+static const mtd_desc_t driver = {
+    .init = _init,
+    .read = _read,
+    .write = _write,
+    .erase = _erase,
+    .power = _power,
+};
+
+static mtd_dev_t dev = {
+    .driver = &driver,
+    .sector_count = SECTOR_COUNT,
+    .pages_per_sector = PAGE_PER_SECTOR,
+    .page_size = PAGE_SIZE,
+};
+
+static mtd_dev_t *_dev = (mtd_dev_t*) &dev;
+#endif /* MTD_0 */
+
+static struct spiffs_desc spiffs_desc = {
+    .lock = MUTEX_INIT,
+};
+
+static vfs_mount_t _test_spiffs_mount = {
+    .fs = &spiffs_file_system,
+    .mount_point = "/test-spiffs",
+    .private_data = &spiffs_desc,
+};
+
+static void test_spiffs_setup(void)
+{
+#if SPIFFS_HAL_CALLBACK_EXTRA == 1
+    spiffs_desc.dev = _dev;
+#endif
+    vfs_mount(&_test_spiffs_mount);
+}
+
+static void test_spiffs_teardown(void)
+{
+    vfs_unlink("/test-spiffs/test.txt");
+    vfs_unlink("/test-spiffs/test0.txt");
+    vfs_unlink("/test-spiffs/test1.txt");
+    vfs_unlink("/test-spiffs/a/test2.txt");
+    vfs_umount(&_test_spiffs_mount);
+}
+
+static void tests_spiffs_mount_umount(void)
+{
+    int res;
+    res = vfs_umount(&_test_spiffs_mount);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_mount(&_test_spiffs_mount);
+    TEST_ASSERT_EQUAL_INT(0, res);
+}
+
+static void tests_spiffs_open_close(void)
+{
+    int res;
+    res = vfs_open("/test-spiffs/test.txt", O_CREAT | O_RDWR, 0);
+    TEST_ASSERT(res >= 0);
+
+    res = vfs_close(res);
+    TEST_ASSERT_EQUAL_INT(0, res);
+}
+
+static void tests_spiffs_write(void)
+{
+    const char buf[] = "TESTSTRING";
+    char r_buf[2 * sizeof(buf)];
+
+    int res;
+    int fd = vfs_open("/test-spiffs/test.txt", O_CREAT | O_RDWR, 0);
+    TEST_ASSERT(fd >= 0);
+
+    res = vfs_write(fd, buf, sizeof(buf));
+    TEST_ASSERT_EQUAL_INT(sizeof(buf), res);
+
+    res = vfs_lseek(fd, 0, SEEK_SET);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_read(fd, r_buf, sizeof(r_buf));
+    TEST_ASSERT_EQUAL_INT(sizeof(buf), res);
+    TEST_ASSERT_EQUAL_STRING(&buf[0], &r_buf[0]);
+
+    res = vfs_close(fd);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    fd = vfs_open("/test-spiffs/test.txt", O_RDONLY, 0);
+    TEST_ASSERT(fd >= 0);
+
+    res = vfs_read(fd, r_buf, sizeof(r_buf));
+    TEST_ASSERT_EQUAL_INT(sizeof(buf), res);
+    TEST_ASSERT_EQUAL_STRING(&buf[0], &r_buf[0]);
+
+    res = vfs_close(fd);
+    TEST_ASSERT_EQUAL_INT(0, res);
+}
+
+static void tests_spiffs_unlink(void)
+{
+    const char buf[] = "TESTSTRING";
+
+    int res;
+    int fd = vfs_open("/test-spiffs/test.txt", O_CREAT | O_RDWR, 0);
+    TEST_ASSERT(fd >= 0);
+
+    res = vfs_write(fd, buf, sizeof(buf));
+    TEST_ASSERT_EQUAL_INT(sizeof(buf), res);
+
+    res = vfs_close(fd);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_unlink("/test-spiffs/test.txt");
+    TEST_ASSERT_EQUAL_INT(0, res);
+}
+
+static void tests_spiffs_readdir(void)
+{
+    const char buf0[] = "TESTSTRING";
+    const char buf1[] = "TESTTESTSTRING";
+    const char buf2[] = "TESTSTRINGSTRING";
+
+    int res;
+    int fd0 = vfs_open("/test-spiffs/test0.txt", O_CREAT | O_RDWR, 0);
+    TEST_ASSERT(fd0 >= 0);
+
+    int fd1 = vfs_open("/test-spiffs/test1.txt", O_CREAT | O_RDWR, 0);
+    TEST_ASSERT(fd1 >= 0);
+
+    int fd2 = vfs_open("/test-spiffs/a/test2.txt", O_CREAT | O_RDWR, 0);
+    TEST_ASSERT(fd2 >= 0);
+
+    res = vfs_write(fd0, buf0, sizeof(buf0));
+    TEST_ASSERT_EQUAL_INT(sizeof(buf0), res);
+
+    res = vfs_write(fd1, buf1, sizeof(buf1));
+    TEST_ASSERT_EQUAL_INT(sizeof(buf1), res);
+
+    res = vfs_write(fd2, buf2, sizeof(buf2));
+    TEST_ASSERT_EQUAL_INT(sizeof(buf2), res);
+
+    res = vfs_close(fd0);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_close(fd1);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_close(fd2);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    vfs_DIR dirp;
+    res = vfs_opendir(&dirp, "/test-spiffs");
+
+    vfs_dirent_t entry;
+    int nb_files = 0;
+    do {
+        res = vfs_readdir(&dirp, &entry);
+        if (res == 1 && (strcmp("/test0.txt", &(entry.d_name[0])) == 0 ||
+                         strcmp("/test1.txt", &(entry.d_name[0])) == 0 ||
+                         strcmp("/a/test2.txt", &(entry.d_name[0])) == 0)) {
+            nb_files++;
+        }
+    } while (res == 1);
+
+    TEST_ASSERT_EQUAL_INT(3, nb_files);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_closedir(&dirp);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_unlink("/test-spiffs/test0.txt");
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_unlink("/test-spiffs/test1.txt");
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_unlink("/test-spiffs/a/test2.txt");
+    TEST_ASSERT_EQUAL_INT(0, res);
+}
+
+static void tests_spiffs_rename(void)
+{
+    const char buf[] = "TESTSTRING";
+    char r_buf[2 * sizeof(buf)];
+
+    int res;
+    int fd = vfs_open("/test-spiffs/test.txt", O_CREAT | O_RDWR, 0);
+    TEST_ASSERT(fd >= 0);
+
+    res = vfs_write(fd, buf, sizeof(buf));
+    TEST_ASSERT(res == sizeof(buf));
+
+    res = vfs_lseek(fd, 0, SEEK_SET);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_read(fd, r_buf, sizeof(r_buf));
+    TEST_ASSERT(res == sizeof(buf));
+    TEST_ASSERT_EQUAL_STRING(&buf[0], &r_buf[0]);
+
+    res = vfs_close(fd);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_rename("/test-spiffs/test.txt", "/test-spiffs/test1.txt");
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    fd = vfs_open("/test-spiffs/test.txt", O_RDONLY, 0);
+    TEST_ASSERT(fd < 0);
+
+    fd = vfs_open("/test-spiffs/test1.txt", O_RDONLY, 0);
+    TEST_ASSERT(fd >= 0);
+
+    res = vfs_lseek(fd, 0, SEEK_SET);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_read(fd, r_buf, sizeof(r_buf));
+    TEST_ASSERT(res == sizeof(buf));
+    TEST_ASSERT_EQUAL_STRING(&buf[0], &r_buf[0]);
+
+    res = vfs_close(fd);
+    TEST_ASSERT_EQUAL_INT(0, res);
+
+    res = vfs_unlink("/test-spiffs/test1.txt");
+    TEST_ASSERT_EQUAL_INT(0, res);
+}
+
+Test *tests_spiffs_tests(void)
+{
+    EMB_UNIT_TESTFIXTURES(fixtures) {
+        new_TestFixture(tests_spiffs_mount_umount),
+        new_TestFixture(tests_spiffs_open_close),
+        new_TestFixture(tests_spiffs_write),
+        new_TestFixture(tests_spiffs_unlink),
+        new_TestFixture(tests_spiffs_readdir),
+        new_TestFixture(tests_spiffs_rename),
+    };
+
+    EMB_UNIT_TESTCALLER(spiffs_tests, test_spiffs_setup, test_spiffs_teardown, fixtures);
+
+    return (Test *)&spiffs_tests;
+}
+
+void tests_spiffs(void)
+{
+    TESTS_RUN(tests_spiffs_tests());
+}
+/** @} */

tests/unittests/tests-spiffs/tests-spiffs.h

@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2016 OTA keys S.A.
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+ */
+
+/**
+ * @addtogroup  unittests
+ * @{
+ *
+ * @file
+ * @brief       Unittests for SPIFFS
+ *
+ * @author      Vincent Dupont <vincent@otakeys.com>
+ */
+#ifndef TESTS_SPIFFS_H
+#define TESTS_SPIFFS_H
+
+#include "embUnit.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief   The entry point of this test suite.
+ */
+void tests_spiffs(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* TESTS_SPIFFS_H */
+/** @} */