direct/timothy_tests/quick_tests/README.txt

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