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