#!/bin/sh
#
#
# OpenStack Nova Serial Console (nova-serialproxy)
#
# Description:  Manages an OpenStack Nova Serialproxy (nova-serialproxy) process as an HA resource
#
# Authors:      Sébastien Han
# Mainly inspired by the novnc API resource agent written by Martin Gerhard Loschwitz from Hastexo: http://goo.gl/whLpr
#
# Support:      openstack@lists.launchpad.net
# License:      Apache Software License (ASL) 2.0
#
# Copyright (c) 2018 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
#
# See usage() function below for more details ...
#
# OCF instance parameters:
#   OCF_RESKEY_binary
#   OCF_RESKEY_config
#   OCF_RESKEY_user
#   OCF_RESKEY_pid
#   OCF_RESKEY_console_port
#   OCF_RESKEY_additional_parameters
#######################################################################
# Initialization:

: ${OCF_FUNCTIONS_DIR=${OCF_ROOT}/lib/heartbeat}
. ${OCF_FUNCTIONS_DIR}/ocf-shellfuncs

#######################################################################

# Fill in some defaults if no values are specified

OCF_RESKEY_binary_default="nova-serialproxy"
OCF_RESKEY_config_default="/etc/nova/nova-ironic.conf"
OCF_RESKEY_user_default="nova"
OCF_RESKEY_pid_default="$HA_RSCTMP/$OCF_RESOURCE_INSTANCE.pid"
OCF_RESKEY_console_port_default="6083"

: ${OCF_RESKEY_binary=${OCF_RESKEY_binary_default}}
: ${OCF_RESKEY_config=${OCF_RESKEY_config_default}}
: ${OCF_RESKEY_user=${OCF_RESKEY_user_default}}
: ${OCF_RESKEY_pid=${OCF_RESKEY_pid_default}}
: ${OCF_RESKEY_console_port=${OCF_RESKEY_console_port_default}}

#######################################################################

usage() {
    cat <<UEND
        usage: $0 (start|stop|validate-all|meta-data|status|monitor)

        $0 manages an OpenStack Nova Serial proxy (nova-serialproxy) process as an HA resource 

        The 'start' operation starts the console service.
        The 'stop' operation stops the console service.
        The 'validate-all' operation reports whether the parameters are valid
        The 'meta-data' operation reports this RA's meta-data information
        The 'status' operation reports whether the console service is running
        The 'monitor' operation reports whether the console service seems to be working

UEND
}

meta_data() {
    cat <<END
<?xml version="1.0"?>
<!DOCTYPE resource-agent SYSTEM "ra-api-1.dtd">
<resource-agent name="nova-serialproxy">
<version>1.0</version>

<longdesc lang="en">
Resource agent for the OpenStack Nova Serialproxy Service (nova-serialproxy)
May manage a nova-serialproxy instance or a clone set that 
creates a distributed nova-serialproxy cluster.
</longdesc>
<shortdesc lang="en">Manages the OpenStack Nova Serial Console (nova-serialproxy)</shortdesc>
<parameters>

<parameter name="binary" unique="0" required="0">
<longdesc lang="en">
Location of the OpenStack Nova Serial Console server binary (nova-serialproxy)
</longdesc>
<shortdesc lang="en">OpenStack Nova Serial Console server binary (nova-serialproxy)</shortdesc>
<content type="string" default="${OCF_RESKEY_binary_default}" />
</parameter>

<parameter name="config" unique="0" required="0">
<longdesc lang="en">
Location of the OpenStack Nova Serial Console (nova-serialproxy) configuration file
</longdesc>
<shortdesc lang="en">OpenStack Nova Serial Console (nova-serialproxy registry) config file</shortdesc>
<content type="string" default="${OCF_RESKEY_config_default}" />
</parameter>

<parameter name="user" unique="0" required="0">
<longdesc lang="en">
User running OpenStack Nova Serial proxy (nova-serialproxy)
</longdesc>
<shortdesc lang="en">OpenStack Nova Serialproxy (nova-serialproxy) user</shortdesc>
<content type="string" default="${OCF_RESKEY_user_default}" />
</parameter>

<parameter name="console_port" unique="0" required="0">
<longdesc lang="en">
Serial console type running: nova-serialproxy
</longdesc>
<shortdesc lang="en">OpenStack Nova Serial Console (nova-serialproxy) console type</shortdesc>
<content type="integer" default="${OCF_RESKEY_console_port_default}" />
</parameter>

<parameter name="pid" unique="0" required="0">
<longdesc lang="en">
The pid file to use for this OpenStack Nova Serial Console (nova-serialproxy) instance
</longdesc>
<shortdesc lang="en">OpenStack Nova VNC Console (nova-serialproxy) pid file</shortdesc>
<content type="string" default="${OCF_RESKEY_pid_default}" />
</parameter>

<parameter name="additional_parameters" unique="0" required="0">
<longdesc lang="en">
Additional parameters to pass on to the OpenStack Nova Serialproxy (nova-serialproxy)
</longdesc>
<shortdesc lang="en">Additional parameters for nova-serialproxy</shortdesc>
<content type="string" />
</parameter>

</parameters>

<actions>
<action name="start" timeout="10" />
<action name="stop" timeout="15" />
<action name="status" timeout="10" />
<action name="monitor" timeout="5" interval="10" />
<action name="validate-all" timeout="5" />
<action name="meta-data" timeout="5" />
</actions>
</resource-agent>
END
}

#######################################################################
# Functions invoked by resource manager actions

nova_serial_console_validate() {
    local rc

    check_binary $OCF_RESKEY_binary
    check_binary netstat

    # A config file on shared storage that is not available
    # during probes is OK.
    if [ ! -f $OCF_RESKEY_config ]; then
        if ! ocf_is_probe; then
            ocf_log err "Config $OCF_RESKEY_config doesn't exist"
            return $OCF_ERR_INSTALLED
        fi
        ocf_log_warn "Config $OCF_RESKEY_config not available during a probe"
    fi

    getent passwd $OCF_RESKEY_user >/dev/null 2>&1
    rc=$?
    if [ $rc -ne 0 ]; then
        ocf_log err "User $OCF_RESKEY_user doesn't exist"
        return $OCF_ERR_INSTALLED
    fi

    true
}

nova_serial_console_status() {
    local pid
    local rc

    if [ ! -f $OCF_RESKEY_pid ]; then
        ocf_log info "OpenStack Nova Serialproxy (nova-serialproxy) is not running"
        return $OCF_NOT_RUNNING
    else
        pid=`cat $OCF_RESKEY_pid`
    fi

    ocf_run -warn kill -s 0 $pid
    rc=$?
    if [ $rc -eq 0 ]; then
        return $OCF_SUCCESS
    else
        ocf_log info "Old PID file found, but OpenStack Nova Serialproxy (nova-serialproxy) is not running"
        rm -f $OCF_RESKEY_pid
        return $OCF_NOT_RUNNING
    fi
}

nova_serial_console_monitor() {
    local rc
    local serial_list_check

    nova_serial_console_status
    rc=$?

    # If status returned anything but success, return that immediately
    if [ $rc -ne $OCF_SUCCESS ]; then
        return $rc
    fi

    # Check whether we are supposed to monitor by logging into nova-serialproxy
    # and do it if that's the case.
    # Adding -n to netstat so that dns delays will not impact this.
	serial_list_check=`netstat -an | grep -s "$OCF_RESKEY_console_port" | grep -qs "LISTEN"`
    rc=$?
    if [ $rc -ne 0 ]; then
        ocf_log err "Nova Serial Console doesn't seem to listen on his default port: $rc"
        return $OCF_NOT_RUNNING
    fi

    ocf_log debug "OpenStack Nova Serial Console (nova-serialproxy) monitor succeeded"
    return $OCF_SUCCESS
}

nova_serial_console_start() {
    local rc

    nova_serial_console_status
    rc=$?
    if [ $rc -eq $OCF_SUCCESS ]; then
        ocf_log info "OpenStack Nova Serial Console (nova-serialproxy) already running"
        return $OCF_SUCCESS
    fi

    # Change the working dir to /, to be sure it's accesible
    cd /

    # run the actual nova-serialproxy daemon. Don't use ocf_run as we're sending the tool's output
    # straight to /dev/null anyway and using ocf_run would break stdout-redirection here.
    su ${OCF_RESKEY_user} -s /bin/sh -c "${OCF_RESKEY_binary} --config-file=$OCF_RESKEY_config \
       $OCF_RESKEY_additional_parameters"' >> /dev/null 2>&1 & echo $!' > $OCF_RESKEY_pid

    # Spin waiting for the server to come up.
    # Let the CRM/LRM time us out if required
    while true; do
    nova_serial_console_monitor
    rc=$?
    [ $rc -eq $OCF_SUCCESS ] && break
    if [ $rc -ne $OCF_NOT_RUNNING ]; then
        ocf_log err "OpenStack Nova Serial Console (nova-serialproxy) start failed"
        exit $OCF_ERR_GENERIC
    fi
    sleep 1
    done

    ocf_log info "OpenStack Nova Serial Console (nova-serialproxy) started"
    return $OCF_SUCCESS
}

nova_serial_console_confirm_stop() {
    local my_bin
    local my_processes

    my_binary=`which ${OCF_RESKEY_binary}`
    my_processes=`pgrep -l -f "^(python|/usr/bin/python|/usr/bin/python2) ${my_binary}([^\w-]|$)"`

    if [ -n "${my_processes}" ]
    then
        ocf_log info "About to SIGKILL the following: ${my_processes}"
        pkill -KILL -f "^(python|/usr/bin/python|/usr/bin/python2) ${my_binary}([^\w-]|$)"
    fi
}

nova_serial_console_stop() {
    local rc
    local pid

    nova_serial_console_status
    rc=$?
    if [ $rc -eq $OCF_NOT_RUNNING ]; then
        ocf_log info "OpenStack Nova Serial Console (nova-serialproxy) already stopped"
        nova_serial_console_confirm_stop
        return $OCF_SUCCESS
    fi

    # Try SIGTERM
    pid=`cat $OCF_RESKEY_pid`
    ocf_run kill -s TERM $pid
    rc=$?
    if [ $rc -ne 0 ]; then
        ocf_log err "OpenStack Nova Serial Console (nova-serialproxy) couldn't be stopped"
        nova_serial_console_confirm_stop
        exit $OCF_ERR_GENERIC
    fi

    # stop waiting
    shutdown_timeout=15
    if [ -n "$OCF_RESKEY_CRM_meta_timeout" ]; then
        shutdown_timeout=$((($OCF_RESKEY_CRM_meta_timeout/1000)-5))
    fi
    count=0
    while [ $count -lt $shutdown_timeout ]; do
        nova_serial_console_status
        rc=$?
        if [ $rc -eq $OCF_NOT_RUNNING ]; then
            break
        fi
        count=`expr $count + 1`
        sleep 1
        ocf_log debug "OpenStack Nova Serial Console (nova-serialproxy) still hasn't stopped yet. Waiting ..."
    done

    nova_serial_console_status
    rc=$?
    if [ $rc -ne $OCF_NOT_RUNNING ]; then
        # SIGTERM didn't help either, try SIGKILL
        ocf_log info "OpenStack Nova Serial Console (nova-serialproxy) failed to stop after ${shutdown_timeout}s \
          using SIGTERM. Trying SIGKILL ..."
        ocf_run kill -s KILL $pid
    fi
    nova_serial_console_confirm_stop

    ocf_log info "OpenStack Nova Serial Console (nova-serialproxy) stopped"

    rm -f $OCF_RESKEY_pid

    return $OCF_SUCCESS
}

#######################################################################

case "$1" in
  meta-data)    meta_data
                exit $OCF_SUCCESS;;
  usage|help)   usage
                exit $OCF_SUCCESS;;
esac

# Anything except meta-data and help must pass validation
nova_serial_console_validate || exit $?

# What kind of method was invoked?
case "$1" in
  start)        nova_serial_console_start;;
  stop)         nova_serial_console_stop;;
  status)       nova_serial_console_status;;
  monitor)      nova_serial_console_monitor;;
  validate-all) ;;
  *)            usage
                exit $OCF_ERR_UNIMPLEMENTED;;
esac