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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
Multiple backup generations
===========================
This chapter contains tests for Obnam's handling of multiple
generations: making incremental backups, forgetting generations, and
so on. We assume that backing up any individual directory tree works
fine, regardless of whether it is for the initial generation or an
incremental one. In the previous chapter for basic backups, we've
already dealt with those. This chapter focuses on generation handling
only.
Incremental backup generations (`obnam backup`)
------------------------------
First of all, most importantly, we must be able to make more than one
backup generation, and restore them. The live data in each generation
is different, but there are unchanged parts as well. For simplicity,
we'll assume that if we can do two generations, we can do any number.
It's possible that the 12765th generation might break, but that's
unlikely, and it's even less likely we'll guess it. (If it turns out
to actually happen, we'll add a regression test when we find the
problem.)
SCENARIO backup two generations
GIVEN 1MB of new data in directory L
AND a manifest of directory L in G1
WHEN user backs up directory L to repository R
GIVEN 2MB of new data in directory L
AND a manifest of directory L in G2
WHEN user backs up directory L to repository R
AND user restores generation 1 to R1 from repository R
AND user restores generation 2 to R2 from repository R
THEN L, restored to R1, matches manifest G1
AND L, restored to R2, matches manifest G2
Listing generations (`obnam generations`, `obnam genids`)
-------------------
When we make some number of generations, the Obnam generation listing
commands should show that number of generations.
SCENARIO list generations
GIVEN 1MB of new data in directory L
WHEN user backs up directory L to repository R
AND user backs up directory L to repository R
AND user backs up directory L to repository R
THEN user sees 3 generations in repository R
AND user sees 3 generation ids in repository R
Listing contents of a generation (`obnam ls`)
--------------------------------
We'll assume the `obnam ls` command shows any generation.
However, there's a couple of ways of using it: either listing
everything, or only a specific directory to list.
SCENARIO list generation content
GIVEN 1MB of new data in directory D
WHEN user backs up directory D to repository R
AND user lists latest generation in repository R into all.txt
THEN all.txt matches /.*/D/.
WHEN user lists D in latest generation in repository R into some.txt
THEN all lines in some.txt match (/D|Generation)
The first line of the generation listing contains the word
"Generation". Every other line should contain the directory we
requested as part of the pathname.
There was a bug in Obnam 1.5 (and possibly other versions) that
listing contents of a directory that ends in a slash (but isn't the
root directory) fails. The following is a test for that bug by
requesting `D/` to be listed, and verifying that we get at least one
line for that.
WHEN user lists D/ in latest generation in repository R into bug.txt
THEN bug.txt matches /D
Comparing generations (`obnam diff`)
------------------------------------
Once we've backed up two generations, we need to be able to see the
difference. First of all, the diff should be empty when the
generations are identical:
SCENARIO diff identical generations
GIVEN 1K of new data in directory L
WHEN user backs up directory L to repository R
AND user backs up directory L to repository R
AND user diffs generations 1 and 2 in repository R into D
THEN file D is empty
If we make a change to the data, that should be reflected in the diff.
We'll assume the diff works, we'll just check whether it's empty.
SCENARIO diff modified generations
GIVEN 1K of new data in directory L
WHEN user backs up directory L to repository R
GIVEN 1K of new data in directory L
WHEN user backs up directory L to repository R
AND user diffs generations 1 and 2 in repository R into D
THEN file D is not empty
Forgetting a specific generation (`obnam forget`)
--------------------------------
We need to be able to remove any generation. As a corner case, we
should be able to remove the only generation. We'll test by making two
generations, then removing both, and after removing the first one,
checking that the remaining one is the one we want.
SCENARIO remove specific generations
GIVEN 1kB of new data in directory L
AND a manifest of directory L in M1
WHEN user backs up directory L to repository R
GIVEN 1kB of new data in directory L
AND a manifest of directory L in M2
WHEN user backs up directory L to repository R
AND user forgets the oldest generation in repository R
THEN user sees 1 generation in repository R
WHEN user restores their latest generation in repository R into X
THEN L, restored to X, matches manifest M2
WHEN user forgets the oldest generation in repository R
THEN user sees 0 generations in repository R
Forgetting generations according to a schedule (`obnam forget --keep`)
-------------------------------------------------------------
The normal way of forgetting generations is with the `obnam forget
--keep` option.
SCENARIO remove generations according to schedule
GIVEN 1kB of new data in directory L
WHEN user backs up directory L to repository R
GIVEN 1kB of new data in directory L
AND a manifest of directory L in M
WHEN user backs up directory L to repository R
AND user forgets according to schedule 1y in repository R
THEN user sees 1 generation in repository R
WHEN user restores their latest generation in repository R into X
THEN L, restored to X, matches manifest M
|
