File: backup_test.sh

package info (click to toggle)
kworkflow 1%3A0.6.2-1~exp1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 4,148 kB
  • sloc: sh: 22,233; perl: 2,172; ansic: 96; python: 72; sql: 28; makefile: 19
file content (218 lines) | stat: -rwxr-xr-x 7,963 bytes parent folder | download
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
#!/bin/bash

include './src/backup.sh'
include './src/kwlib.sh'
include './tests/utils.sh'

function setUp()
{
  KW_DATA_DIR="$SHUNIT_TMPDIR/data"
  decompress_path="$SHUNIT_TMPDIR/tmp-kw-backup"

  mkdir -p "$KW_DATA_DIR"
  mkdir -p "$decompress_path"

  cp -r tests/samples/configs "$KW_DATA_DIR"
  cp -r tests/samples/pomodoro_data "$KW_DATA_DIR/pomodoro"
  cp -r tests/samples/statistics "$KW_DATA_DIR"
}

function test_create_backup()
{
  local output
  local filepath
  local current_path="$PWD"
  declare -a expected_files
  declare -a tar_files

  # expected_files is an array whose elements are the files from our mock
  # KW_DATA_DIR sorted by dictonary order
  mapfile -t expected_files < <(for f in $(find "$KW_DATA_DIR" -type f | sort -d); do
    str_remove_prefix "$f" "$KW_DATA_DIR/"
  done)

  output=$(create_backup /randomly/random/path)
  assertEquals "$LINENO" "$output" 'We could not find the path'

  output=$(create_backup "$SHUNIT_TMPDIR" 'SILENT')
  filepath=$(str_remove_prefix "$output" 'Backup successfully created at ')
  assertTrue "($LINENO) - Tar file was not created" "[[ -f $filepath ]]"

  tar_files=("$(tar -taf "$filepath" | grep -e '[^/]$' | sort -d | cut -c3-)")
  compare_command_sequence '' "$LINENO" 'expected_files' "${tar_files[@]}"
}

function test_restore_backup()
{
  local output

  output=$(restore_backup "$SHUNIT_TMPDIR"/random/path/backup.tar.gz)
  assertEquals "($LINENO)" "$output" 'We could not find this file'

  output=$(restore_backup tests/samples/kw-backup-2021-08-07_23-42-51.tar.gz)
  assertTrue "($LINENO) Not all files were extracted" \
    "[[ -f $KW_DATA_DIR/configs/configs/config-test ]] && [[ -f $KW_DATA_DIR/configs/metadata/config-test ]]"

  rm -rf "${KW_DATA_DIR:?}"/*
  options_values['FORCE']=1
  output=$(restore_backup tests/samples/kw-backup-2021-08-07_23-42-51.tar.gz)
  assertTrue "($LINENO) Not all files were extracted" \
    "[[ -f $KW_DATA_DIR/configs/configs/config-test ]] && [[ -f $KW_DATA_DIR/configs/metadata/config-test ]]"
}

function test_restore_config()
{
  local config_2_last_line

  rm -rf "${KW_DATA_DIR:?}"/*

  restore_config

  assertTrue "($LINENO) - Config file wasn't restored" \
    "[[ -f $KW_DATA_DIR/configs/configs/config-test ]]"

  assertTrue "($LINENO) - Config metadata wasn't restored" \
    "[[ -f $KW_DATA_DIR/configs/metadata/config-test ]]"

  # Restore config with same file name and different content
  cp "$KW_DATA_DIR/configs/configs/config-test" "$KW_DATA_DIR/configs/configs/config-2"
  cp "$KW_DATA_DIR/configs/metadata/config-test" "$KW_DATA_DIR/configs/metadata/config-2"
  cp "$KW_DATA_DIR/configs/configs/config-test" "$decompress_path/configs/configs/config-2"
  cp "$KW_DATA_DIR/configs/metadata/config-test" "$decompress_path/configs/metadata/config-2"
  printf '%s\n' '# This line is different' >> "$decompress_path/configs/configs/config-2"

  config_2_last_line=$(tail -n 1 "$KW_DATA_DIR/configs/configs/config-2")
  output=$(printf '%s\n' 'n' | restore_config)
  assertEquals "$LINENO" "$(printf '%s\n' "$output" | head -n 1)" 'It looks like that the file config-2 differs from the backup version.'

  # Since we answered no above, we expect config-2 to remain the same
  assert_equals_helper "config-2 should've reamined the same" "$LINENO" "$config_2_last_line" "$(tail -n 1 "$KW_DATA_DIR/configs/configs/config-2")"

  output=$(printf '%s\n' 'y' | restore_config)
  assertEquals "$LINENO" "$(printf '%s\n' "$output" | head -n 1)" 'It looks like that the file config-2 differs from the backup version.'

  # Now config-2 should be changed, as we said yes above
  config_2_last_line=$(tail -n 1 "$KW_DATA_DIR/configs/configs/config-2")
  assertEquals "$LINENO" "$config_2_last_line" '# This line is different'
}

function test_restore_data_from_dir()
{
  declare -a expected_cmd=(
    'It looks like that the file 2021/04/04 differs from the backup version.'
    'Do you want to:'
    '(1) Replace all duplicate files with backup'
    '(2) Keep all the old files'
    '(3) Aggregate all old and backup files'
  )

  mkdir -p "$decompress_path/pomodoro/"
  cp -r tests/samples/pomodoro_data/2021 "$decompress_path/pomodoro/"

  # Test duplicate files
  printf '%s\n' '# This line is different' >> "$decompress_path/pomodoro/2021/04/04"

  output=$(printf '%s\n' '2' | restore_data_from_dir 'pomodoro')
  assertNotEquals "$LINENO" '# This line is different' "$(tail -n 1 "$KW_DATA_DIR/pomodoro/2021/04/04")"

  output=$(printf '%s\n' '1' | restore_data_from_dir 'pomodoro')
  compare_command_sequence '' "$LINENO" 'expected_cmd' "$output"
  assertEquals "$LINENO" '# This line is different' "$(tail -n 1 "$KW_DATA_DIR/pomodoro/2021/04/04")"

  expected_cmd+=("patching file $KW_DATA_DIR/pomodoro/2021/04/04")

  printf '%s\n' '# Another different line' >> "$decompress_path/pomodoro/2021/04/04"
  output=$(printf '%s\n' '3' | restore_data_from_dir 'pomodoro')
  compare_command_sequence '' "$LINENO" 'expected_cmd' "$output"
  assertEquals "$LINENO" '# Another different line' "$(tail -n 1 "$KW_DATA_DIR/pomodoro/2021/04/04")"
}

function test_restore_pomodoro()
{
  rm -rf "${KW_DATA_DIR:?}"/*
  mkdir -p "$decompress_path/pomodoro/"

  cp -r tests/samples/pomodoro_data/2021 "$decompress_path/pomodoro/"
  touch "$decompress_path/pomodoro/tags"

  restore_pomodoro

  assertTrue "($LINENO) - Pomodoro wasn't restored" \
    "cmp -s $KW_DATA_DIR/pomodoro/2021/04/04 $decompress_path/pomodoro/2021/04/04"
}

function test_restore_statistics()
{
  rm -rf "${KW_DATA_DIR:?}"/*
  mkdir -p "$decompress_path/statistics/"

  cp -r tests/samples/statistics "$decompress_path"

  restore_statistics

  assertTrue "($LINENO) - Statistics weren't restored" \
    "[[ -d $KW_DATA_DIR/statistics/2021/10 ]] && [[ -d $KW_DATA_DIR/statistics/2020/05 ]]"
}

function test_parse_backup_options()
{
  local output
  local current_path="$PWD"

  unset options_values
  declare -gA options_values
  parse_backup_options --restore backup.tar.gz
  assert_equals_helper 'RESTORE_PATH could not be set' "($LINENO)" 'backup.tar.gz' "${options_values['RESTORE_PATH']}"

  unset options_values
  declare -gA options_values
  parse_backup_options -r backup.tar.gz
  assert_equals_helper 'RESTORE_PATH could not be set' "($LINENO)" 'backup.tar.gz' "${options_values['RESTORE_PATH']}"

  unset options_values
  declare -gA options_values
  parse_backup_options --force
  assert_equals_helper 'FORCE could not be set' "($LINENO)" '1' "${options_values['FORCE']}"

  unset options_values
  declare -gA options_values
  parse_backup_options -f
  assert_equals_helper 'FORCE could not be set' "($LINENO)" '1' "${options_values['FORCE']}"

  unset options_values
  declare -gA options_values
  parse_backup_options /path
  assert_equals_helper 'BACKUP_PATH could not be set' "($LINENO)" '/path' "${options_values['BACKUP_PATH']}"

  unset options_values
  declare -gA options_values
  parse_backup_options --restore > /dev/null
  assert_equals_helper 'ERROR could not be set' "($LINENO)" "kw backup: option '--restore' requires an argument" "${options_values['ERROR']}"

  unset options_values
  declare -gA options_values
  parse_backup_options -b > /dev/null
  assert_equals_helper 'ERROR could not be set' "($LINENO)" "kw backup: invalid option -- 'b'" "${options_values['ERROR']}"

  unset options_values
  declare -gA options_values
  parse_backup_options --ristore > /dev/null
  assert_equals_helper 'ERROR could not be set' "($LINENO)" "kw backup: unrecognized option '--ristore'" "${options_values['ERROR']}"

  cd "$SHUNIT_TMPDIR" || {
    fail "($LINENO): It was not possible to move to temporary directory"
    return
  }

  unset options_values
  declare -gA options_values
  parse_backup_options
  assert_equals_helper 'BACKUP_PATH could not be set' "($LINENO)" "$SHUNIT_TMPDIR" "${options_values['BACKUP_PATH']}"

  cd "$current_path" || {
    fail "($LINENO): It was not possible to move back from temp directory"
    return
  }
}

invoke_shunit