direct/timothy_tests/quick_tests/README.txt

   1 Made by Timothy Manning <timothy@yaffs.net> on 04/11/2010
   2
   3 This test is designed to test the response and error handling of the yaffs functions.
   4
   5 compile command: make
   6 run command: ./quick_tests
   7
   8 command line options:
   9         -h                              prints the available command line options.
  10         -c                              tests will continue even if a test fails, rather than exiting the test.
  11         -v                              verbose mode. will print all messages.
  12         -q                              quiet mode. will not print any messages.
  13         -t [number]             sets the yaffs_trace() function to the number.
  14         -n [number]             sets the number of randomly selected tests to run after the test has run through
  15                                         after running all of listed tests.
  16
  17 ############################# development infomation ####################################################################
  18
  19 Tests made
  20
  21 test_yaffs_access.c
  22 test_yaffs_access_EACCES.c
  23 test_yaffs_access_EINVAL.c
  24 test_yaffs_access_ELOOP.c
  25 test_yaffs_access_ELOOP_dir.c
  26 test_yaffs_access_ENAMETOOLONG.c
  27 test_yaffs_access_ENOENT2.c
  28 test_yaffs_access_ENOENT.c
  29 test_yaffs_access_ENOTDIR.c
  30 test_yaffs_access_EROFS.c
  31 test_yaffs_access_NULL.c
  32
  33 test_yaffs_chmod.c
  34 test_yaffs_chmod_EINVAL.c
  35 test_yaffs_chmod_ELOOP.c
  36 test_yaffs_chmod_ELOOP_dir.c
  37 test_yaffs_chmod_ENAMETOOLONG.c
  38 test_yaffs_chmod_ENOENT2.c
  39 test_yaffs_chmod_ENOENT.c
  40 test_yaffs_chmod_ENOTDIR.c
  41 test_yaffs_chmod_EROFS.c
  42 test_yaffs_chmod_NULL.c
  43
  44 test_yaffs_close.c
  45 test_yaffs_close_EBADF.c
  46 test_yaffs_close_NULL.c
  47
  48 test_yaffs_dup.c
  49 test_yaffs_dup_EBADF.c
  50
  51 test_yaffs_fchmod.c
  52 test_yaffs_fchmod_EBADF.c
  53 test_yaffs_fchmod_EINVAL.c
  54 test_yaffs_fchmod_EROFS.c
  55 test_yaffs_fchmod_NULL.c
  56
  57 test_yaffs_fdatasync.c
  58 test_yaffs_fdatasync_EBADF.c
  59 test_yaffs_fdatasync_EROFS.c
  60 test_yaffs_fdatasync_NULL.c
  61
  62 test_yaffs_flush.c
  63 test_yaffs_flush_EBADF.c
  64 test_yaffs_flush_EROFS.c
  65
  66 test_yaffs_freespace.c
  67 test_yaffs_freespace_EINVAL.c
  68 test_yaffs_freespace_ENAMETOOLONG.c
  69 test_yaffs_freespace_NULL.c
  70
  71 test_yaffs_fstat.c
  72 test_yaffs_fstat_EBADF.c
  73
  74 test_yaffs_fsync.c
  75 test_yaffs_fsync_EBADF.c
  76 test_yaffs_fsync_EROFS.c
  77
  78 test_yaffs_ftruncate_big_file.c
  79 test_yaffs_ftruncate.c
  80 test_yaffs_ftruncate_EBADF.c
  81 test_yaffs_ftruncate_EINVAL.c
  82 test_yaffs_ftruncate_EROFS.c
  83
  84 test_yaffs_inodecount.c
  85 test_yaffs_inodecount_EINVAL.c
  86 test_yaffs_inodecount_ENAMETOOLONG.c
  87 test_yaffs_inodecount_NULL.c
  88
  89 test_yaffs_link.c
  90 test_yaffs_link_EEXIST.c
  91 test_yaffs_link_ELOOP_dir.c
  92 test_yaffs_link_ENAMETOOLONG2.c
  93 test_yaffs_link_ENAMETOOLONG.c
  94 test_yaffs_link_ENOENT2.c
  95 test_yaffs_link_ENOENT3.c
  96 test_yaffs_link_ENOENT4.c
  97 test_yaffs_link_ENOENT.c
  98 test_yaffs_link_ENOTDIR2.c
  99 test_yaffs_link_ENOTDIR.c
 100 test_yaffs_link_EROFS.c
 101 test_yaffs_link_NULL2.c
 102 test_yaffs_link_NULL.c
 103
 104 test_yaffs_lseek_big_file.c
 105 test_yaffs_lseek.c
 106 test_yaffs_lseek_EBADF.c
 107 test_yaffs_lseek_EINVAL.c
 108 test_yaffs_lseek_EROFS.c
 109
 110 test_yaffs_lstat.c
 111 test_yaffs_lstat_ENAMETOOLONG.c
 112 test_yaffs_lstat_ENOENT.c
 113 test_yaffs_lstat_ENOTDIR.c
 114 test_yaffs_lstat_NULL.c
 115
 116 test_yaffs_mkdir.c
 117 test_yaffs_mkdir_EEXIST.c
 118 test_yaffs_mkdir_ELOOP_dir.c
 119 test_yaffs_mkdir_ENAMETOOLONG.c
 120 test_yaffs_mkdir_ENOENT.c
 121 test_yaffs_mkdir_ENOTDIR.c
 122 test_yaffs_mkdir_EROFS.c
 123 test_yaffs_mkdir_NULL.c
 124
 125 test_yaffs_mount2.c
 126 test_yaffs_mount2_ENODEV.c
 127
 128 test_yaffs_mount.c
 129 test_yaffs_mount_EBUSY.c
 130 test_yaffs_mount_ENAMETOOLONG.c
 131 test_yaffs_mount_ENODEV.c
 132 test_yaffs_mount_NULL.c
 133
 134 test_yaffs_open.c
 135 test_yaffs_open_EACCES.c
 136 test_yaffs_open_EEXIST.c
 137 test_yaffs_open_EINVAL2.c
 138 test_yaffs_open_EINVAL.c
 139 test_yaffs_open_EISDIR.c
 140 test_yaffs_open_ELOOP.c
 141 test_yaffs_open_ELOOP_dir.c
 142 test_yaffs_open_ENAMETOOLONG.c
 143 test_yaffs_open_ENOENT.c
 144 test_yaffs_open_ENOTDIR.c
 145 test_yaffs_open_EROFS.c
 146 test_yaffs_open_NULL.c
 147
 148 test_yaffs_read.c
 149 test_yaffs_read_EBADF.c
 150 test_yaffs_read_EINVAL.c
 151
 152 test_yaffs_remount_EINVAL.c
 153 test_yaffs_remount_ENAMETOOLONG.c
 154 test_yaffs_remount_ENODEV.c
 155 test_yaffs_remount_force_off_read_only_off.c
 156 test_yaffs_remount_force_off_read_only_on.c
 157 test_yaffs_remount_force_on_read_only_off.c
 158 test_yaffs_remount_force_on_read_only_on.c
 159 test_yaffs_remount_NULL.c
 160
 161 test_yaffs_rename.c
 162 test_yaffs_rename_dir.c
 163 test_yaffs_rename_dir_ENOENT2.c
 164 test_yaffs_rename_dir_ENOENT.c
 165 test_yaffs_rename_dir_not_empty.c
 166 test_yaffs_rename_dir_to_file.c
 167 test_yaffs_rename_EEXISTS.c
 168 test_yaffs_rename_EINVAL.c
 169 test_yaffs_rename_ELOOP_dir.c
 170 test_yaffs_rename_ENAMETOOLONG2.c
 171 test_yaffs_rename_ENAMETOOLONG.c
 172 test_yaffs_rename_ENOENT.c
 173 test_yaffs_rename_ENOTDIR.c
 174 test_yaffs_rename_EROFS.c
 175 test_yaffs_rename_file_to_dir.c
 176 test_yaffs_rename_NULL2.c
 177 test_yaffs_rename_NULL.c
 178
 179 test_yaffs_rmdir.c
 180 test_yaffs_rmdir_EBUSY.c
 181 test_yaffs_rmdir_EINVAL.c
 182 test_yaffs_rmdir_ELOOP_dir.c
 183 test_yaffs_rmdir_ENAMETOOLONG.c
 184 test_yaffs_rmdir_ENOENT.c
 185 test_yaffs_rmdir_ENOTDIR.c
 186 test_yaffs_rmdir_EROFS.c
 187 test_yaffs_rmdir_NULL.c
 188
 189 test_yaffs_stat.c
 190 test_yaffs_stat_ELOOP.c
 191 test_yaffs_stat_ELOOP_dir.c
 192 test_yaffs_stat_ENAMETOOLONG.c
 193 test_yaffs_stat_ENOENT2.c
 194 test_yaffs_stat_ENOENT.c
 195 test_yaffs_stat_ENOTDIR.c
 196 test_yaffs_stat_NULL.c
 197
 198 test_yaffs_symlink.c
 199 test_yaffs_symlink_EEXIST.c
 200 test_yaffs_symlink_ELOOP_dir.c
 201 test_yaffs_symlink_ENAMETOOLONG.c
 202 test_yaffs_symlink_ENOENT2.c
 203 test_yaffs_symlink_ENOENT.c
 204 test_yaffs_symlink_ENOTDIR.c
 205 test_yaffs_symlink_EROFS.c
 206 test_yaffs_symlink_NULL2.c
 207 test_yaffs_symlink_NULL.c
 208
 209 test_yaffs_sync.c
 210 test_yaffs_sync_ENAMETOOLONG.c
 211 test_yaffs_sync_ENODEV.c
 212 test_yaffs_sync_EROFS.c
 213 test_yaffs_sync_NULL.c
 214
 215 test_yaffs_totalspace.c
 216 test_yaffs_totalspace_EINVAL.c
 217 test_yaffs_totalspace_ENAMETOOLONG.c
 218 test_yaffs_totalspace_NULL.c
 219
 220 test_yaffs_truncate_big_file.c
 221 test_yaffs_truncate.c
 222 test_yaffs_truncate_EINVAL.c
 223 test_yaffs_truncate_EISDIR.c
 224 test_yaffs_truncate_ELOOP.c
 225 test_yaffs_truncate_ELOOP_dir.c
 226 test_yaffs_truncate_ENAMETOOLONG.c
 227 test_yaffs_truncate_ENOENT2.c
 228 test_yaffs_truncate_ENOENT.c
 229 test_yaffs_truncate_ENOTDIR.c
 230 test_yaffs_truncate_EROFS.c
 231 test_yaffs_truncate_NULL.c
 232
 233 test_yaffs_unlink.c
 234 test_yaffs_unlink_EISDIR.c
 235 test_yaffs_unlink_ELOOP_dir.c
 236 test_yaffs_unlink_ENAMETOOLONG.c
 237 test_yaffs_unlink_ENOENT2.c
 238 test_yaffs_unlink_ENOENT.c
 239 test_yaffs_unlink_ENOTDIR.c
 240 test_yaffs_unlink_EROFS.c
 241 test_yaffs_unlink_NULL.c
 242
 243 test_yaffs_unmount2.c
 244 test_yaffs_unmount2_EINVAL.c
 245 test_yaffs_unmount2_ENODEV.c
 246 test_yaffs_unmount2_with_handle_open_and_forced_mode_off.c
 247 test_yaffs_unmount2_with_handle_open_and_forced_mode_on.c
 248 test_yaffs_unmount.c
 249 test_yaffs_unmount_EBUSY.c
 250 test_yaffs_unmount_ENAMETOOLONG.c
 251 test_yaffs_unmount_ENODEV.c
 252 test_yaffs_unmount_NULL.c
 253
 254 test_yaffs_write_big_file.c
 255 test_yaffs_write.c
 256 test_yaffs_write_EBADF.c
 257 test_yaffs_write_EROFS.c
 258
 259
 260
 261 Tests to add
 262
 263         test_yaffs_rename a file over its self.
 264
 265         test_yaffs_readlink
 266         test_yaffs_readlink_ENOENT
 267         test_yaffs_readlink_ENOTDIR
 268         test_yaffs_readlink_ELOOP
 269
 270         test_yaffs_mount2_with read only set
 271
 272         test_yaffs_remount_force_off_read_only_on
 273         test_yaffs_remount_force_on_read_only_on
 274
 275         test_yaffs_opendir
 276
 277         test_yaffs_readdir
 278
 279         test_yaffs_rewinddir
 280
 281         test_yaffs_closedir
 282
 283         test_yaffs_link_EPERM
 284
 285         test_yaffs_rmdir_ENOTEMPTY
 286
 287         test_yaffs_rename_EMLINK
 288         test_yaffs_rename_EEXISTS or EPERM
 289
 290         test_yaffs_open_ENOSPC
 291
 292         test yaffs_open_running_out_of_handles error
 293
 294         test_yaffs_read_big_file
 295         test what happens if you read off the end of the file?
 296
 297         test_yaffs_pread
 298         test_yaffs_pread_EBADF
 299         test_yaffs_pread_EINVAL
 300         test_yaffs_pread_big_file
 301
 302         test_yaffs_write_big_file
 303         test_yaffs_write_EINVAL
 304         What happens when you run out of space?
 305
 306
 307         test_yaffs_pwrite_big_file
 308         test_yaffs_pwrite_EINVAL
 309
 310         test_yaffs_unlink_ENOMEM
 311
 312         test_yaffs_access_ENOENT_generated_with_a_dangling_symbloic_link
 313
 314         Add a truncate function for truncating a file size to -1.
 315
 316         What happens if a handle is opened to a file and the file is then deleted?
 317         Check to see if yaffs generates an error code for no reason.
 318         What happens when a file is opened with no modes set?
 319
 320         What happens when yaffs is unmounted twice?
 321
 322         What happens when open a handle, unmount yaffs and then try to use the handle?
 323
 324         What happens when a mount point is mounted using mount2 with read only mode set and then a file is chmoded?
 325
 326         Try to remove lost and found dir and replace it with a file of the same name.
 327
 328         Change the mode of the lost and found dir to read only.
 329
 330 Tests which do not exist in yaffs:
 331         test_yaffs_close        //This function has already been called by the time this test is reached,
 332                                 //so there is no point in testing it.
 333
 334         test_yaffs_link_EMLINK          //should not happen on yaffs
 335         test_yaffs_link_ELOOP
 336
 337         test_yaffs_lstat_ELOOP
 338
 339         test_yaffs_mkdir_ELOOP
 340
 341         //the yaffs_mknod function does not exist in yaffsfs, so these tests will not be added.
 342         test_yaffs_mknod_EACCES
 343         test_yaffs_mknod_EEXIST
 344         test_yaffs_mknod_EINVAL
 345         test_yaffs_mknod_ELOOP
 346         test_yaffs_mknod_ENAMETOOLONG
 347         test_yaffs_mknod_ENOENT
 348         test_yaffs_mknod_ENOTDIR
 349         test_yaffs_mknod_EROFS
 350
 351         teat_yaffs_mount_ELOOP
 352
 353         test_yaffs_mount2_EINVAL        //cannot happen in yaffs since the mode is not checked.
 354         test_yaffs_mount2_ENOTDIR       //cannot be generated in yaffs.
 355         test_yaffs_mount2_ENOENT        //cannot be generated in yaffs.
 356         test_yaffs_mount2_ELOOP
 357
 358         test_yaffs_remount_ENOENT       //cannot be generated in yaffs
 359         test_yaffs_remount_ENOTDIR      //cannot be generated in yaffs
 360
 361         test_yaffs_unmount2_ENOENT      //cannot be generated in yaffs.
 362         test_yaffs_unmount2_ENOTDIR     //cannot be generated in yaffs.
 363
 364 How to add a test
 365         First create the test .c and .h file.
 366         The file name and test function name should be the same.
 367         This name should follow one of these formats:
 368         Test_yaffs_[function of yaffs which is been tested]
 369         Test_yaffs_[function of yaffs which is been tested]_[error trying to be generated]
 370
 371         The .c file needs to contain two functions.
 372         The first function needs to contain the code for the main test and will
 373         return -1 on a failure and 0 or greater on a success.
 374         The second function needs contain the code for cleaning up after the test.
 375         Cleaning up may include closing some open handles, recreating a file, ect.
 376         This second function needs to return -1 on a failure and 0 or greater on success.
 377
 378         The name of first function needs to be called the same as the file
 379         name (without the .c or .h)
 380         The second function's name needs be the same as the first function but
 381         with "_clean" added on the end.
 382
 383         So if a test is been created for the yaffs function yaffs_foo() then
 384         create these files
 385         test_yaffs_foo.c
 386                 Contains int test_yaffs_foo(void); int test_yaffs_foo_clean(void);
 387         test_yaffs_foo.h
 388                 Which includes "lib.h", "yaffsfs.h" header files.
 389
 390         Next write the test code in these files then add these files to the Makefile.
 391
 392         Add the name of the test files' object file (test_yaffs_foo.o ) to the
 393         TESTFILES tag around line 50 of the Makefile.
 394
 395         Now add the test functions to the test_list[] array in quick_tests.h
 396         The order of the tests matters. The idea is to test each yaffs_function
 397         individualy and only using tested yaffs_components before using this new
 398         yaffs_function.
 399         This array consists of:
 400         {[test function], [the clean function], [name of the tests which will be printed when the test fails]},
 401
 402         So add this line to the test_list[]: {test_yaffs_foo, test_yaffs_foo_clean, "test_yaffs_foo"},
 403
 404         Also include the test's .h file in the quick_test.h file: #include "test_yaffs_foo.h"
 405
 406         The test file should now make and run(you may need to make clean first).
 407
 408
 409
 410         PS: yaffs_foo() is a made up function for this README (in case you want
 411         to find this function in yaffs).
 412
 413
 414
 415
 416
 417