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