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