summaryrefslogtreecommitdiffstats
path: root/tests/events_test.py
blob: b0d7cc6e5cc629bcf6d0c260ab27114e879ac181 (plain) (blame)
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
#    Copyright (C) 2015 Combox author(s). See AUTHORS.
#
#    This file is part of Combox.
#
#   Combox is free software: you can redistribute it and/or modify it
#   under the terms of the GNU General Public License as published by
#   the Free Software Foundation, either version 3 of the License, or
#   (at your option) any later version.
#
#   Combox is distributed in the hope that it will be useful, but
#   WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
#   General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with Combox (see COPYING).  If not, see
#   <http://www.gnu.org/licenses/>.

import os
import time
import yaml

from filecmp import cmp
from glob import glob
from os import path, remove
from shutil import copyfile

from nose.tools import *
from watchdog.observers import Observer

from combox.config import get_nodedirs
from combox.crypto import decrypt_and_glue
from combox.events import ComboxDirMonitor
from combox.file import (relative_path, purge_dir,
                         read_file, write_file,
                         rm_shards)

from combox.silo import ComboxSilo


CONFIG_DIR = path.join('tests', 'test-config')

config_file = path.join(CONFIG_DIR, 'config.yaml')
try:
    config = yaml.load(file(config_file, 'r'))
except yaml.YAMLError, exc:
    raise AssertionError("Error in configuration file:", exc)

FILES_DIR = path.abspath(config['combox_dir'])
TEST_FILE = path.join(FILES_DIR,'thgttg-21st.png')


def shardedp(f):
    """Checks if file's shards exists in the node directories"""

    nodes = get_nodedirs(config)
    i = 0
    for node in nodes:
        rel_path = relative_path(f, config)
        shard = "%s.shard%s" % (path.join(node, rel_path), i)
        i += 1
        assert path.isfile(shard)

def dirp(d):
    """
    Checks if the directory was created under node directories
    """

    nodes = get_nodedirs(config)
    for node in nodes:
        rel_path = relative_path(d, config)
        directory = path.join(node, rel_path)
        assert path.isdir(directory)

def renamedp(old_p, new_p):
    """
    Checks if the file shards or directory were/was renamed in the  under the node directories.

    old_p: old path to directory or file under combox directory.
    new_p: new (present) path to the directory or file under combox directory.
    """

    nodes = get_nodedirs(config)

    is_dir = True if path.isdir(new_p) else False
    i = 0

    for node in nodes:
        old_rel_path = relative_path(old_p, config)
        new_rel_path = relative_path(new_p, config)

        if is_dir:
            old_path = path.join(node, old_rel_path)
            new_path = path.join(node, new_rel_path)
        else:
            old_path = "%s.shard%s" % (path.join(node, old_rel_path), i)
            new_path = "%s.shard%s" % (path.join(node, new_rel_path), i)
            i += 1

        assert not path.exists(old_path)
        assert path.exists(new_path)


def path_deletedp(p, is_dir=False):
    """
    Checks if the directory or respective file shards  is deleted under node directories.

    p: path to the directory or file, under the combox directory, that was deleted.
    is_dir: set to True if `p' denotes a deleted directory. Default value is False.
    """

    nodes = get_nodedirs(config)

    i = 0
    for node in nodes:
        rel_path = relative_path(p, config)

        if is_dir:
            path_ = path.join(node, rel_path)
        else:
            path_ = "%s.shard%s" % (path.join(node, rel_path), i)
            i += 1

        assert not path.exists(path_)


def test_CDM():
    """
    Tests the ComboxDirMonitor class.
    """

    event_handler = ComboxDirMonitor(config)
    observer = Observer()
    observer.schedule(event_handler, FILES_DIR, recursive=True)
    observer.start()

    # Test - new file addition
    TEST_FILE_COPY_0 = "%s.mutant" % TEST_FILE
    copyfile(TEST_FILE, TEST_FILE_COPY_0)
    ## wait for ComboxDirMonitor to split and scatter the file in the
    ## node directories.
    time.sleep(1)
    ## check if the shards were created.
    shardedp(TEST_FILE_COPY_0)
    ## check if the new file's info is in silo
    silo = ComboxSilo(config)
    assert silo.exists(TEST_FILE_COPY_0)

    # Test - File deletion.
    remove(TEST_FILE_COPY_0)
    time.sleep(1)
    path_deletedp(TEST_FILE_COPY_0)
    ## check if the new file's info is removed from silo
    silo = ComboxSilo(config)
    assert not silo.exists(TEST_FILE_COPY_0)

    # Test - directory creation
    TEST_DIR_0 = path.join(FILES_DIR, 'foo')
    os.mkdir(TEST_DIR_0)
    time.sleep(2)
    ## check if TEST_DIR_0 is created under node directories.
    dirp(TEST_DIR_0)

    TEST_DIR_1 = path.join(TEST_DIR_0, 'bar')
    os.mkdir(TEST_DIR_1)
    time.sleep(2)
    ## check if TEST_DIR_1 is created under node directories.
    dirp(TEST_DIR_1)

    # Test - new file in a nested directory
    TEST_FILE_COPY_1 = path.join(TEST_DIR_1, path.basename(TEST_FILE))
    copyfile(TEST_FILE, TEST_FILE_COPY_1)
    time.sleep(1)
    shardedp(TEST_FILE_COPY_1)

    # Test - dir rename
    TEST_DIR_1_NEW = path.join(path.dirname(TEST_DIR_1),
                               'snafu')
    TEST_FILE_COPY_1_NEW = path.join(TEST_DIR_1_NEW, path.basename(TEST_FILE))

    os.rename(TEST_DIR_1, TEST_DIR_1_NEW)
    time.sleep(1)
    renamedp(TEST_DIR_1, TEST_DIR_1_NEW)
    renamedp(TEST_FILE_COPY_1, TEST_FILE_COPY_1_NEW)
    ## check if the new file's info is updated in silo
    silo = ComboxSilo(config)
    assert not silo.exists(TEST_FILE_COPY_1)
    assert silo.exists(TEST_FILE_COPY_1_NEW)

    # Test directory & file deletion
    purge_dir(TEST_DIR_0)
    # remove the directory itself.
    os.rmdir(TEST_DIR_0)
    time.sleep(2)
    path_deletedp(TEST_FILE_COPY_1_NEW)
    path_deletedp(TEST_DIR_1, True)
    path_deletedp(TEST_DIR_0, True)


    # Test - file modification
    lorem_file = path.join(FILES_DIR, 'lorem.txt')
    lorem_file_copy = "%s.copy" % lorem_file
    # this will shard lorem.txt.copy in the node directories.
    copyfile(lorem_file, lorem_file_copy)
    time.sleep(1)
    shardedp(lorem_file_copy)
    ## check if the lorem_file_copy's info is stored in silo
    silo = ComboxSilo(config)
    lorem_file_copy_hash = silo.db.get(lorem_file_copy)

    ipsum_file = path.join(FILES_DIR, 'ipsum.txt')
    ipsum_content = read_file(ipsum_file)
    lorem_copy_content = read_file(lorem_file_copy)
    lorem_copy_content = "%s\n%s" % (lorem_copy_content, ipsum_content)

    # write lorem's new content to  lorem_file_copy
    write_file(lorem_file_copy, lorem_copy_content)
    time.sleep(1)
    ## check if the lorem_file_copy's info is updated in silo
    silo = ComboxSilo(config)
    assert lorem_file_copy_hash != silo.db.get(lorem_file_copy)


    # decrypt_and_glue will decrypt the file shards, glues them and
    # writes it to the respective file
    decrypt_and_glue(lorem_file_copy, config)
    time.sleep(1)

    lorem_content_from_disk = read_file(lorem_file_copy)
    assert lorem_copy_content == lorem_content_from_disk

    # remove lorem_file_copy and confirm that its shards are deleted
    # in the node directories.
    remove(lorem_file_copy)
    time.sleep(1)
    path_deletedp(lorem_file_copy)
    ## check if the lorem_file_copy's info is deleted from silo
    silo = ComboxSilo(config)
    assert not silo.exists(lorem_file_copy)

    observer.stop()
    observer.join()


def test_housekeep():
    """ComboxDirMonitor's housekeep method test."""

    # test file deletion and addition

    lorem = path.join(FILES_DIR, 'lorem.txt')
    lorem_moved = path.join(FILES_DIR, 'lorem.moved.txt')
    os.rename(lorem, lorem_moved)

    cdm = ComboxDirMonitor(config)
    cdm.housekeep()

    silo = ComboxSilo(config)
    assert not silo.exists(lorem)
    assert silo.exists(lorem_moved)
    shardedp(lorem_moved)

    os.rename(lorem_moved, lorem)
    rm_shards(lorem_moved, config)
    silo.remove(lorem_moved)

    # test file modification

    lorem_ipsum = path.join(FILES_DIR, 'lorem.ipsum.txt')
    copyfile(lorem, lorem_ipsum)
    assert path.exists(lorem_ipsum)

    cdm = ComboxDirMonitor(config)
    cdm.housekeep()

    silo = ComboxSilo(config)
    assert silo.exists(lorem_ipsum)

    ipsum = path.join(FILES_DIR, "ipsum.txt")
    ipsum_content = read_file(ipsum)

    lorem_ipsum_content = read_file(lorem_ipsum)
    lorem_ipsum_content = "%s\n%s" % (lorem_ipsum_content, ipsum_content)
    write_file(lorem_ipsum, lorem_ipsum_content)

    cdm.housekeep()

    silo = ComboxSilo(config)
    assert not silo.stale(lorem_ipsum)
    os.remove(lorem_ipsum)
    silo.remove(lorem_ipsum)