#
# The Qubes OS Project, http://www.qubes-os.org
#
# Copyright (C) 2016 Marek Marczykowski-Górecki
#                               <marmarek@invisiblethingslab.com>
#
# This program 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 2 of the License, or
# (at your option) any later version.
#
# This program 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 this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#

import os

import shutil

import qubes.storage.lvm
import qubes.tests
import qubes.tests.storage_lvm
import qubes.vm.appvm


class StorageTestMixin(qubes.tests.SystemTestsMixin):
    def setUp(self):
        super(StorageTestMixin, self).setUp()
        self.init_default_template()
        self.vm1 = self.app.add_new_vm(qubes.vm.appvm.AppVM,
            name=self.make_vm_name('vm1'),
            label='red')
        self.vm1.create_on_disk()
        self.vm2 = self.app.add_new_vm(qubes.vm.appvm.AppVM,
            name=self.make_vm_name('vm2'),
            label='red')
        self.vm2.create_on_disk()
        self.pool = None
        self.init_pool()
        self.app.save()

    def init_pool(self):
        ''' Initialize storage pool to be tested, store it in self.pool'''
        raise NotImplementedError

    def test_000_volatile(self):
        '''Test if volatile volume is really volatile'''
        size = 32*1024*1024
        volume_config = {
            'pool': self.pool.name,
            'size': size,
            'internal': False,
            'save_on_stop': False,
            'rw': True,
        }
        testvol = self.vm1.storage.init_volume('testvol', volume_config)
        self.vm1.storage.get_pool(testvol).create(testvol)
        self.app.save()
        self.vm1.start()
        p = self.vm1.run(
            'head -c {} /dev/zero 2>&1 | diff -q /dev/xvde - 2>&1'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertEqual(p.returncode, 0,
            'volatile image not clean: {}'.format(stdout))
        self.vm1.run('echo test123 > /dev/xvde', user='root', wait=True)
        self.vm1.shutdown(wait=True)
        self.vm1.start()
        p = self.vm1.run(
            'head -c {} /dev/zero 2>&1 | diff -q /dev/xvde - 2>&1'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertEqual(p.returncode, 0,
            'volatile image not volatile: {}'.format(stdout))

    def test_001_non_volatile(self):
        '''Test if non-volatile volume is really non-volatile'''
        size = 32*1024*1024
        volume_config = {
            'pool': self.pool.name,
            'size': size,
            'internal': False,
            'save_on_stop': True,
            'rw': True,
        }
        testvol = self.vm1.storage.init_volume('testvol', volume_config)
        self.vm1.storage.get_pool(testvol).create(testvol)
        self.app.save()
        self.vm1.start()
        p = self.vm1.run(
            'head -c {} /dev/zero 2>&1 | diff -q /dev/xvde - 2>&1'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertEqual(p.returncode, 0,
            'non-volatile image not clean: {}'.format(stdout))
        self.vm1.run('echo test123 > /dev/xvde', user='root', wait=True)
        self.vm1.shutdown(wait=True)
        self.vm1.start()
        p = self.vm1.run(
            'head -c {} /dev/zero 2>&1 | diff -q /dev/xvde - 2>&1'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertNotEqual(p.returncode, 0,
            'non-volatile image volatile: {}'.format(stdout))

    def test_002_read_only(self):
        '''Test read-only volume'''
        size = 32 * 1024 * 1024
        volume_config = {
            'pool': self.pool.name,
            'size': size,
            'internal': False,
            'save_on_stop': True,
            'rw': False,
        }
        testvol = self.vm1.storage.init_volume('testvol', volume_config)
        self.vm1.storage.get_pool(testvol).create(testvol)
        self.app.save()
        self.vm1.start()
        p = self.vm1.run(
            'head -c {} /dev/zero 2>&1 | diff -q /dev/xvde - 2>&1'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertEqual(p.returncode, 0,
            'non-volatile image not clean: {}'.format(stdout))
        p = self.vm1.run('echo test123 > /dev/xvde', user='root',
            passio_popen=True)
        p.wait()
        self.assertNotEqual(p.returncode, 0,
            'Write to read-only volume unexpectedly succeeded')
        p = self.vm1.run(
            'head -c {} /dev/zero 2>&1 | diff -q /dev/xvde - 2>&1'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertEqual(p.returncode, 0,
            'read-only volume modified: {}'.format(stdout))

    def test_003_snapshot(self):
        '''Test snapshot volume data propagation'''
        size = 128 * 1024 * 1024
        volume_config = {
            'pool': self.pool.name,
            'size': size,
            'internal': False,
            'save_on_stop': True,
            'rw': True,
        }
        testvol = self.vm1.storage.init_volume('testvol', volume_config)
        self.vm1.storage.get_pool(testvol).create(testvol)
        volume_config = {
            'pool': self.pool.name,
            'size': size,
            'internal': False,
            'snap_on_start': True,
            'source': testvol.vid,
            'rw': True,
        }
        testvol_snap = self.vm2.storage.init_volume('testvol', volume_config)
        self.vm2.storage.get_pool(testvol_snap).create(testvol_snap)
        self.app.save()
        self.vm1.start()
        self.vm2.start()
        p = self.vm1.run(
            'head -c {} /dev/zero 2>&1 | diff -q /dev/xvde - 2>&1'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertEqual(p.returncode, 0,
            'origin image not clean: {}'.format(stdout))

        p = self.vm2.run(
            'head -c {} /dev/zero | diff -q /dev/xvde -'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertEqual(p.returncode, 0,
            'snapshot image not clean: {}'.format(stdout))

        self.vm1.run('echo test123 > /dev/xvde && sync', user='root', wait=True)
        p.wait()
        self.assertEqual(p.returncode, 0,
            'Write to read-write volume failed')
        p = self.vm2.run(
            'head -c {} /dev/zero 2>&1 | diff -q /dev/xvde - 2>&1'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertEqual(p.returncode, 0,
            'origin changes propagated to snapshot too early: {}'.format(
                stdout))
        self.vm1.shutdown(wait=True)
        # after origin shutdown there should be still no change
        p = self.vm2.run(
            'head -c {} /dev/zero 2>&1 | diff -q /dev/xvde - 2>&1'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertEqual(p.returncode, 0,
            'origin changes propagated to snapshot too early2: {}'.format(
                stdout))

        self.vm2.shutdown(wait=True)
        self.vm2.start()
        # only after target VM restart changes should be visible
        p = self.vm2.run(
            'head -c {} /dev/zero 2>&1 | diff -q /dev/xvde - 2>&1'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertNotEqual(p.returncode, 0,
            'origin changes not visible in snapshot: {}'.format(stdout))

    def test_004_snapshot_non_persistent(self):
        '''Test snapshot volume non-persistence'''
        size = 128 * 1024 * 1024
        volume_config = {
            'pool': self.pool.name,
            'size': size,
            'internal': False,
            'save_on_stop': True,
            'rw': True,
        }
        testvol = self.vm1.storage.init_volume('testvol', volume_config)
        self.vm1.storage.get_pool(testvol).create(testvol)
        volume_config = {
            'pool': self.pool.name,
            'size': size,
            'internal': False,
            'snap_on_start': True,
            'source': testvol.vid,
            'rw': True,
        }
        testvol_snap = self.vm2.storage.init_volume('testvol', volume_config)
        self.vm2.storage.get_pool(testvol_snap).create(testvol_snap)
        self.app.save()
        self.vm2.start()

        p = self.vm2.run(
            'head -c {} /dev/zero | diff -q /dev/xvde -'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertEqual(p.returncode, 0,
            'snapshot image not clean: {}'.format(stdout))

        self.vm2.run('echo test123 > /dev/xvde && sync', user='root', wait=True)
        p.wait()
        self.assertEqual(p.returncode, 0,
            'Write to read-write snapshot volume failed')
        self.vm2.shutdown(wait=True)
        self.vm2.start()
        p = self.vm2.run(
            'head -c {} /dev/zero 2>&1 | diff -q /dev/xvde - 2>&1'.format(size),
            user='root', passio_popen=True)
        stdout, _ = p.communicate()
        self.assertEqual(p.returncode, 0,
            'changes on snapshot survived VM restart: {}'.format(
                stdout))


class StorageFile(StorageTestMixin, qubes.tests.QubesTestCase):
    def init_pool(self):
        self.dir_path = '/var/tmp/test-pool'
        self.pool = self.app.add_pool(dir_path=self.dir_path,
            name='test-pool', driver='file')
        os.mkdir(os.path.join(self.dir_path, 'appvms', self.vm1.name))
        os.mkdir(os.path.join(self.dir_path, 'appvms', self.vm2.name))

    def tearDown(self):
        self.app.remove_pool('test-pool')
        shutil.rmtree(self.dir_path)
        super(StorageFile, self).tearDown()


@qubes.tests.storage_lvm.skipUnlessLvmPoolExists
class StorageLVM(StorageTestMixin, qubes.tests.QubesTestCase):
    def init_pool(self):
        # check if the default LVM Thin pool qubes_dom0/pool00 exists
        volume_group, thin_pool = \
            qubes.tests.storage_lvm.DEFAULT_LVM_POOL.split('/', 1)
        self.pool = self._find_pool(volume_group, thin_pool)
        if not self.pool:
            self.pool = self.app.add_pool(**qubes.tests.storage_lvm.POOL_CONF)
            self.created_pool = True

    def tearDown(self):
        ''' Remove the default lvm pool if it was created only for this test '''
        if self.created_pool:
            self.app.remove_pool(self.pool.name)
        super(StorageLVM, self).tearDown()

    def _find_pool(self, volume_group, thin_pool):
        ''' Returns the pool matching the specified ``volume_group`` &
            ``thin_pool``, or None.
        '''
        pools = [p for p in self.app.pools
            if issubclass(p.__class__, qubes.storage.lvm.ThinPool)]
        for pool in pools:
            if pool.volume_group == volume_group \
                    and pool.thin_pool == thin_pool:
                return pool
        return None