Alfred.py

# -*- coding: utf-8 -*-
#
#   This Source Code Form is subject to the terms of the Mozilla Public
#   License, v. 2.0. If a copy of the MPL was not distributed with this
#   file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
#   Created on Thu Feb 15 11:10:10 2018
#
#   @author: rhamilton

from __future__ import division, print_function, absolute_import

import os
import sys
import time

from ligmos.utils import classes, common, confparsers
from ligmos.workers import connSetup, workerSetup

from dataservants import alfred
# from dataservants import yvette


def defineActions():
    """
    """
    # Renaming import to keep line length sensible
    # yvetteR = yvette.remote
    alfredT = alfred.tasks

    # Set up the desired actions using a helpful class to pass things
    #   to each function/process more clearly.
    #
    #   Note that we need to also update things per-instrument when
    #   inside the main loop via updateArguments()...it's just helpful to
    #   do the definitions out here for the constants and for clarity.
    act1 = common.processDescription(func=alfredT.actionPing,
                                     name='CheckPing',
                                     timedelay=3.,
                                     maxtime=120,
                                     needSSH=False,
                                     args=[],
                                     kwargs={})

    # act2 = common.processDescription(func=yvetteR.actionSpace,
    #                                  name='CheckFreeSpace',
    #                                  timedelay=3.,
    #                                  maxtime=120,
    #                                  needSSH=True,
    #                                  args=[],
    #                                  kwargs={})

    # act3 = common.processDescription(func=yvetteR.actionStats,
    #                                  name='CheckStats',
    #                                  timedelay=3.,
    #                                  maxtime=120,
    #                                  needSSH=True,
    #                                  args=[],
    #                                  kwargs={})

    # act4 = common.processDescription(func=yvetteR.actionProcess,
    #                                  name='CheckProcess',
    #                                  timedelay=3.,
    #                                  maxtime=120,
    #                                  needSSH=True,
    #                                  args=[],
    #                                  kwargs={})

    # actions = [act1, act2, act3, act4]
    actions = [act1]

    return actions


def updateArguments(actions, iobj, args, baseYcmd, db=None):
    """
    """
    # Update the functions with proper arguments.
    #   (opened SSH connection is added just before calling)
    # act1 == pings
    actions[0].args = [iobj]
    actions[0].kwargs = {'db': db,
                         'debug': args.debug}

    # # act2 == check free space
    # actions[1].args = [baseYcmd, iobj]
    # actions[1].kwargs = {'db': db,
    #                      'debug': args.debug}

    # # act3 == check target CPU/RAM stats
    # actions[2].args = [baseYcmd, iobj]
    # actions[2].kwargs = {'db': db,
    #                      'debug': args.debug}

    # # act4 == Check on process health
    # actions[3].args = [baseYcmd, iobj]
    # actions[3].kwargs = {'db': db,
    #                      'procName': iobj.procmon,
    #                      'debug': args.debug}

    return actions


def main():
    """
    """
    # Define the default files we'll use/look for. These are passed to
    #   the worker constructor (toServeMan).
    conf = './config/alfred.conf'
    passes = './config/passwords.conf'
    logfile = '/tmp/alfred.log'
    desc = 'Alfred: The Instrument Monitor'
    eargs = alfred.parseargs.extraArguments
    conftype = classes.hostTarget

    # Note: We need to prepend the PATH setting here because some hosts
    #   (all recent OSes, really) have a more stringent SSHd config
    #   that disallows the setting of random environment variables
    #   at login, and I can't figure out the goddamn pty shell settings
    #   for Ubuntu (Vishnu) and OS X (xcam)
    #
    # Also need to make sure to use the relative path (~/) since OS X
    #   puts stuff in /Users/<username> rather than /home/<username>
    #   Messy but necessary due to how I'm doing SSH
    baseYcmd = 'export PATH="~/miniconda3/bin:$PATH";'
    baseYcmd += 'python ~/LIG/DataServants/Yvette.py'
    baseYcmd += ' '

    # Interval between successive runs of the instrument polling (seconds)
    bigsleep = 60

    # Total time for entire set of actions per instrument
    alarmtime = 300

    # config: dictionary of parsed config file
    # comm: common block from config file
    # args: parsed options
    # runner: class that contains logic to quit nicely
    config, comm, args, runner = workerSetup.toServeMan(conf,
                                                        passes,
                                                        logfile,
                                                        desc=desc,
                                                        extraargs=eargs,
                                                        conftype=conftype,
                                                        logfile=True)

    # Parse the extra config file, but do it in a bit of a sloppy way
    #   that just fills out the class with whatever else
    #   we find in the file.
    # REMEMBER there are two returns! The second contains any common
    #   items, and is just None if searchCommon is False...but it's
    #   always returned!
    epings, _ = confparsers.parseConfig(args.extraPings, conftype,
                                        passfile=None,
                                        searchCommon=False,
                                        enableCheck=True,
                                        debug=args.debug)

    # Actually define the function calls/references to functions
    actions = defineActions()

    # Get this PID for diagnostics
    pid = os.getpid()

    # Print the preamble of this particular instance
    #   (helpful to find starts/restarts when scanning thru logs)
    common.printPreamble(pid, config)

    # Check to see if there are any connections/objects to establish
    idbs = connSetup.connIDB(comm)

    # Semi-infinite loop
    while runner.halt is False:
        # This is a common core function that handles the actions and
        #   looping over each instrument.  We keep the main while
        #   loop out here, though, so we can do stuff with the
        #   results of the actions from all the instruments.
        _ = common.instLooper(config, runner, args,
                              actions, updateArguments,
                              baseYcmd,
                              db=idbs, alarmtime=alarmtime)

        # Doing the extra pings as a side job/quickie
        #   No need to make this into a big to-do
        if epings is not None:
            for sect in epings:
                pobj = epings[sect]
                dbtag = pobj.database
                db = idbs[dbtag]

                res = alfred.tasks.actionPing(pobj, db=db, debug=args.debug)
                print(res)

        # After all the instruments are done, take a big nap
        if runner.halt is False:
            print("Starting a big sleep")
            # Sleep for bigsleep, but in small chunks to check abort
            for _ in range(bigsleep):
                time.sleep(0.1)
                if runner.halt is True:
                    print("halt requested while sleeping!")
                    print("issuing 'break'")
                    break
        else:
            print("runner.halt has been triggered!")

    # The above loop is exited when someone sends SIGTERM
    print("PID %d is now out of here!" % (pid))

    # Return STDOUT and STDERR to their system defaults
    sys.stdout = sys.__stdout__
    sys.stderr = sys.__stderr__
    print("STDOUT and STDERR reset.")


if __name__ == "__main__":
    main()