README.rst 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. Torture for ownCloud Client
  2. ===========================
  3. This is a set of scripts comprising of two parts:
  4. * ``torture_gen_layout.pl``: Generation of layout files (random)
  5. * ``torture_create_files.pl``: Generation of a real file tree based on the
  6. layout files (deterministic)
  7. These scripts allow a data set to be produced with the following criteria:
  8. * realistic in naming
  9. * realistic in file size
  10. * realistic in structural size
  11. without checking in the actual data. Instead, a layout file that gets generated
  12. once (reference.lay) is checked in. This makes it possible to produce
  13. standardized benchmarks for mirall. It allows checking for files gone
  14. missing in action and other kinds of corruption produced during sync runs.
  15. ``torture_create_files.pl`` can be fine tuned via variables in the script
  16. header. It sources its file names from ``dict`` wordlist, file extensions and
  17. other parameters can be added as needed. The defaults should be reasonable
  18. in terms of size.
  19. The ``references/`` directory contains default folder layouts.
  20. Usage
  21. -----
  22. In order to create a reference layout and create a tree from it::
  23. ./torture_gen_layout.pl > reference.lay
  24. ./torture_create_files.pl reference.lay <targetdir>
  25. TODO
  26. ----
  27. * Based on the layout file, write a validator that checks files for existence
  28. and size without requiring a full reference tree to be created via
  29. ``./torture_gen_layout.pl``.
  30. * The current file naming is fairly tame (i.e. almost within ASCII range).
  31. Extending it randomly is dangerous, we first need to filter all
  32. characters forbidden by various OSes. Or maybe not, because we want to
  33. see what happens? :-). Anyway, you have been warned.