summaryrefslogtreecommitdiff
path: root/yarns/0300-kdirstat-integration.yarn
blob: 6408908b496ea0327b02a950de538e3ae9f313e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
kdirstat integration: producing kdirstat cache files
====================================================

Obnam implements an ls variant whose output format is compatible with
the kdirstat cache format.

Create a simple cache file
--------------------------

Here we create a simple backup and dump the output as a kdirstat cache
file.

    SCENARIO create and do a simple check of a kdirstat cache
    GIVEN 10kB of new data in directory L
    WHEN user U backs up directory L to repository R
    AND user U creates a kdirstat cache file C of repository R
    THEN first line of C matches [kdirstat 4.0 cache file]
    AND for each entry in directory L a line in the kdircache C matches it

Now a backup containing some interesting objects

    SCENARIO create and do a check of a kdirstat cache of interesting objects
    ASSUMING extended attributes are allowed for users
    GIVEN directory L with interesting filesystem objects
    WHEN user U backs up directory L to repository R
    AND user U creates a kdirstat cache file C of repository R
    THEN first line of C matches [kdirstat 4.0 cache file]
    AND for each entry in directory L a line in the kdircache C matches it

Validating the cache file
-------------------------

Sadly there seems to be no CLI usable program to read or validate the
produced cache files. If there were we would do a more thorough test
of the syntax here.