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