path: root/tests/events_test.py

#    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)