#!/usr/bin/python

# Copyright (c) 2017 Red Hat, Inc. All rights reserved. This copyrighted material

# is made available to anyone wishing to use, modify, copy, or

# redistribute it subject to the terms and conditions of the GNU General

# Public License v.2.

#

# 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, see http://www.gnu.org/licenses/.

#

# Author: Jakub Krysl <jkrysl@redhat.com>

import sys, os

sys.path.append(os.path.abspath("dmpd_library.py"))

from dmpd_library import *

def thin_init(args):

    # Create thin pool with LVs

    print("INFO: Initializing test case")

    errors = []

    atomic_run("Creating loopdev",

               name=args["loop1"],

               size=args["loop1_size"],

               command=loopdev.create_loopdev,

               errors=errors)

    atomic_run("Creating VG",

               vg_name=args["group"],

               pv_name="/dev/" + args["loop1"],

               command=lvm.vg_create,

               errors=errors)

    atomic_run("Creating thin pool",

               vg_name=args["group"],

               lv_name=args["pool"],

               options=["-T", "-L 500"],

               command=lvm.lv_create,

               errors=errors)

    # create few LVs to increase transaction ID and be able to do thin_delta

    for i in range(args["number of vols"]):

        atomic_run("Creating thin LV No. %s" % i,

                   vg_name=args["group"] + "/" + args["pool"],

                   lv_name=args["vol"] + str(i),

                   options=["-T", "-V 100"],

                   command=lvm.lv_create,

                   errors=errors)

        atomic_run("Creating filesystem on LV No. %s" % i,

                   vg_name=args["group"],

                   lv_name=args["vol"] + str(i),

                   command=create_filesystem,

                   errors=errors)

        atomic_run("Deactivating thin LV No. %s" % i,

                   lv_name=args["vol"] + str(i),

                   vg_name=args["group"],

                   command=lvm.lv_deactivate,

                   errors=errors)

    atomic_run("Creating metadata snapshot",

               lv_name=args["pool"],

               vg_name=args["group"],

               command=metadata_snapshot,

               errors=errors)

    atomic_run("Deactivating pool",

               lv_name=args["pool"],

               vg_name=args["group"],

               command=lvm.lv_deactivate,

               errors=errors)

    atomic_run("Creating swap LV",

               vg_name=args["group"],

               lv_name=args["swap"],

               options=["-L 100"],

               command=lvm.lv_create,

               errors=errors)

    atomic_run("Deactivating swap",

               lv_name=args["swap"],

               vg_name=args["group"],

               command=lvm.lv_deactivate,

               errors=errors)

    atomic_run("Swapping metadata",

               vg_name=args["group"],

               lv_name=args["swap"],

               options=["-y", "--thinpool " + args["group"] + "/" + args["pool"],

                        "--poolmetadata "],

               command=lvm.lv_convert,

               errors=errors)

    atomic_run("Activating swap",

               lv_name=args["swap"],

               vg_name=args["group"],

               command=lvm.lv_activate,

               errors=errors)

    if len(errors) == 0:

        TC.tpass("Initialization passed")

    else:

        TC.tfail("Initialization failed with following errors: \n\t'" +

                 "\n\t ".join([str(i) for i in errors]))

        return 1

    return 0

def thin_clean(args):

    print("INFO: Cleaning up")

    errors = []

    # restoring metadata device in case it is corrupted

    atomic_run("Repairing metadata device",

               source_file="/tmp/metadata",

               target_vg=args["group"],

               target_lv=args["swap"],

               quiet=True,

               command=dmpd.thin_restore,

               errors=errors)

    # thinpool got activated after checking its metadata to get bad checksum

    atomic_run("Deactivating pool",

               lv_name=args["pool"],

               vg_name=args["group"],

               command=lvm.lv_deactivate,

               errors=errors)

    atomic_run("Deactivating swap",

               lv_name=args["swap"],

               vg_name=args["group"],

               command=lvm.lv_deactivate,

               errors=errors)

    atomic_run("Swapping back metadata",

               vg_name=args["group"],

               lv_name=args["swap"],

               options=["-y", "--thinpool " + args["group"] + "/" + args["pool"],

                        "--poolmetadata "],

               command=lvm.lv_convert,

               errors=errors)

    atomic_run("Removing swap",

               lv_name=args["swap"],

               vg_name=args["group"],

               command=lvm.lv_remove,

               errors=errors)

    atomic_run("Removing thinpool",

               lv_name=args["pool"],

               vg_name=args["group"],

               command=lvm.lv_remove,

               errors=errors)

    atomic_run("Removing VG",

               vg_name=args["group"],

               force=True,

               command=lvm.vg_remove,

               errors=errors)

    atomic_run("Deleting loopdev",

               name=args["loop1"],

               command=loopdev.delete_loopdev,

               errors=errors)

    atomic_run("Deleting metadata file",

               cmd="rm -f /tmp/metadata",

               command=run,

               errors=errors)

    atomic_run("Deleting repair metadata file",

               cmd="rm -f /tmp/metadata_repair",

               command=run,

               errors=errors)

    atomic_run("Deleting snapshot metadata file",

               cmd="rm -f /tmp/metadata_snap",

               command=run,

               errors=errors)

    if len(errors) == 0:

        TC.tpass("Cleanup passed")

    else:

        TC.tfail("Cleanup failed with following errors: \n\t'" +

                 "\n\t ".join([str(i) for i in errors]))

        print(errors)

        return 1

    return 0

def thin_test(args):

    print("\n#######################################\n")

    print (

        "INFO: Testing thin tools runtime provided by device_mapper_persistent_data")

    errors = []

    atomic_run("Checking metadata",

               source_vg=args["group"],

               source_lv=args["swap"],

               command=dmpd.thin_check,

               errors=errors)

    atomic_run("Checking metadata with few paramethers",

               source_vg=args["group"],

               source_lv=args["swap"],

               super_block_only=True,

               skip_mappings=True,

               ignore_non_fatal_errors=True,

               command=dmpd.thin_check,

               errors=errors)

    atomic_run("Listing information about thin LVs",

               source_vg=args["group"],

               source_lv=args["swap"],

               command=dmpd.thin_ls,

               errors=errors)

    atomic_run("Listing information about thin LVs without headers",

               source_vg=args["group"],

               source_lv=args["swap"],

               no_headers=True,

               command=dmpd.thin_ls,

               errors=errors)

    # Not yet in Fedora 26, shoud be in F27

    #atomic_run("Dumping metadata to standard output without mappings",

    #           formatting="human_readable",

    #           source_vg=args["group"],

    #           source_lv=args["swap"],

    #           skip_mappings=True,

    #           command=dmpd.thin_dump,

    #           errors=errors)

    atomic_run("Dumping metadata to standard output",

               formatting="human_readable",

               source_vg=args["group"],

               source_lv=args["swap"],

               command=dmpd.thin_dump,

               errors=errors)

    atomic_run("Dumping metadata to standard output from snapshot",

               formatting="human_readable",

               source_vg=args["group"],

               source_lv=args["swap"],

               snapshot=True,

               command=dmpd.thin_dump,

               errors=errors)

    # Not yet in Fedora 26, shoud be in F27

    #atomic_run("Dumping metadata with dev-id",

    #           formatting="human_readable",

    #           source_vg=args["group"],

    #           source_lv=args["swap"],

    #           dev_id=args["number of vols"] - 1,

    #           command=dmpd.thin_dump,

    #           errors=errors)

    atomic_run("Calculating metadata size for pool of 64k blocks and 100M size",

               cmd="thin_metadata_size -b64k -s100m -m1 -um",

               command=run,

               errors=errors)

    atomic_run("Calculating metadata size for pool of 64k blocks and 100M size",

               cmd="thin_metadata_size -b64k -s100m -m1 -um -n",

               command=run,

               errors=errors)

    atomic_run("Calculating metadata size for pool of 64k blocks and 100M size",

               cmd="thin_metadata_size -b64k -s100m -m1 -um -nlong",

               command=run,

               errors=errors)

    atomic_run("Calculating metadata size for pool of 64k blocks and 100M size",

               cmd="thin_metadata_size -b64k -s100m -m1 -um -nshort",

               command=run,

               errors=errors)

    atomic_run("Outputting reverse map of metadata device",

               source_vg=args["group"],

               source_lv=args["swap"],

               region="0..-1",

               command=dmpd.thin_rmap,

               errors=errors)

    # this fails now and it should not

    # atomic_run("Discarding free space of pool",

    #           target_vg=args["group"],

    #           target_lv=args["swap"],

    #           command=dmpd.thin_trim,

    #           errors=errors)

    atomic_run("Dumping metadata to file",

               formatting="xml",

               source_vg=args["group"],

               source_lv=args["swap"],

               repair=True,

               output="/tmp/metadata",

               command=dmpd.thin_dump,

               errors=errors)

    atomic_run("Dumping metadata to file from snapshot",

               formatting="xml",

               source_vg=args["group"],

               source_lv=args["swap"],

               snapshot=True,

               output="/tmp/metadata_snap",

               command=dmpd.thin_dump,

               errors=errors)

    atomic_run("Getting differences between thin LVs",

               source_vg=args["group"],

               source_lv=args["swap"],

               thin1=1,

               thin2=args["number of vols"] - 1,

               snapshot=True,

               command=dmpd.thin_delta,

               errors=errors)

    atomic_run("Getting differences between thin LVs with --verbose",

               source_vg=args["group"],

               source_lv=args["swap"],

               thin1=1,

               thin2=args["number of vols"] - 1,

               verbosity=True,

               snapshot=True,

               command=dmpd.thin_delta,

               errors=errors)

    atomic_run("Getting differences between the same LV",

               source_vg=args["group"],

               source_lv=args["swap"],

               thin1=1,

               thin2=1,

               snapshot=True,

               command=dmpd.thin_delta,

               errors=errors)

    atomic_run("Getting differences between the same LV with --verbose",

               source_vg=args["group"],

               source_lv=args["swap"],

               thin1=1,

               thin2=1,

               verbosity=True,

               snapshot=True,

               command=dmpd.thin_delta,

               errors=errors)

    atomic_run("Listing metadata output from snapshot",

               source_vg=args["group"],

               source_lv=args["swap"],

               snapshot=True,

               command=dmpd.thin_ls,

               errors=errors)

    # Need to run everything on snapshot before this as thin_restore removes the metadata snapshot

    # This should work but is not working due to a bug

    #atomic_run("Restoring metadata",

    #           source_file="/tmp/metadata_snap",

    #           target_vg=args["group"],

    #           target_lv=args["swap"],

    #           command=dmpd.thin_restore,

    #           errors=errors)

    atomic_run("Restoring metadata",

               source_file="/tmp/metadata",

               target_vg=args["group"],

               target_lv=args["swap"],

               command=dmpd.thin_restore,

               errors=errors)

    #   Repairing from non-binary file leads to segmentation fault

    #atomic_run("Repairing metadata from file",

    #            source_file="/tmp/metadata",

    #            target_vg=args["group"],

    #            target_lv=args["swap"],

    #            command=dmpd.thin_repair,

    #            errors=errors)

    atomic_run("Repairing metadata to file",

               target_file="/tmp/metadata_repair",

               source_vg=args["group"],

               source_lv=args["swap"],

               command=dmpd.thin_repair,

               errors=errors)

    atomic_run("Repairing metadata from file",

               source_file="/tmp/metadata_repair",

               target_vg=args["group"],

               target_lv=args["swap"],

               command=dmpd.thin_repair,

               errors=errors)

    atomic_run("Checking metadata",

               source_vg=args["group"],

               source_lv=args["swap"],

               command=dmpd.thin_check,

               errors=errors)

    print("\n#######################################\n")

    if len(errors) == 0:

        TC.tpass("Testing thin tools of device_mapper_persistent_data passed")

    else:

        TC.tfail("Testing thin tools of device_mapper_persistent_data failed with following errors: \n\t'" +

                 "\n\t ".join([str(i) for i in errors]))

        return 1

    return 0

def thin_errors_test(args):

    print("\n#######################################\n")

    print (

        "INFO: Testing thin tools errors provided by device_mapper_persistent_data")

    errors = []

    # "thin_show_duplicates" does not work yet

    functions = ["thin_check", "thin_delta", "thin_dump", "thin_ls", "thin_metadata_size", "thin_repair",

                 "thin_restore", "thin_rmap", "thin_trim"]

    # Sanity to check for missing input

    for func in functions:

        atomic_run("Validating missing input",

                   False,

                   cmd=func,

                   command=run,

                   errors=errors)

    # Sanity to check with wrong input

    for func in functions:

        atomic_run("Validating wrong input",

                   False,

                   cmd=func + " wrong",

                   command=run,

                   errors=errors)

    # Sanity to check with wrong option

    for func in functions:

        atomic_run("Validating wrong option",

                   False,

                   cmd=func + " -wrong",

                   command=run,

                   errors=errors)

    # Sanity to check present functions with -h

    for func in functions:

        atomic_run("Checking help of command",

                   cmd=func,

                   command=dmpd.get_help,

                   errors=errors)

    # Sanity to check present functions with -V

    for func in functions:

        # thin_metadata_size has wrong return value

        if func == "thin_metadata_size":

            continue

        atomic_run("Checking version of command",

                   cmd=func,

                   command=dmpd.get_version,

                   errors=errors)

    atomic_run("Checking original pool metadata, should fail",

               False,

               source_vg=args["group"],

               source_lv=args["pool"],

               command=dmpd.thin_check,

               errors=errors)

    atomic_run("Listing information about thin LVs",

               False,

               cmd="thin_ls /dev/mapper/%s-%s --format \"WRONG\"" % (args["group"], args["swap"]),

               command=run,

               errors=errors)

    atomic_run("Checking thin_metadata_size inputs",

               False,

               cmd="thin_metadata_size -b 64",

               command=run,

               errors=errors)

    atomic_run("Checking thin_metadata_size inputs",

               False,

               cmd="thin_metadata_size -b 64 -s 128",

               command=run,

               errors=errors)

    atomic_run("Checking thin_metadata_size inputs",

               False,

               cmd="thin_metadata_size -b 25 -s 128 -m 10",

               command=run,

               errors=errors)

    atomic_run("Checking thin_metadata_size inputs",

               False,

               cmd="thin_metadata_size -b 128 -s 64 -m 10",

               command=run,

               errors=errors)

    atomic_run("Checking thin_metadata_size inputs",

               False,

               cmd="thin_metadata_size -u h",

               command=run,

               errors=errors)

    atomic_run("Checking thin_metadata_size inputs",

               False,

               cmd="thin_metadata_size -n -n",

               command=run,

               errors=errors)

    atomic_run("Checking thin_metadata_size inputs",

               False,

               cmd="thin_metadata_size -nlongshort",

               command=run,

               errors=errors)

    atomic_run("Checking thin_metadata_size inputs",

               False,

               cmd="thin_metadata_size -b 128 -b 64",

               command=run,

               errors=errors)

    atomic_run("Repairing metadata without output",

               False,

               cmd="thin_repair -i /tmp/metadata_repair",

               command=run,

               errors=errors)

    atomic_run("Dumping metadata with wrong custom format",

               False,

               cmd="thin_dump /dev/mapper/%s-%s --format custom=wrong" % (args["group"], args["swap"]),

               command=run,

               errors=errors)

    atomic_run("Dumping metadata with unknown format",

               False,

               cmd="thin_dump /dev/mapper/%s-%s --format wrong" % (args["group"], args["swap"]),

               command=run,

               errors=errors)

    atomic_run("Dumping metadata with wrong dev-id",

               False,

               cmd="thin_dump /dev/mapper/%s-%s --dev-id wrong" % (args["group"], args["swap"]),

               command=run,

               errors=errors)

    atomic_run("Repairing metadata to produce 'output file does not exist' error",

               False,

               cmd="thin_repair -i /dev/mapper/%s-%s -o /tmp/wrong.wrong" %

                   (args['group'], args['swap']),

               command=run,

               errors=errors)

    atomic_run("Repairing metadata to produce 'output file too small' error",

               False,

               cmd="thin_repair -i /tmp/metadata -o /tmp/metadata",

               command=run,

               errors=errors)

    # This does not fail now due to a bug

    #atomic_run("Outputting reverse map of metadata device, should fail without region",

    #           cmd="thin_rmap /dev/mapper/%s-%s" % (args["group"], args["swap"]),

    #           command=run,

    #           errors=errors)

    atomic_run("Outputting reverse map of metadata device with wrong region",

               False,

               cmd="thin_rmap /dev/mapper/%s-%s --region 0..0" % (args["group"], args["swap"]),

               command=run,

               errors=errors)

    atomic_run("Outputting reverse map of metadata device with wrong region",

               False,

               cmd="thin_rmap /dev/mapper/%s-%s --region 0...1" % (args["group"], args["swap"]),

               command=run,

               errors=errors)

    atomic_run("Outputting reverse map of metadata device with wrong region",

               False,

               cmd="thin_rmap /dev/mapper/%s-%s --region 00" % (args["group"], args["swap"]),

               command=run,

               errors=errors)

    atomic_run("Outputting reverse map of metadata device with wrong device",

               False,

               cmd="thin_rmap --region 0..-1 /tmp/wrong.wrong",

               command=run,

               errors=errors)

    #   Reverse mapping from bad file leads to segmentation fault

    #atomic_run("Outputting reverse map of metadata device with wrong device",

    #            False,

    #            cmd="thin_rmap --region 0..-1 /tmp/metadata",

    #            command=run,

    #            errors=errors)

    atomic_run("Getting differences with thin1 ID out of range",

               False,

               source_vg=args["group"],

               source_lv=args["swap"],

               thin1=-1,

               thin2=args["number of vols"] - 1,

               command=dmpd.thin_delta,

               errors=errors)

    atomic_run("Getting differences with thin2 ID out of range",

               False,

               source_vg=args["group"],

               source_lv=args["swap"],

               thin1=1,

               thin2=args["number of vols"] + 1,

               command=dmpd.thin_delta,

               errors=errors)

    atomic_run("Restoring metadata without output",

               False,

               cmd="thin_restore -i /tmp/metadata",

               command=run,

               errors=errors)

    atomic_run("Restoring metadata with wrong options",

               False,

               cmd="thin_restore -i /tmp/metadata -o /dev/mapper/%s-%s --wrong test" % (args["group"], args["swap"]),

               command=run,

               errors=errors)

    atomic_run("Restoring metadata with wrong source",

               False,

               cmd="thin_restore -i /tmp/wrong.wrong -o /dev/mapper/%s-%s" % (args["group"], args["swap"]),

               command=run,

               errors=errors)

    atomic_run("Getting differences without thin2",

               False,

               cmd="thin_delta --thin1 1 /dev/mapper/%s-%s" %

                   (args["group"], args["swap"]),

               command=run,

               errors=errors)

    atomic_run("Corrupting metadata on device",

               cmd="echo 'nothing' >> /dev/mapper/%s-%s" %

                   (args['group'], args['swap']),

               command=run,

               errors=errors)

    atomic_run("Trying to fail while repairing metadata",

               False,

               source_vg=args['group'],

               source_lv=args['swap'],

               target_file="/tmp/metadata_repair",

               command=dmpd.thin_repair,

               errors=errors)

    atomic_run("Trying to fail listing volumes",

               False,

               source_vg=args['group'],

               source_lv=args['swap'],

               command=dmpd.thin_ls,

               errors=errors)

    atomic_run("Trying to fail while checking metadata",

               False,

               source_vg=args["group"],

               source_lv=args["swap"],

               command=dmpd.thin_check,

               errors=errors)

    atomic_run("Trying to fail while dumping metadata from snapshot",

               False,

               formatting="human_readable",

               source_vg=args["group"],

               source_lv=args["swap"],

               snapshot=True,

               command=dmpd.thin_dump,

               errors=errors)

    # restoring metadata device after corrupting it

    atomic_run("Repairing metadata device",

               source_file="/tmp/metadata",

               target_vg=args["group"],

               target_lv=args["swap"],

               quiet=True,

               command=dmpd.thin_restore,

               errors=errors)

    print("\n#######################################\n")

    if len(errors) == 0:

        TC.tpass("Testing thin tools errors of device_mapper_persistent_data passed")

    else:

        TC.tfail("Testing thin tools errors of device_mapper_persistent_data failed with following errors: \n\t'" +

                 "\n\t ".join([str(i) for i in errors]))

        return 1

    return 0

def cache_init(args):

    print("INFO: Initializing test case")

    errors = []

    atomic_run("Creating loopdev 1 - 'fast' device",

               name=args["loop1"],

               size=args["loop1_size"],

               command=loopdev.create_loopdev,

               errors=errors)

    atomic_run("Creating loopdev 2 - 'slow' device",

               name=args["loop2"],

               size=args["loop2_size"],

               command=loopdev.create_loopdev,

               errors=errors)