aboutsummaryrefslogtreecommitdiff
path: root/kernel/src/filesystem/vfs.tests.cpp
blob: eba157d2d9f8e49921337d63b9d4031f81dee3e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
#include "kernel/filesystem/vfs.hpp"

#include "kernel/filesystem/open_file_description.hpp"
#include "kernel/test_support/filesystem/storage_boot_module_vfs_fixture.hpp"

#include <kstd/memory>
#include <kstd/vector>

#include <catch2/catch_test_macros.hpp>

#include <cstddef>
#include <filesystem>
#include <string_view>

SCENARIO_METHOD(kernel::tests::filesystem::storage_boot_module_vfs_fixture, "VFS with dummy modules",
                "[filesystem][vfs]")
{
  GIVEN("an initialized boot module registry with multiple modules")
  {
    REQUIRE_NOTHROW(setup_modules_and_init_vfs(5));

    THEN("vfs initializes and provides /dev mount")
    {
      auto & vfs = kernel::filesystem::vfs::get();
      auto dev = vfs.open("/dev");

      REQUIRE(dev != nullptr);
    }

    THEN("vfs initializes root filesystem with boot device if boot module is present")
    {
      auto & vfs = kernel::filesystem::vfs::get();
      auto root_file = vfs.open("/");

      REQUIRE(root_file != nullptr);
    }
  }
}

SCENARIO_METHOD(kernel::tests::filesystem::storage_boot_module_vfs_fixture, "VFS with file backed image",
                "[filesystem][vfs][img]")
{
  auto const image_path_1 = std::filesystem::path{KERNEL_TEST_ASSETS_DIR} / "ext2_1KB_fs.img";
  auto const image_path_2 = std::filesystem::path{KERNEL_TEST_ASSETS_DIR} / "ext2_2KB_fs.img";
  auto const image_path_3 = std::filesystem::path{KERNEL_TEST_ASSETS_DIR} / "ext2_4KB_fs.img";

  GIVEN("a real image file")
  {
    REQUIRE(std::filesystem::exists(image_path_1));
    REQUIRE_NOTHROW(setup_modules_from_img_and_init_vfs({"test_img_module"}, {image_path_1}));

    THEN("vfs initializes and provides expected mount points")
    {
      auto & vfs = kernel::filesystem::vfs::get();
      auto root = vfs.open("/");
      auto dev = vfs.open("/dev");
      auto information = vfs.open("/information/info_1.txt");

      REQUIRE(root != nullptr);
      REQUIRE(dev != nullptr);
      REQUIRE(information != nullptr);
    }
  }

  GIVEN("three real image files")
  {
    REQUIRE(std::filesystem::exists(image_path_1));
    REQUIRE(std::filesystem::exists(image_path_2));
    REQUIRE(std::filesystem::exists(image_path_3));
    REQUIRE_NOTHROW(setup_modules_from_img_and_init_vfs({"test_img_module_1", "test_img_module_2", "test_img_module_3"},
                                                        {image_path_1, image_path_2, image_path_3}));

    auto & vfs = kernel::filesystem::vfs::get();

    THEN("vfs initializes first module as root")
    {
      auto & vfs = kernel::filesystem::vfs::get();
      auto info1 = vfs.open("/information/info_1.txt");
      auto info2 = vfs.open("/information/info_2.txt");

      REQUIRE(info1 != nullptr);
      REQUIRE(info2 != nullptr);
    }

    THEN("second image can be mounted, data retrieved and unmounted again")
    {
      REQUIRE(vfs.do_mount("/dev/ram16", "/information") == kernel::filesystem::vfs::operation_result::success);

      auto mounted_monkey_1 = vfs.open("/information/monkey_house/monkey_1.txt");
      REQUIRE(mounted_monkey_1 != nullptr);

      REQUIRE(vfs.unmount("/information") == kernel::filesystem::vfs::operation_result::success);
      auto unmounted_monkey_1 = vfs.open("/information/monkey_house/monkey_1.txt");
      REQUIRE(unmounted_monkey_1 == nullptr);

      auto info_1 = vfs.open("/information/info_1.txt");
      REQUIRE(info_1 != nullptr);
    }

    THEN("third image can be mounted in a mounted file system, unmount only if no child mount exists")
    {
      REQUIRE(vfs.do_mount("/dev/ram16", "/information") == kernel::filesystem::vfs::operation_result::success);
      REQUIRE(vfs.do_mount("/dev/ram32", "/information/monkey_house/infrastructure") ==
              kernel::filesystem::vfs::operation_result::success);

      auto mounted_monkey_1 = vfs.open("/information/monkey_house/monkey_1.txt");
      auto mounted_fish1 = vfs.open("/information/monkey_house/infrastructure/enclosures/aquarium/tank_1/fish_1.txt");

      REQUIRE(mounted_monkey_1 != nullptr);
      REQUIRE(mounted_fish1 != nullptr);

      REQUIRE(vfs.unmount("/information") == kernel::filesystem::vfs::operation_result::unmount_failed);
      REQUIRE(vfs.unmount("/information/monkey_house/infrastructure") ==
              kernel::filesystem::vfs::operation_result::success);
      REQUIRE(vfs.unmount("/information") == kernel::filesystem::vfs::operation_result::success);
    }

    THEN("images can be stacked mounted and correct file system is unmounted again")
    {
      REQUIRE(vfs.do_mount("/dev/ram16", "/information") == kernel::filesystem::vfs::operation_result::success);
      REQUIRE(vfs.do_mount("/dev/ram32", "/information") == kernel::filesystem::vfs::operation_result::success);

      auto mounted_tickets = vfs.open("/information/entrance/tickets.txt");
      REQUIRE(mounted_tickets != nullptr);

      REQUIRE(vfs.unmount("/information") == kernel::filesystem::vfs::operation_result::success);
      mounted_tickets = vfs.open("/information/entrance/tickets.txt");
      REQUIRE(mounted_tickets == nullptr);

      auto mounted_monkey = vfs.open("/information/monkey_house/monkey_1.txt");
      REQUIRE(mounted_monkey != nullptr);
    }

    THEN("mount with null file system fails")
    {
      REQUIRE(vfs.do_mount("/closed.txt", "/information") ==
              kernel::filesystem::vfs::operation_result::invalid_filesystem);
    }

    THEN("mount with invalid path fails")
    {
      REQUIRE(vfs.do_mount("/dev/ram16", "") == kernel::filesystem::vfs::operation_result::invalid_path);
      REQUIRE(vfs.do_mount("/dev/ram16", "information") == kernel::filesystem::vfs::operation_result::invalid_path);
      REQUIRE(vfs.do_mount("/dev/ram16", "/information/") == kernel::filesystem::vfs::operation_result::invalid_path);
    }

    THEN("mount with non-existent source path fails")
    {
      REQUIRE(vfs.do_mount("/dev/nonexistent", "/information") ==
              kernel::filesystem::vfs::operation_result::non_existent_path);
    }

    THEN("mount with non-existent mount point fails")
    {
      REQUIRE(vfs.do_mount("/dev/ram16", "/information/nonexistent") ==
              kernel::filesystem::vfs::operation_result::mount_point_not_found);
    }

    THEN("unmount with invalid path fails")
    {
      REQUIRE(vfs.unmount("") == kernel::filesystem::vfs::operation_result::invalid_path);
      REQUIRE(vfs.unmount("information") == kernel::filesystem::vfs::operation_result::invalid_path);
      REQUIRE(vfs.unmount("/information/") == kernel::filesystem::vfs::operation_result::invalid_path);
    }

    THEN("unmounting non-existent mount point returns expected error code")
    {
      REQUIRE(vfs.unmount("/information/nonexistent") ==
              kernel::filesystem::vfs::operation_result::mount_point_not_found);
    }
  }

  GIVEN("A real image file containing as filesystem formatted files")
  {
    REQUIRE(std::filesystem::exists(image_path_1));
    REQUIRE_NOTHROW(setup_modules_from_img_and_init_vfs({"test_img_module_1"}, {image_path_1}));

    THEN("the file-filesystem in the image can be mounted, files can be read and unmounted again")
    {
      auto & vfs = kernel::filesystem::vfs::get();
      REQUIRE(vfs.do_mount("/archiv/2024.img", "/information") == kernel::filesystem::vfs::operation_result::success);

      auto info_1 = vfs.open("/information/info_1.txt");
      REQUIRE(info_1 == nullptr);

      auto dentry = vfs.open("/information/sheep_1.txt");
      REQUIRE(dentry != nullptr);
      auto sheep_1_ofd = kstd::make_shared<kernel::filesystem::open_file_description>(dentry->get_inode());

      kstd::vector<std::byte> buffer(7);
      auto bytes_read = sheep_1_ofd->read(buffer.data(), buffer.size());
      std::string_view buffer_as_str{reinterpret_cast<char *>(buffer.data()), bytes_read};
      REQUIRE(buffer_as_str == "sheep_1");

      REQUIRE(vfs.unmount("/information") == kernel::filesystem::vfs::operation_result::success);
      auto unmounted_sheep_1 = vfs.open("/information/sheep_1.txt");
      REQUIRE(unmounted_sheep_1 == nullptr);
    }

    THEN("the file-filesystem in the image can be mounted and in this filesystem can another file-filesystem be "
         "mounted, files can be read and unmounted again")
    {
      auto & vfs = kernel::filesystem::vfs::get();
      REQUIRE(vfs.do_mount("/archiv/2024.img", "/information") == kernel::filesystem::vfs::operation_result::success);
      REQUIRE(vfs.do_mount("/archiv/2025.img", "/information/stable") ==
              kernel::filesystem::vfs::operation_result::success);

      auto sheep_1 = vfs.open("/information/sheep_1.txt");
      auto goat_1 = vfs.open("/information/stable/petting_zoo/goat_1.txt");
      REQUIRE(sheep_1 != nullptr);
      REQUIRE(goat_1 != nullptr);

      auto sheep_1_ofd = kstd::make_shared<kernel::filesystem::open_file_description>(sheep_1->get_inode());
      auto goat_1_ofd = kstd::make_shared<kernel::filesystem::open_file_description>(goat_1->get_inode());

      kstd::vector<std::byte> sheep_buffer(7);