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