d16c9c7a31290353709ba2a41dda198ab3929b85
[yaffs2.git] / 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
7 test_yaffs_access.c
8 test_yaffs_access_EINVAL.c
9 test_yaffs_access_ELOOP.c
10 test_yaffs_access_ELOOP_dir.c
11 test_yaffs_access_ENOENT2.c
12 test_yaffs_access_ENOENT.c
13 test_yaffs_access_ENOTDIR.c
14 test_yaffs_access_EROFS.c
15
16 test_yaffs_chmod.c
17 test_yaffs_chmod_EINVAL.c
18 test_yaffs_chmod_ELOOP.c
19 test_yaffs_chmod_ELOOP_dir.c
20 test_yaffs_chmod_ENOENT2.c
21 test_yaffs_chmod_ENOENT.c
22 test_yaffs_chmod_ENOTDIR.c
23 test_yaffs_chmod_EROFS.c
24
25 test_yaffs_close.c
26 test_yaffs_close_EBADF.c
27
28 test_yaffs_fchmod.c
29 test_yaffs_fchmod_EBADF.c
30 test_yaffs_fchmod_EINVAL.c
31 test_yaffs_fchmod_EROFS.c
32
33 test_yaffs_fdatasync.c
34 test_yaffs_fdatasync_EBADF.c
35 test_yaffs_fdatasync_EROFS.c
36
37 test_yaffs_flush.c
38 test_yaffs_flush_EBADF.c
39 test_yaffs_flush_EROFS.c
40
41 test_yaffs_freespace.c
42 test_yaffs_freespace_EINVAL.c
43
44 test_yaffs_fstat.c
45 test_yaffs_fstat_EBADF.c
46
47 test_yaffs_fsync.c
48 test_yaffs_fsync_EBADF.c
49 test_yaffs_fsync_EROFS.c
50
51 test_yaffs_ftruncate_big_file.c
52 test_yaffs_ftruncate.c
53 test_yaffs_ftruncate_EBADF.c
54 test_yaffs_ftruncate_EINVAL.c
55 test_yaffs_ftruncate_EROFS.c
56
57 test_yaffs_inodecount.c
58 test_yaffs_inodecount_EINVAL.c
59
60 test_yaffs_link.c
61 test_yaffs_link_EEXIST.c
62 test_yaffs_link_ELOOP_dir.c
63 test_yaffs_link_ENOENT2.c
64 test_yaffs_link_ENOENT3.c
65 test_yaffs_link_ENOENT4.c
66 test_yaffs_link_ENOENT.c
67 test_yaffs_link_ENOTDIR2.c
68 test_yaffs_link_ENOTDIR.c
69 test_yaffs_link_EROFS.c
70
71 test_yaffs_lseek_big_file.c
72 test_yaffs_lseek.c
73 test_yaffs_lseek_EBADF.c
74 test_yaffs_lseek_EINVAL.c
75 test_yaffs_lseek_EROFS.c
76
77 test_yaffs_lstat.c
78 test_yaffs_lstat_ENOENT.c
79 test_yaffs_lstat_ENOTDIR.c
80
81 test_yaffs_mkdir.c
82 test_yaffs_mkdir_EEXIST.c
83 test_yaffs_mkdir_ELOOP_dir.c
84 test_yaffs_mkdir_ENOENT.c
85 test_yaffs_mkdir_ENOTDIR.c
86 test_yaffs_mkdir_EROFS.c
87
88 test_yaffs_mount2.c
89 test_yaffs_mount2_ENODEV.c
90 test_yaffs_mount.c
91 test_yaffs_mount_EBUSY.c
92 test_yaffs_mount_ENAMETOOLONG.c
93 test_yaffs_mount_ENODEV.c
94
95 test_yaffs_open.c
96 test_yaffs_open_EEXIST.c
97 test_yaffs_open_EINVAL2.c
98 test_yaffs_open_EINVAL.c
99 test_yaffs_open_EISDIR.c
100 test_yaffs_open_ELOOP.c
101 test_yaffs_open_ELOOP_dir.c
102 test_yaffs_open_ENAMETOOLONG.c
103 test_yaffs_open_ENOENT.c
104 test_yaffs_open_ENOTDIR.c
105 test_yaffs_open_EROFS.c
106
107 test_yaffs_read.c
108 test_yaffs_read_EBADF.c
109 test_yaffs_read_EINVAL.c
110
111 test_yaffs_remount_EINVAL.c
112 test_yaffs_remount_ENODEV.c
113 test_yaffs_remount_force_off_read_only_off.c
114 test_yaffs_remount_force_off_read_only_on.c
115 test_yaffs_remount_force_on_read_only_off.c
116 test_yaffs_remount_force_on_read_only_on.c
117
118 test_yaffs_rename.c
119 test_yaffs_rename_dir.c
120 test_yaffs_rename_dir_ENOENT2.c
121 test_yaffs_rename_dir_ENOENT.c
122 test_yaffs_rename_dir_not_empty.c
123 test_yaffs_rename_dir_to_file.c
124 test_yaffs_rename_EEXISTS.c
125 test_yaffs_rename_EINVAL.c
126 test_yaffs_rename_ELOOP_dir.c
127 test_yaffs_rename_ENOENT.c
128 test_yaffs_rename_ENOTDIR.c
129 test_yaffs_rename_EROFS.c
130 test_yaffs_rename_file_to_dir.c
131
132 test_yaffs_rmdir.c
133 test_yaffs_rmdir_EBUSY.c
134 test_yaffs_rmdir_EINVAL.c
135 test_yaffs_rmdir_ELOOP_dir.c
136 test_yaffs_rmdir_ENOENT.c
137 test_yaffs_rmdir_ENOTDIR.c
138 test_yaffs_rmdir_EROFS.c
139
140 test_yaffs_stat.c
141 test_yaffs_stat_ELOOP.c
142 test_yaffs_stat_ELOOP_dir.c
143 test_yaffs_stat_ENOENT2.c
144 test_yaffs_stat_ENOENT.c
145 test_yaffs_stat_ENOTDIR.c
146
147 test_yaffs_symlink.c
148 test_yaffs_symlink_EEXIST.c
149 test_yaffs_symlink_ELOOP_dir.c
150 test_yaffs_symlink_ENOENT2.c
151 test_yaffs_symlink_ENOENT.c
152 test_yaffs_symlink_ENOTDIR.c
153 test_yaffs_symlink_EROFS.c
154
155 test_yaffs_sync.c
156 test_yaffs_sync_ENODEV.c
157 test_yaffs_sync_EROFS.c
158
159 test_yaffs_totalspace.c
160 test_yaffs_totalspace_EINVAL.c
161
162 test_yaffs_truncate_big_file.c
163 test_yaffs_truncate.c
164 test_yaffs_truncate_EINVAL.c
165 test_yaffs_truncate_EISDIR.c
166 test_yaffs_truncate_ELOOP.c
167 test_yaffs_truncate_ELOOP_dir.c
168 test_yaffs_truncate_ENOENT2.c
169 test_yaffs_truncate_ENOENT.c
170 test_yaffs_truncate_ENOTDIR.c
171 test_yaffs_truncate_EROFS.c
172
173 test_yaffs_unlink.c
174 test_yaffs_unlink_EISDIR.c
175 test_yaffs_unlink_ELOOP_dir.c
176 test_yaffs_unlink_ENAMETOOLONG.c
177 test_yaffs_unlink_ENOENT2.c
178 test_yaffs_unlink_ENOENT.c
179 test_yaffs_unlink_ENOTDIR.c
180 test_yaffs_unlink_EROFS.c
181
182 test_yaffs_unmount2.c
183 test_yaffs_unmount2_EINVAL.c
184 test_yaffs_unmount2_ENODEV.c
185 test_yaffs_unmount2_with_handle_open_and_forced_mode_off.c
186 test_yaffs_unmount2_with_handle_open_and_forced_mode_on.c
187 test_yaffs_unmount.c
188 test_yaffs_unmount_EBUSY.c
189 test_yaffs_unmount_ENAMETOOLONG.c
190 test_yaffs_unmount_ENODEV.c
191
192 test_yaffs_write_big_file.c
193 test_yaffs_write.c
194 test_yaffs_write_EBADF.c
195 test_yaffs_write_EROFS.c
196
197
198
199 Tests to add
200
201         test_yaffs_chmod_ENAMETOOLONG
202
203         test_yaffs_lstat_ENAMETOOLONG
204
205         test_yaffs_readlink
206         test_yaffs_readlink_ENOENT
207         test_yaffs_readlink_ENOTDIR
208         test_yaffs_readlink_ELOOP
209         test_yaffs_readlink_ENAMETOOLONG
210
211         test_yaffs_mkdir_ENAMETOOLONG
212
213         test_yaffs_symlink_ENAMETOOLONG
214
215         test_yaffs_mount2_ENAMETOOLONG
216         test_yaffs_mount2_with read only set
217
218         test_yaffs_unmount2_ENAMETOOLONG
219
220         test_yaffs_remount_force_off_read_only_on
221         test_yaffs_remount_force_on_read_only_on
222
223         test_yaffs_freespace_ENAMETOOLONG
224         test_yaffs_totalspace_ENAMETOOLONG
225         test_yaffs_inodecount_ENAMETOOLONG
226
227         test_yaffs_opendir
228
229         test_yaffs_readdir
230
231         test_yaffs_rewinddir
232
233         test_yaffs_closedir
234
235         test_yaffs_link_ENAMETOOLONG
236         test_yaffs_link_EPERM
237
238         test_yaffs_rmdir_ENOTEMPTY
239
240         test_yaffs_rename_EMLINK
241         test_yaffs_rename_EEXISTS or EPERM
242
243         test_yaffs_dup
244         test_yaffs_dup_EBADF            
245
246         test_yaffs_open_ENOSPC
247
248         test yaffs_open_running_out_of_handles error
249
250         test_yaffs_stat_ENAMETOOLONG
251
252         test_yaffs_read_big_file
253         test what happens if you read off the end of the file?
254
255         test_yaffs_pread
256         test_yaffs_pread_EBADF
257         test_yaffs_pread_EINVAL
258         test_yaffs_pread_big_file
259
260         test_yaffs_write_big_file
261         test_yaffs_write_EINVAL
262         What happens when you run out of space?
263         
264         test_yaffs_write_EBADF
265         test_yaffs_write
266         test_yaffs_pwrite_big_file
267         test_yaffs_pwrite_EINVAL
268
269         test_yaffs_unlink_ENOMEM
270
271         test_yaffs_access_ENAMETOOLONG
272         test_yaffs_access_ENOENT_generated_with_a_dangling_symbloic_link
273
274         test_yaffs_truncate_ENAMETOOLONG
275         Add a truncate function for truncating a file size to -1.
276
277         What happens if a handle is opened to a file and the file is then deleted?
278         Check to see if yaffs generates an error code for no reason.
279         What happens when a file is opened with no modes set?
280
281         What happens when yaffs is unmounted twice?
282
283         What happens when open a handle, unmount yaffs and then try to use the handle? 
284
285         What happens when a mount point is mounted using mount2 with read only mode set and then a file is chmoded? 
286
287         Try to remove lost and found dir and replace it with a file of the same name.
288
289         Change the mode of the lost and found dir to read only.
290
291 Tests which do not exist in yaffs:
292         test_yaffs_close        //This function has already been called by the time this test is reached, 
293                                 //so there is no point in testing it.
294
295         test_yaffs_link_EMLINK          //should not happen on yaffs
296         test_yaffs_link_ELOOP
297         
298         test_yaffs_lstat_ELOOP
299
300         test_yaffs_mkdir_ELOOP
301
302         //the yaffs_mknod function does not exist in yaffsfs, so these tests will not be added.
303         test_yaffs_mknod_EACCES
304         test_yaffs_mknod_EEXIST
305         test_yaffs_mknod_EINVAL
306         test_yaffs_mknod_ELOOP
307         test_yaffs_mknod_ENAMETOOLONG
308         test_yaffs_mknod_ENOENT
309         test_yaffs_mknod_ENOTDIR
310         test_yaffs_mknod_EROFS
311
312         teat_yaffs_mount_ELOOP
313
314         test_yaffs_mount2_EINVAL        //cannot happen in yaffs since the mode is not checked.
315         test_yaffs_mount2_ENOTDIR       //cannot be generated in yaffs.
316         test_yaffs_mount2_ENOENT        //cannot be generated in yaffs.
317         test_yaffs_mount2_ELOOP
318
319         test_yaffs_remount_ENOENT       //cannot be generated in yaffs
320         test_yaffs_remount_ENOTDIR      //cannot be generated in yaffs
321
322         test_yaffs_unmount2_ENOENT      //cannot be generated in yaffs.
323         test_yaffs_unmount2_ENOTDIR     //cannot be generated in yaffs.
324
325 How to add a test
326         First create the test .c and .h file.
327         The file name and test function name should be the same. 
328         This name should follow one of these formats: 
329         Test_yaffs_[function of yaffs which is been tested]
330         Test_yaffs_[function of yaffs which is been tested]_[error trying to be generated]
331         
332         The .c file needs to contain two functions.
333         The first function needs to contain the code for the main test and will 
334         return -1 on a failure and 0 or greater on a success.
335         The second function needs contain the code for cleaning up after the test. 
336         Cleaning up may include closing some open handles, recreating a file, ect. 
337         This second function needs to return -1 on a failure and 0 or greater on success.
338
339         The name of first function needs to be called the same as the file 
340         name (without the .c or .h)
341         The second function's name needs be the same as the first function but 
342         with "_clean" added on the end.
343         
344         So if a test is been created for the yaffs function yaffs_foo() then 
345         create these files
346         test_yaffs_foo.c
347                 Contains int test_yaffs_foo(void); int test_yaffs_foo_clean(void);
348         test_yaffs_foo.h
349                 Which includes "lib.h", "yaffsfs.h" header files.
350
351         Next write the test code in these files then add these files to the Makefile.
352
353         Add the name of the test files' object file (test_yaffs_foo.o ) to the 
354         TESTFILES tag around line 50 of the Makefile.   
355
356         Now add the test functions to the test_list[] array in quick_tests.h
357         The order of the tests matters. The idea is to test each yaffs_function 
358         individualy and only using tested yaffs_components before using this new 
359         yaffs_function. 
360         This array consists of: 
361         {[test function], [the clean function], [name of the tests which will be printed when the test fails]}, 
362         
363         So add this line to the test_list[]: {test_yaffs_foo, test_yaffs_foo_clean, "test_yaffs_foo"},
364
365         Also include the test's .h file in the quick_test.h file: #include "test_yaffs_foo.h"
366         
367         The test file should now make and run(you may need to make clean first). 
368
369
370
371         PS: yaffs_foo() is a made up function for this README (in case you want 
372         to find this function in yaffs). 
373
374
375
376
377
378