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_mount
   7         test_yaffs_mount_ENODEV
   8         test_yaffs_mount_ENAMETOOLONG
   9         test_yaffs_mount_ENOENT
  10         test_yaffs_mount_EBUSY          //called when trying to mount a new mount point with a mount point already mounted.
  11
  12         test_yaffs_access
  13         test_yaffs_access_ENIVAL        //when the mode is incorrect.
  14         test_yaffs_access_ENOTDIR
  15         test_yaffs_access_ENOENT
  16
  17         test_yaffs_close_EBADF
  18
  19         test_yaffs_ftruncate
  20         test_yaffs_ftruncate_EBADF
  21         test_yaffs_ftruncate_ENIVAL
  22         test_yaffs_ftruncate_EFBIG
  23
  24         test_yaffs_lseek
  25         test_yaffs_lseek_EBADF
  26         test_yaffs_lseek_EINVAL
  27         test_yaffs_lseek_EFBIG
  28
  29         test_yaffs_open
  30         test_yaffs_open_EEXIST
  31         test_yaffs_open_EISDIR
  32         test_yaffs_open_ENAMETOOLONG
  33         test_yaffs_open_ENOENT
  34         test_yaffs_open_ENOTDIR
  35         test_yaffs_open_EINVAL
  36         test_yaffs_open_EINVAL2 //the function open has two modes which can be set, so two tests modes are needed.
  37
  38         test_yaffs_read
  39         test_yaffs_stat
  40
  41         test_yaffs_truncate
  42         test_yaffs_truncate_ENOTDIR
  43         test_yaffs_truncate_EISDIR
  44         test_yaffs_truncate_ENOENT
  45         test_yaffs_truncate_ENIVAL
  46         test_yaffs_truncate_EFBIG
  47
  48         test_yaffs_unlink
  49         test_yaffs_unlink_EISDIR
  50         test_yaffs_unlink_ENAMETOOLONG
  51         test_yaffs_unlink_ENOENT
  52         test_yaffs_unlink_ENOTDIR
  53         test_yaffs_unlink_ENOENT
  54
  55         test_yaffs_unmount
  56         test_yaffs_write
  57
  58         add a test where a directory is moved. /fluffy/box. move "fluffy" to "/fluffy/frog".
  59
  60 Tests to add
  61         test_yaffs_mount_EACCES         //Cannot be generated with yaffs.
  62         test_yaffs_mount_EINVAL         //Cannot be generated with yaffs.
  63         test_yaffs_mount_ELOOP          //Cannot be generated with yaffs.
  64         test_yaffs_mount_EMFILE         //Cannot be generated with yaffs.
  65         test_yaffs_mount_ENOTDIR        //Cannot be generated with yaffs.
  66
  67         test_yaffs_umount_ENODEV
  68         test_yaffs_umount_ENAMETOOLONG
  69         test_yaffs_umount_ENOENT
  70         test_yaffs_umount_EBUSY
  71
  72         test_yaffs_open_EACCES
  73         test_yaffs_open_ENOSPC
  74         test_yaffs_open_ELOOP   //Too many symbolic links were encountered in resolving pathname
  75         test yaffs_open_running_out_of_handles error
  76
  77         test_yaffs_close        //This function has already been called by the time this test is reached.
  78
  79         test_yaffs_unlink_EACCES
  80         test_yaffs_unlink_ELOOP
  81         test_yaffs_unlink_ENOMEM
  82
  83         test_yaffs_access_EACCESS
  84         test_yaffs_access_ELOOP
  85         test_yaffs_access_ENAMETOOLONG
  86         test_yaffs_access_ENOENT_generated_with_a_dangling_symbloic_link
  87
  88         test_yaffs_ftruncate_EACCES
  89         test_yaffs_ftruncate_EISDIR     //
  90         test_yaffs_ftruncate_ELOOP      //
  91         test_yaffs_ftruncate_ENOENT     //
  92         test_yaffs_ftruncate_ENOTDIR    //
  93
  94         test_yaffs_truncate_EACCES
  95         test_yaffs_truncate_ELOOP
  96         test_yaffs_truncate_ENAMETOOLONG
  97         add a truncate function for truncating a file size to -1.
  98
  99         What happens if a handle is opened to a file and the file is then deleted?
 100         Check to see if yaffs generates an error code for no reason.
 101         What happens when a file is opened with no modes set?
 102
 103
 104 How to add a test
 105         First create the test .c and .h file.
 106         The file name and test function name should be the same.
 107         This name should follow one of these formats:
 108         Test_yaffs_[function of yaffs which is been tested]
 109         Test_yaffs_[function of yaffs which is been tested]_[error trying to be generated]
 110
 111         The .c file needs to contain two functions.
 112         The first function needs to contain the code for the main test and will
 113         return -1 on a failure and 0 or greater on a success.
 114         The second function needs contain the code for cleaning up after the test.
 115         Cleaning up may include closing some open handles, recreating a file, ect.
 116         This second function needs to return -1 on a failure and 0 or greater on success.
 117
 118         The name of first function needs to be called the same as the file
 119         name (without the .c or .h)
 120         The second function's name needs be the same as the first function but
 121         with "_clean" added on the end.
 122
 123         So if a test is been created for the yaffs function yaffs_foo() then
 124         create these files
 125         test_yaffs_foo.c
 126                 Contains int test_yaffs_foo(void); int test_yaffs_foo_clean(void);
 127         test_yaffs_foo.h
 128                 Which includes "lib.h", "yaffsfs.h" header files.
 129
 130         Next write the test code in these files then add these files to the Makefile.
 131
 132         Add the name of the test files' object file (test_yaffs_foo.o ) to the
 133         TESTFILES tag around line 50 of the Makefile.
 134
 135         Now add the test functions to the test_list[] array in quick_tests.h
 136         The order of the tests matters. The idea is to test each yaffs_function
 137         individualy and only using tested yaffs_components before using this new
 138         yaffs_function.
 139         This array consists of:
 140         {[test function], [the clean function], [name of the tests which will be printed when the test fails]},
 141
 142         So add this line to the test_list[]: {test_yaffs_foo, test_yaffs_foo_clean, "test_yaffs_foo"},
 143
 144         Also include the test's .h file in the quick_test.h file: #include "test_yaffs_foo.h"
 145
 146         The test file should now make and run(you may need to make clean first).
 147
 148
 149
 150         PS: yaffs_foo() is a made up function for this README (in case you want
 151         to find this function in yaffs).
 152
 153
 154
 155
 156
 157