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