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