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