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