direct/timothy_tests/quick_tests/README.txt

   1
   2 Made by Timothy Manning <timothy@yaffs.net> on 04/11/2010
   3
   4
   5 the yaffs_open function has been covered by tests
   6 the yaffs_close function has been covered by tests
   7
   8 tests made
   9         test_yaffs_mount
  10         test_yaffs_mount_ENODEV
  11         test_yaffs_mount_ENAMETOOLONG
  12         test_yaffs_access
  13         test_yaffs_close_EBADF
  14         test_yaffs_ftruncate
  15         test_yaffs_lseek
  16         test_yaffs_open
  17         test_yaffs_open_EEXIST
  18         test_yaffs_open_EISDIR
  19         test_yaffs_open_ENAMETOOLONG
  20         test_yaffs_open_ENOENT
  21         test_yaffs_open_ENOTDIR
  22         test_yaffs_read
  23         test_yaffs_stat
  24         test_yaffs_truncate
  25         test_yaffs_unlink
  26         test_yaffs_unlink_EISDIR
  27         test_yaffs_unlink_ENAMETOOLONG
  28         test_yaffs_unlink_ENOENT
  29         test_yaffs_unlink_ENOTDIR
  30         test_yaffs_unmount
  31         test_yaffs_write
  32
  33
  34 tests to add
  35         test_yaffs_mount_EACCES         //Cannot be generated with yaffs.
  36         test_yaffs_mount_EINVAL         //Cannot be generated with yaffs.
  37         test_yaffs_mount_ELOOP          //Cannot be generated with yaffs.
  38         test_yaffs_mount_EMFILE         //Cannot be generated with yaffs.
  39
  40         test_yaffs_mount_ENOENT
  41         test_yaffs_mount_ENOTDIR        //Cannot be generated with yaffs.
  42         test_yaffs_mount_EBUSY          //called when trying to mount a new mount point with a mount point already mounted.
  43
  44         test_yaffs_unmount ->all error
  45
  46         test_yaffs_open_EACCES
  47         test_yaffs_open_ENOSPC
  48         test_yaffs_open_ELOOP   //Too many symbolic links were encountered in resolving pathname
  49         test yaffs_open_running_out_of_handles error
  50
  51         test_yaffs_close        //This function has already been called by the time this test is reached.
  52
  53         test_yaffs_unlink_EACCES
  54         test_yaffs_unlink_ELOOP
  55         test_yaffs_unlink_ENOENT
  56         test_yaffs_unlink_ENOMEM
  57
  58         test_yaffs_access_EACCESS
  59         test_yaffs_access_ELOOP
  60         test_yaffs_access_ENAMETOOLONG
  61         test_yaffs_access_ENOENT
  62         test_yaffs_access_ENOTDIR
  63         test_yaffs_access_ENIVAL        //mode is incorrect.
  64
  65         test_yaffs_ftruncate_EACCES
  66         test_yaffs_ftruncate_EFBIG
  67         test_yaffs_ftruncate_ENIVAL
  68         test_yaffs_ftruncate_EISDIR
  69         test_yaffs_ftruncate_ELOOP
  70         test_yaffs_ftruncate_ENOENT
  71         test_yaffs_ftruncate_ENOTDIR
  72         test_yaffs_ftruncate_EPERM
  73
  74         test_yaffs_truncate_EACCES
  75         test_yaffs_truncate_EFBIG
  76         test_yaffs_truncate_ENIVAL
  77         test_yaffs_truncate_EISDIR
  78         test_yaffs_truncate_ELOOP
  79         test_yaffs_truncate_ENAMETOOLONG
  80         test_yaffs_truncate_ENOENT
  81         test_yaffs_truncate_ENOTDIR
  82         test_yaffs_truncate_EPERM
  83
  84         check to see if an error code is generated when there isn't an error.
  85
  86
  87 How to add a test
  88         First create the test .c and .h file.
  89         The file name and test function name should be the same.
  90         This name should follow one of these formats:
  91         Test_yaffs_[function of yaffs which is been tested]
  92         Test_yaffs_[function of yaffs which is been tested]_[error trying to be generated]
  93
  94         The .c file needs to contain two functions.
  95         The first function needs to contain the code for the main test and will return -1 on a failure and 0 or greater on a success.
  96         The second function needs contain the code for cleaning up after the test. Cleaning up may include closing some open handles, recreating a file, ect.
  97         This second function needs to return -1 on a failure and 0 or greater on success.
  98
  99         The name of first function needs to be called the same as the file name (without the .c or .h)
 100         The second function's name needs be the same as the first function but with "_clean" added on the end.
 101
 102         So if a test is been created for the yaffs function yaffs_fish() then create these files
 103         Test_yaffs_fish.c
 104                 Contains int test_yaffs_fish(void); int test_yaffs_fish_clean(void);
 105         Test_yaffs_fish.h
 106                 Which includes "lib.h", "yaffsfs.h" header files.
 107
 108         Next write the test code in these files then add these files to the Makefile.
 109
 110         Add the name of the test files' object file (test_yaffs_fish.o ) to the TESTFILES tag around line 50 of the Makefile.
 111
 112
 113
 114         Now add the test functions to the test_list[] array in quick_tests.h
 115         The order of the tests matters. The idea is to test each yaffs_function individualy and only using tested yaffs_components before using this new yaffs_function.
 116         This array consists of: {[test function], [the clean function], [name of the tests which will be printed when the test fails]},
 117
 118         So add this line to the test_list[]: {test_yaffs_fish, test_yaffs_fish_clean, "test_yaffs_fish"},
 119
 120         Also include the test's .h file in the quick_test.h file: #include "test_yaffs_fish.h"
 121
 122         The test file should now make and run(you may need to make clean first).
 123
 124
 125
 126         PS: yaffs_fish() is a made up function for this README (in case you want to try and find this function in yaffs).
 127
 128
 129 BUGS AND WARNINGS
 130         remove the printf which prints yaffs_mounting.
 131         bug with opening a file with a name of 1,000,000 char long with no errors.
 132         bug with unlinking a file with 1,000,000 get the error ENOENT but should be geting ENAMETOOLONG.
 133
 134         WARNING- If yaffs is unmounted then most functions return ENODIR.
 135
 136         FIXED-ENOSPC error in programs test_yaffs_open_ENOTDIR and test_yaffs_open_ENOENT.
 137         FIXED-ENOENT been returned by yaffs_read but the handle is good and the yaffs_open function does not return an error.
 138
 139
 140
 141