__init__.py

# @copyright@
# Copyright (c) 2006 - 2018 Teradata
# All rights reserved. Stacki(r) v5.x stacki.com
# https://github.com/Teradata/stacki/blob/master/LICENSE.txt
# @copyright@
from datetime import datetime
from enum import Enum
import sys

class Backend:
	"""
	Object that encapsulates all backend attributes relevant
	to monitor installation
	"""
	def __init__(self, hostName, installaction, osaction, os):
		self.hostName = hostName
		self.installaction = installaction
		self.osaction = osaction
		self.ipList = []
		self.macList = []
		self.stateArr = []
		self.dhcpStateArr = []
		self.osKernel = None
		self.osRamdisk = None
		self.osArgs = None
		self.installKernel = None
		self.installRamdisk = None
		self.installArgs = None
		self.os = os
		self.osversion = None

	def __str__(self):
		l = []
		l.append('########## Attributes of %s - Backend ###########' % self.hostName)
		l.append('IP Addr = %s' % ','.join(self.ipList))
		l.append('MAC = %s' % ','.join(self.macList))
		l.append('OS = %s' % self.os)
		l.append('OS Version = %s' % self.osversion)
		l.append('OS Kernel = %s' % self.osKernel)
		l.append('OS Ramdisk = %s' % self.osRamdisk)
		l.append('OS Args = %s' % self.osArgs)
		l.append('Install Kernel = %s' % self.installKernel)
		l.append('Install Ramdisk = %s' % self.installRamdisk)
		l.append('Install Args = %s' % self.installArgs)
		l.append('#####################')
		return '\n'.join(l)

	# Test is Backend Installation is in the
	def isPostPkgInstallStage(self):
		arr = self.stateArr
		for a in reversed(arr):
			if a.state == State.Set_Bootaction_OS and \
				not a.isError:
				return True

		return False

	#
	# Checks if Backend installation has already progressed
	# through the State st.
	#
	def isKnownState(self, st):
		for a in self.stateArr:
			if a.state == st and not a.isError:
				return True

		return False

	#
	# Find index of State  in Backend StateMessage array
	# and return max int value if it does not exist
	#
	def findStateMsgIndex(self, st):
		for idx, a in enumerate(self.stateArr):
			if a.state == st:
				return idx
		return sys.maxsize

	#
	# Check if this message has been seen before and returns
	# True if this is the case.
	#
	def hasStateMessage(self, sm):
		for a in self.stateArr:
			if (a.state == sm.state and
				a.isError == sm.isError and
				a.msg == sm.msg):
				return True
		return False

	# Return the last successful StateMessage object
	def lastSuccessfulState(self):
		if not self.stateArr:
			return None

		for i in range(len(self.stateArr) - 1, -1, -1):
			if not self.stateArr[i].isError:
				return self.stateArr[i]
		return None

	# Copy all attributes (except stateArr) from Backend object b
	def copyAttributes(self, b):
		self.hostName = b.hostName
		self.os = b.os
		self.osversion = b.osversion
		self.installaction = b.installaction
		self.osaction = b.osaction
		self.ipList = b.ipList
		self.macList = b.macList
		self.osKernel = b.osKernel
		self.osRamdisk = b.osRamdisk
		self.osArgs = b.osArgs
		self.installKernel = b.installKernel
		self.installRamdisk = b.installRamdisk
		self.installArgs = b.installArgs

class State(Enum):
	"""
	Enum that represents various installation stages.
	"""
	DHCPDISCOVER = 10
	DHCPOFFER = 20
	DHCPREQUEST = 30
	DHCPACK = 40
	DHCPNACK = 42
	DHCPDECLINE = 46
	TFTP_RRQ = 50
	VMLinuz_RRQ_Install = 60
	Initrd_RRQ = 70
	Config_Sent = 80
	Common_Sent = 90
	Root_Sent = 100
	Cracklib_Dict_Sent = 110
	Bind_Sent = 120
	SLES_Img_Sent = 130
	Profile_XML_Sent = 140
	SSH_Open = 150
	AUTOINST_Present = 160
	Partition_File_Present = 170
	Ludicrous_Started = 180
	Ludicrous_Populated = 190
	Set_DB_Partitions = 200
	Set_Bootaction_OS = 210
	Rebooting_HDD = 220
	Reboot_Okay = 230
	Install_Wait = 500
	Installation_Stalled = 1000

class StateSequence:
	"""
	Stores sequence of expected States for each type of
	OS or OS version.
	"""

	SLES_12 = [
		{'state': State.DHCPDISCOVER, 'time': 20},
		{'state': State.DHCPOFFER, 'time': 20},
		{'state': State.DHCPREQUEST, 'time': 30},
		{'state': State.DHCPACK, 'time': 40},
		{'state': State.TFTP_RRQ, 'time': 50},
		{'state': State.VMLinuz_RRQ_Install, 'time': 60},
		{'state': State.Initrd_RRQ, 'time': 70},
		{'state': State.Config_Sent, 'time': 80},
		{'state': State.Common_Sent, 'time': 90},
		{'state': State.Root_Sent, 'time': 100},
		{'state': State.Cracklib_Dict_Sent, 'time': 110},
		{'state': State.Bind_Sent, 'time': 120},
		{'state': State.SLES_Img_Sent, 'time': 130},
		{'state': State.Profile_XML_Sent, 'time': 140},
		{'state': State.SSH_Open, 'time': 150},
		{'state': State.AUTOINST_Present, 'time': 160},
		{'state': State.Partition_File_Present, 'time': 170},
		{'state': State.Ludicrous_Started, 'time': 180},
		{'state': State.Ludicrous_Populated, 'time': 600},
		{'state': State.Set_DB_Partitions, 'time': 200},
		{'state': State.Set_Bootaction_OS, 'time': 210},
		{'state': State.Rebooting_HDD, 'time': 220},
		{'state': State.Reboot_Okay, 'time': 230}
	]

	SLES_11 = [
		{'state': State.DHCPDISCOVER, 'time': 20},
		{'state': State.DHCPOFFER, 'time': 20},
		{'state': State.DHCPREQUEST, 'time': 30},
		{'state': State.DHCPACK, 'time': 40},
		{'state': State.TFTP_RRQ, 'time': 50},
		{'state': State.VMLinuz_RRQ_Install, 'time': 60},
		{'state': State.Initrd_RRQ, 'time': 70},
		{'state': State.Config_Sent, 'time': 80},
		{'state': State.Common_Sent, 'time': 90},
		{'state': State.Root_Sent, 'time': 100},
		{'state': State.Cracklib_Dict_Sent, 'time': 110},
		{'state': State.Bind_Sent, 'time': 120},
		{'state': State.SLES_Img_Sent, 'time': 130},
		{'state': State.Profile_XML_Sent, 'time': 140},
		{'state': State.SSH_Open, 'time': 150},
		{'state': State.AUTOINST_Present, 'time': 160},
		{'state': State.Partition_File_Present, 'time': 170},
		{'state': State.Ludicrous_Started, 'time': 180},
		{'state': State.Ludicrous_Populated, 'time': 600},
		{'state': State.Set_DB_Partitions, 'time': 200},
		{'state': State.Set_Bootaction_OS, 'time': 210},
		{'state': State.Rebooting_HDD, 'time': 220},
		{'state': State.Reboot_Okay, 'time': 230}
	]

	REDHAT_7 = [
		{'state': State.DHCPDISCOVER, 'time': 20},
		{'state': State.DHCPOFFER, 'time': 20},
		{'state': State.DHCPREQUEST, 'time': 30},
		{'state': State.DHCPACK, 'time': 40},
		{'state': State.TFTP_RRQ, 'time': 50},
		{'state': State.VMLinuz_RRQ_Install, 'time': 60},
		{'state': State.Initrd_RRQ, 'time': 300},
		{'state': State.Profile_XML_Sent, 'time': 300},
		{'state': State.SSH_Open, 'time': 300},
		{'state': State.Partition_File_Present, 'time': 170},
		{'state': State.Ludicrous_Started, 'time': 180},
		{'state': State.Ludicrous_Populated, 'time': 600},
		{'state': State.Set_DB_Partitions, 'time': 200},
		{'state': State.Set_Bootaction_OS, 'time': 210},
		{'state': State.Rebooting_HDD, 'time': 220},
		{'state': State.Reboot_Okay, 'time': 230}
	]

	OS_STATE_MAP = {
		'sles-11.x': SLES_11,
		'sles-12.x': SLES_12,
		'redhat-7.x' : REDHAT_7
	}

	@staticmethod
	def nextExpectedState(currState, os, osversion):
		key = os + '-' + osversion
		if key not in StateSequence.OS_STATE_MAP:
			return None

		seqList = StateSequence.OS_STATE_MAP[key]
		for idx, s in enumerate(seqList):
			if s['state'] == currState and \
				(idx + 1) < len(seqList):
				return seqList[idx + 1]['state']

		return None

	@staticmethod
	def getTimeThreshold(currState, os, osversion):
		key = os + '-' + osversion
		if key not in StateSequence.OS_STATE_MAP:
			return None

		seqList = StateSequence.OS_STATE_MAP[key]
		for idx, s in enumerate(seqList):
			if s['state'] == currState:
				return seqList[idx]['time']

		return None

	@staticmethod
	def getStateListByOS(os, osversion):
		key = os + '-' + osversion
		if key not in StateSequence.OS_STATE_MAP:
			return None

		stateList = StateSequence.OS_STATE_MAP[key]
		opList = []

		for s in stateList:
			opList.append(s['state'])

		return opList

class StateMessage:
	"""
	Object that encapsulates system test message attributes
	"""
	def __init__(self, ipAddr, state, isError, time, msg='', isAddedToRedis=False):
		self.ipAddr = ipAddr
		self.state = state
		self.isError = isError
		self.time = time
		self.msg = msg
		self.isAddedToRedis = isAddedToRedis

	def __str__(self):
		print_str = 'IP = %s, %s State = %s, Success = %s' % \
			(self.ipAddr, self.convertTimestamp(), self.state, not self.isError)

		if self.msg:
			print_str = 'IP = %s, %s State = %s, Success = %s, Message = %s' % \
			(self.ipAddr, self.convertTimestamp(), self.state, not self.isError, self.msg)

		return print_str

	# Check if all attributes except isAddedToRedis, time is equal
	def __eq__(self, sm):
		if self.ipAddr == sm.ipAddr and \
			self.state == sm.state and \
			self.msg == sm.msg and \
			self.isError == sm.isError:
				return True

		return False

	def convertTimestamp(self):
		return datetime.utcfromtimestamp(self.time) \
			.strftime('%Y-%m-%d %H:%M:%S')