1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/tests/pkg/spiffs/main.c

398 lines
11 KiB
C

/*
* 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.h"
/* Define MTD_0 in board.h to use the board mtd if any and if
* CONFIG_USE_HARDWARE_MTD is defined (add CFLAGS=-DCONFIG_USE_HARDWARE_MTD to
* the command line to enable it */
#if defined(MTD_0) && IS_ACTIVE(CONFIG_USE_HARDWARE_MTD)
#define _dev (MTD_0)
#else
#include "mtd_emulated.h"
/* Test mock object implementing a simple RAM-based mtd */
#ifndef SECTOR_COUNT
#define SECTOR_COUNT 4
#endif
#ifndef PAGE_PER_SECTOR
#define PAGE_PER_SECTOR 8
#endif
#ifndef PAGE_SIZE
#define PAGE_SIZE 128
#endif
MTD_EMULATED_DEV(0, SECTOR_COUNT, PAGE_PER_SECTOR, PAGE_SIZE);
#define _dev (&mtd_emulated_dev0.base)
#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, false);
spiffs_desc.base_addr = 0;
spiffs_desc.block_count = 0;
}
static void tests_spiffs_format(void)
{
int res;
vfs_umount(&_test_spiffs_mount, false);
res = mtd_erase(_dev, 0, _dev->page_size * _dev->pages_per_sector * _dev->sector_count);
TEST_ASSERT_EQUAL_INT(0, res);
res = vfs_mount(&_test_spiffs_mount);
TEST_ASSERT(res < 0);
/* 1. format an invalid file system (failed mount) */
res = vfs_format(&_test_spiffs_mount);
TEST_ASSERT_EQUAL_INT(0, res);
res = vfs_mount(&_test_spiffs_mount);
TEST_ASSERT_EQUAL_INT(0, res);
res = vfs_umount(&_test_spiffs_mount, false);
TEST_ASSERT_EQUAL_INT(0, res);
/* 2. format a valid file system */
res = vfs_format(&_test_spiffs_mount);
TEST_ASSERT_EQUAL_INT(0, res);
}
static void tests_spiffs_mount_umount(void)
{
int res;
res = vfs_umount(&_test_spiffs_mount, false);
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");
TEST_ASSERT_EQUAL_INT(0, res);
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);
}
static void tests_spiffs_statvfs(void)
{
const char buf[] = "TESTSTRING";
struct statvfs stat1;
struct statvfs stat2;
int res = vfs_statvfs("/test-spiffs/", &stat1);
TEST_ASSERT_EQUAL_INT(0, res);
TEST_ASSERT_EQUAL_INT(1, stat1.f_bsize);
TEST_ASSERT_EQUAL_INT(1, stat1.f_frsize);
TEST_ASSERT((_dev->pages_per_sector * _dev->page_size * _dev->sector_count) >=
stat1.f_blocks);
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_close(fd);
TEST_ASSERT_EQUAL_INT(0, res);
res = vfs_statvfs("/test-spiffs/", &stat2);
TEST_ASSERT_EQUAL_INT(0, res);
TEST_ASSERT_EQUAL_INT(1, stat2.f_bsize);
TEST_ASSERT_EQUAL_INT(1, stat2.f_frsize);
TEST_ASSERT(sizeof(buf) <= (stat1.f_bfree - stat2.f_bfree));
TEST_ASSERT(sizeof(buf) <= (stat1.f_bavail - stat2.f_bavail));
}
static void tests_spiffs_partition(void)
{
vfs_umount(&_test_spiffs_mount, false);
spiffs_desc.base_addr = _dev->page_size * _dev->pages_per_sector;
spiffs_desc.block_count = 2;
mtd_erase(_dev, 0, _dev->page_size * _dev->pages_per_sector * _dev->sector_count);
int res = vfs_format(&_test_spiffs_mount);
TEST_ASSERT_EQUAL_INT(0, res);
res = vfs_mount(&_test_spiffs_mount);
TEST_ASSERT_EQUAL_INT(0, res);
#if SPIFFS_USE_MAGIC
/* if SPIFFS_USE_MAGIC is used, a magic word is written in each sector */
uint8_t buf[4];
const uint8_t buf_erased[4] = {0xff, 0xff, 0xff, 0xff};
int ret;
res = 0;
for (size_t i = 0; i < _dev->page_size * _dev->pages_per_sector; i += sizeof(buf)) {
ret = mtd_read(_dev, buf, _dev->page_size * _dev->pages_per_sector + i, sizeof(buf));
TEST_ASSERT_EQUAL_INT(0, ret);
res |= memcmp(buf, buf_erased, sizeof(buf));
}
TEST_ASSERT(res != 0);
res = 0;
for (size_t i = 0; i < _dev->page_size * _dev->pages_per_sector; i += sizeof(buf)) {
ret = mtd_read(_dev, buf, (2 * _dev->page_size * _dev->pages_per_sector) + i, sizeof(buf));
TEST_ASSERT_EQUAL_INT(0, ret);
res |= memcmp(buf, buf_erased, sizeof(buf));
}
TEST_ASSERT(res != 0);
/* Check previous sector (must be erased) */
res = 0;
for (size_t i = 0; i < _dev->page_size * _dev->pages_per_sector; i += sizeof(buf)) {
ret = mtd_read(_dev, buf, i, sizeof(buf));
TEST_ASSERT_EQUAL_INT(0, ret);
res |= memcmp(buf, buf_erased, sizeof(buf));
}
TEST_ASSERT(res == 0);
/* Check next sector (must be erased) */
res = 0;
for (size_t i = 0; i < _dev->page_size * _dev->pages_per_sector; i += sizeof(buf)) {
ret = mtd_read(_dev, buf, (3 * _dev->page_size * _dev->pages_per_sector) + i, sizeof(buf));
TEST_ASSERT_EQUAL_INT(0, ret);
res |= memcmp(buf, buf_erased, sizeof(buf));
}
TEST_ASSERT(res == 0);
#endif
}
Test *tests_spiffs(void)
{
EMB_UNIT_TESTFIXTURES(fixtures) {
new_TestFixture(tests_spiffs_format),
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),
new_TestFixture(tests_spiffs_statvfs),
new_TestFixture(tests_spiffs_partition),
};
EMB_UNIT_TESTCALLER(spiffs_tests, test_spiffs_setup, test_spiffs_teardown, fixtures);
return (Test *)&spiffs_tests;
}
int main(void)
{
TESTS_START();
TESTS_RUN(tests_spiffs());
TESTS_END();
return 0;
}
/** @} */