dx_jobs.py

#!/usr/bin/env python
# Corey Brune - Oct 2016
# Description:
# List jobs on a given engine
#
# Requirements
# pip install docopt delphixpy

# The below doc follows the POSIX compliant standards and allows us to use
# this doc to also define our arguments for the script.
"""List jobs on an engine
Usage:
  dx_jobs.py (--list [--state <name>][--title <name>])
                  [--engine <identifier> | --all]
                  [--debug] [--parallel <n>] [--poll <n>]
                  [--config <path_to_file>] [--logdir <path_to_file>]
  dx_jobs.py -h | --help | -v | --version

List jobs on an engine

Examples:
    dx_jobs.py --list --state failed
    dx_jobs.py --list --title snapsync
    dx_jobs.py --list --state failed --title snapsync


Options:
  --list                    List all jobs on an engine.
  --title <name>            Filter job by title name. Note: The search is case insensitive.
  --state <name>            Filter jobs by state: RUNNING, SUSPENDED, CANCELED, COMPLETED, FAILED
  --engine <type>           Alt Identifier of Delphix engine in dxtools.conf.
  --all                     Run against all engines.
  --debug                   Enable debug logging
  --parallel <n>            Limit number of jobs to maxjob
  --poll <n>                The number of seconds to wait between job polls
                            [default: 10]
  --config <path_to_file>   The path to the dxtools.conf file
                            [default: ./dxtools.conf]
  --logdir <path_to_file>    The path to the logfile you want to use.
                            [default: ./dx_operations_vdb.log]
  -h --help                 Show this screen.
  -v --version              Show version.
"""
from __future__ import print_function

import re
import sys
from os.path import basename
from time import sleep
from time import time

from docopt import docopt

from delphixpy.v1_8_0.exceptions import HttpError
from delphixpy.v1_8_0.exceptions import JobError
from delphixpy.v1_8_0.exceptions import RequestError
from delphixpy.v1_8_0.web import job
from lib.DlpxException import DlpxException
from lib.DxLogging import logging_est
from lib.DxLogging import print_debug
from lib.DxLogging import print_exception
from lib.DxLogging import print_info
from lib.GetSession import GetSession

VERSION = "v.0.0.002"


def list_jobs():

    if arguments["--state"]:
        if re.match(
            "RUNNING|SUSPENDED|CANCELED|COMPLETED|FAILED", arguments["--state"].upper()
        ):
            pass
        else:
            print_info(
                "The state should be one of these options:\n"
                "RUNNING, SUSPENDED, CANCELED, COMPLETED, FAILED"
            )
            sys.exit(1)

        for job_info in job.get_all(
            dx_session_obj.server_session, job_state=arguments["--state"].upper()
        ):

            if arguments["--title"]:
                if re.search(arguments["--title"], job_info.title, re.IGNORECASE):
                    print(
                        "Action={}, Job State={}, Parent Action State={},"
                        "Percent Complete={}, Reference={}, Target={},"
                        "Target Name={}, Title={}, User={}\n".format(
                            job_info.action_type,
                            job_info.job_state,
                            job_info.parent_action_state,
                            job_info.percent_complete,
                            job_info.reference,
                            job_info.target,
                            job_info.target_name,
                            job_info.title,
                            job_info.user,
                        )
                    )
            else:
                print(
                    "Action=%s, Job State=%s, Parent Action State=%s,"
                    "Percent Complete=%s, Reference=%s, Target=%s,"
                    "Target Name=%s, Title=%s, User=%s\n"
                    % (
                        job_info.action_type,
                        job_info.job_state,
                        job_info.parent_action_state,
                        job_info.percent_complete,
                        job_info.reference,
                        job_info.target,
                        job_info.target_name,
                        job_info.title,
                        job_info.user,
                    )
                )
    else:
        for job_info in job.get_all(dx_session_obj.server_session):

            if arguments["--title"]:
                if re.search(arguments["--title"], job_info.title, re.IGNORECASE):
                    print(
                        "Action=%s, Job State=%s, Parent Action State=%s,"
                        "Percent Complete=%s, Reference=%s, Target=%s,"
                        "Target Name=%s, Title=%s, User=%s\n"
                        % (
                            job_info.action_type,
                            job_info.job_state,
                            job_info.parent_action_state,
                            job_info.percent_complete,
                            job_info.reference,
                            job_info.target,
                            job_info.target_name,
                            job_info.title,
                            job_info.user,
                        )
                    )
            else:
                print(
                    "Action=%s, Job State=%s, Parent Action State=%s,"
                    "Percent Complete=%s, Reference=%s, Target=%s,"
                    "Target Name=%s, Title=%s, User=%s\n"
                    % (
                        job_info.action_type,
                        job_info.job_state,
                        job_info.parent_action_state,
                        job_info.percent_complete,
                        job_info.reference,
                        job_info.target,
                        job_info.target_name,
                        job_info.title,
                        job_info.user,
                    )
                )


def run_async(func):
    """
    http://code.activestate.com/recipes/576684-simple-threading-decorator/
    run_async(func)
        function decorator, intended to make "func" run in a separate
        thread (asynchronously).
        Returns the created Thread object
        E.g.:
        @run_async
        def task1():
            do_something
        @run_async
        def task2():
            do_something_too
        t1 = task1()
        t2 = task2()
        ...
        t1.join()
        t2.join()
    """
    from threading import Thread
    from functools import wraps

    @wraps(func)
    def async_func(*args, **kwargs):
        func_hl = Thread(target=func, args=args, kwargs=kwargs)
        func_hl.start()
        return func_hl

    return async_func


@run_async
def main_workflow(engine):
    """
    This function actually runs the jobs.
    Use the @run_async decorator to run this function asynchronously.
    This allows us to run against multiple Delphix Engine simultaneously

    engine: Dictionary of engines
    """
    jobs = {}

    try:
        # Setup the connection to the Delphix Engine
        dx_session_obj.serversess(
            engine["ip_address"], engine["username"], engine["password"]
        )

    except DlpxException as e:
        print_exception(
            "\nERROR: Engine {} encountered an error while"
            "{}:\n{}\n".format(engine["hostname"], arguments["--target"], e)
        )
        sys.exit(1)

    thingstodo = ["thingtodo"]
    with dx_session_obj.job_mode(single_thread):
        while len(dx_session_obj.jobs) > 0 or len(thingstodo) > 0:
            if len(thingstodo) > 0:

                if arguments["--list"]:
                    list_jobs()
                thingstodo.pop()

            # get all the jobs, then inspect them
            i = 0
            for j in dx_session_obj.jobs.keys():
                job_obj = job.get(dx_session_obj.server_session, dx_session_obj.jobs[j])
                print_debug(job_obj)
                print_info(
                    "{}: Operations: {}".format(engine["hostname"], job_obj.job_state)
                )
                if job_obj.job_state in ["CANCELED", "COMPLETED", "FAILED"]:
                    # If the job is in a non-running state, remove it from the
                    # running jobs list.
                    del dx_session_obj.jobs[j]
                elif job_obj.job_state in "RUNNING":
                    # If the job is in a running state, increment the running
                    # job count.
                    i += 1

                print_info("{}: {:d} jobs running.".format(engine["hostname"], i))

            # If we have running jobs, pause before repeating the checks.
            if len(dx_session_obj.jobs) > 0:
                sleep(float(arguments["--poll"]))


def run_job():
    """
    This function runs the main_workflow aynchronously against all the servers
    specified
    """
    # Create an empty list to store threads we create.
    threads = []

    # If the --all argument was given, run against every engine in dxtools.conf
    if arguments["--all"]:
        print_info("Executing against all Delphix Engines in the dxtools.conf")

        try:
            # For each server in the dxtools.conf...
            for delphix_engine in dx_session_obj.dlpx_engines:
                engine = dx_session_obj[delphix_engine]
                # Create a new thread and add it to the list.
                threads.append(main_workflow(engine))

        except DlpxException as e:
            print("Error encountered in run_job():\n{}".format(e))
            sys.exit(1)

    elif arguments["--all"] is False:
        # Else if the --engine argument was given, test to see if the engine
        # exists in dxtools.conf
        if arguments["--engine"]:
            try:
                engine = dx_session_obj.dlpx_engines[arguments["--engine"]]
                print_info(
                    "Executing against Delphix Engine: %s\n" % (arguments["--engine"])
                )

            except (DlpxException, RequestError, KeyError) as e:
                raise DlpxException(
                    "\nERROR: Delphix Engine %s cannot be "
                    "found in %s. Please check your value "
                    "and try again. Exiting.\n"
                    % (arguments["--engine"], config_file_path)
                )

        else:
            # Else search for a default engine in the dxtools.conf
            for delphix_engine in dx_session_obj.dlpx_engines:
                if dx_session_obj.dlpx_engines[delphix_engine]["default"] == "true":

                    engine = dx_session_obj.dlpx_engines[delphix_engine]
                    print_info(
                        "Executing against the default Delphix Engine "
                        "in the dxtools.conf: %s"
                        % (dx_session_obj.dlpx_engines[delphix_engine]["hostname"])
                    )

                break

            if engine == None:
                raise DlpxException("\nERROR: No default engine found. Exiting")

    # run the job against the engine
    threads.append(main_workflow(engine))

    # For each thread in the list...
    for each in threads:
        # join them back together so that we wait for all threads to complete
        # before moving on
        each.join()


def time_elapsed():
    """
    This function calculates the time elapsed since the beginning of the script.
    Call this anywhere you want to note the progress in terms of time
    """
    elapsed_minutes = round((time() - time_start) / 60, +1)
    return elapsed_minutes


def main(argv):
    # We want to be able to call on these variables anywhere in the script.
    global single_thread
    global usebackup
    global time_start
    global config_file_path
    global database_name
    global dx_session_obj
    global debug

    if arguments["--debug"]:
        debug = True

    try:
        dx_session_obj = GetSession()
        logging_est(arguments["--logdir"])
        print_debug(arguments)
        time_start = time()
        engine = None
        single_thread = False
        config_file_path = arguments["--config"]
        # Parse the dxtools.conf and put it into a dictionary
        dx_session_obj.get_config(config_file_path)

        # This is the function that will handle processing main_workflow for
        # all the servers.
        run_job()

        elapsed_minutes = time_elapsed()
        print_info("script took " + str(elapsed_minutes) + " minutes to get this far.")

    # Here we handle what we do when the unexpected happens
    except SystemExit as e:
        """
        This is what we use to handle our sys.exit(#)
        """
        sys.exit(e)

    except HttpError as e:
        """
        We use this exception handler when our connection to Delphix fails
        """
        print_exception(
            "Connection failed to the Delphix Engine"
            "Please check the ERROR message below"
        )
        sys.exit(1)

    except JobError as e:
        """
        We use this exception handler when a job fails in Delphix so that
        we have actionable data
        """
        elapsed_minutes = time_elapsed()
        print_exception("A job failed in the Delphix Engine")
        print_info(
            "%s took %s minutes to get this far\n"
            % (basename(__file__), str(elapsed_minutes))
        )
        sys.exit(3)

    except KeyboardInterrupt:
        """
        We use this exception handler to gracefully handle ctrl+c exits
        """
        print_debug("You sent a CTRL+C to interrupt the process")
        elapsed_minutes = time_elapsed()
        print_info(
            "%s took %s minutes to get this far\n"
            % (basename(__file__), str(elapsed_minutes))
        )

    except:
        """
        Everything else gets caught here
        """
        print_exception(sys.exc_info()[0])
        elapsed_minutes = time_elapsed()
        print_info(
            "%s took %s minutes to get this far\n"
            % (basename(__file__), str(elapsed_minutes))
        )
        sys.exit(1)


if __name__ == "__main__":
    # Grab our arguments from the doc at the top of the script
    arguments = docopt(__doc__, version=basename(__file__) + " " + VERSION)
    # Feed our arguments to the main function, and off we go!
    main(arguments)