# Software License Agreement (BSD License)
#
# Copyright (c) 2009-2011, Eucalyptus Systems, Inc.
# All rights reserved.
#
# Redistribution and use of this software in source and binary forms, with or
# without modification, are permitted provided that the following conditions
# are met:
#
# Redistributions of source code must retain the above
# copyright notice, this list of conditions and the
# following disclaimer.
#
# Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the
# following disclaimer in the documentation and/or other
# materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# Author: matt.clark@eucalyptus.com
'''
Created on Mar 7, 2012
@author: clarkmatthew
Place holder class to provide convenience for testing, modifying, and retrieving Eucalyptus cloud property information
Intention is to reduce the time in looking up property names, and values outside of the eutester test lib, etc
Note: Debug output for the tester.sys command are controled by the eutester/eucaops object
Sample:
props = EucaProperties(myeutesterobject)
#get some property values
mysanhost = props.get_storage_sanhost()[0]
mysanhostp1 = props.get_storage_sanhost(zone='PARTI01')[0]
#use a convenience method to set a property
prop.set_storage_sanhost('192.168.1.1',zone='PARTI01')
#get the property string value for a given property
sanhostp1propertystring = props.get_storage_sanhost(zone=PARTI01)[1]
#reset a cloud property to it's default value
props.reset_property_to_default(sanhostp1propertystring)
'''
import types
import re
[docs]class Euproperty_type():
authentication = 'authentication'
bootstrap = 'bootstrap'
cloud = 'cloud'
cluster = 'cluster'
reporting = 'reporting'
storage = 'storage'
system = 'system'
vmwarebroker = 'vmwarebroker'
walrus = 'walrus'
www = 'www'
@classmethod
[docs] def get_type_by_string(cls,str):
try:
return getattr(self, str)
except AttributeError, ae:
self.debug('Property type:'+str(str)+" not defined, new property type?")
raise ae
[docs]class Euproperty():
def __init__(self, prop_mgr, property_string, servicetype, partition, name, value, mandatory=False):
self.prop_mgr = prop_mgr
self.servicetype = Euproperty_type.get_type_by_string(servicetype)
self.partition = partition
self.name = name
self.value = value
self.property_string = str(servicetype)+"."+str(partition)+"."+str(name)
self.utils = Euproperty_utils()
self.utils = prop_mgr
self.lastvalue = value
self.mandatory=mandatory
[docs] def update(self):
self.propmgr.update_property_list()
[docs]class Euproperty_manager():
tester = None
verbose = False
debugmethod = None
def __init__(self, tester, verbose=False, debugmethod=None):
self.tester = tester
self.debugmethod = debugmethod
self.verbose = verbose
self.clc = self.get_clc()
self.access_key = self.tester.aws_access_key_id
self.secret_key = self.tester.aws_secret_access_key
self.service_url = 'http://'+str(self.tester.get_ec2_ip())+':8773/services/Eucalytpus'
self.cmdpath = self.tester.eucapath+'/usr/sbin/'
self.properties = []
[docs] def get_clc(self):
return self.tester.service_manager.get_enabled_clc().machine
[docs] def debug(self,msg):
'''
simple method for printing debug.
msg - mandatory - string to be printed
method - optional - callback to over ride default printing method
'''
if (self.verbose is True):
if (self.debugmethod is None):
print (str(msg))
else:
self.debugmethod(msg)
[docs] def get_property_value(self, prop):
'''
Returns a tuple containing the current property value plus the property string.
prop - mandatory - string representing the property to fetch.
ecuaops -optional - the eucaops/eutester object to fetch the property from
self.debug("Getting property:"+prop)
prop_string = self.clc.sys(self.cmdpath+'euca-describe-properties -U '+str(self.service_url)+' -I '+str(self.access_key)+' -S '+ str(self.secret_key) +' | grep ' + prop, code=0)
if (prop_string != []):
value = str(prop_string[0]).split()[2]
else:
raise EuPropertiesException("describe properties returned null for "+prop)
'''
prop = self.get_euproperty_by_name(prop)
return prop.value
[docs] def update_property_list(self):
newlist = []
self.debug("Getting property list...")
cmdout = self.clc.sys(self.cmdpath+'euca-describe-properties -U '+str(self.service_url)+' -I '+str(self.access_key)+' -S '+ str(self.secret_key) +' | grep PROPERTY', code=0)
for propstring in cmdout:
newlist.append(parse_euproperty_from_string(propstring))
self.properties = newlist
[docs] def parse_euproperty_from_string(self, str):
'''
Intended to convert a line of ouptut from euca-describe-properties into
a euproperty.
:param str: line of output, example: "PROPERTY walrus.storagemaxbucketsizeinmb 5120"
:returns euproperty
'''
toss, ret_property_string, ret_value = str.split()
for prop in self.properties:
#if this property is in our list, update the value and return
if prop.property_string == ret_property_string:
prop.lastvalue = prop.value
prop.value = ret_value
return prop
#else this property is not in our list yet, create a new property
propattrs = ret_property_string.split('.')
try:
ret_type = Euproperty_type.get_type_by_string(propattrs[0])
propattrs.remove(propattrs[0])
except AttributeError:
ret_servicetype = Euproperty_type.get_type_by_string(propatters[1])
ret_partition = propatters[0]
propattrs.remove(propattrs[0])
propattrs.remove(propattrs[1])
ret_name = str(".").join(propattrs)
newprop = Euproperty(self, ret_property_string, ret_servicetype, ret_partition, ret_name, ret_value)
self.properties.append(newprop)
[docs] def get_euproperty_by_name(self,name):
for prop in self.properties:
if prop.name == name:
return prop
raise Exception('Property not found by name:'+str(name))
[docs] def set_property(self, prop, value):
'''
Sets the property 'prop' at eucaops/eutester object 'tester' to 'value'
Returns new value
prop - mandatory - string representing the property to set
value - mandatory - string representing the value to set the property to
eucaops - optional - the eucaops/eutester object to set the property at
'''
value = str(value)
eucaops = self.tester
self.debug('Setting property('+prop+') to value:'+str(value))
ret_string = self.clc.sys(self.cmdpath+'euca-modify-property -U '+str(self.service_url)+' -I '+str(self.access_key)+' -S '+ str(self.secret_key) +' -p '+prop+'='+str(value), code=0)
if ( ret_string != [] ):
ret_value= str(ret_string[0]).split()[2]
else:
raise EuPropertiesException("set_property output from modify was None")
if (ret_value != value):
raise EuPropertiesException("set property("+prop+") to value("+str(value)+") failed.Ret Value ("+str(ret_value)+")\nRet String\n"+ret_string)
return ret_value
[docs] def reset_property_to_default(self, prop):
'''
Sets a property 'prop' at eucaops/eutester object 'eucaops' to it's default value
Returns new value
prop - mandatory - string representing the property to set
ucaops - optional - the eucaops/eutester object to set the property at
'''
eucaops = self.tester
ret_string = str(self.clc.sys(self.cmdpath+'euca-modify-property -U '+str(self.service_url)+' -I '+str(self.access_key)+' -S '+ str(self.secret_key) +' -r '+prop,code=0)[0])
ret_value= ret_string.split()[2]
self.debug('Reset property('+prop+') to default value('+str(ret_value)+')')
return ret_value
[docs] def get_property_default_value(self, prop, ireadthewarning=False):
'''
Note: This hack method is intrusive! It will briefly reset the property
This is a temporary method to get a properties default method
prop - mandatory - string, eucalyptus property
ireadthewarning - mandatory - boolean, to warn user this method is intrusive
'''
if (ireadthewarning is False):
raise EuPropertiesException("ireadthewarning is set to false in get_property_default_value")
original = self.get_property_value(prop)
default = self.reset_property_to_default(prop)
self.set_property(prop, original)
return default
'''
########################################################################
STORAGE RELATED PROPERTY METHODS...
########################################################################
'''
#PARTI00.storage.maxvolumesizeingb
[docs] def get_storage_maxvolumesizeingb(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.maxvolumesizeingb')
return value
[docs] def set_storage_maxvolumesizeingb(self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.maxvolumesizeingb', value)
#PARTI00.storage.maxtotalvolumesizeingb
[docs] def get_storage_maxtotalvolumesizeingb(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.maxtotalvolumesizeingb')
return value
[docs] def set_storage_maxtotalvolumesizeingb(self, value, zone='PARTI00'):
value = self.set_property( zone+'.storage.maxtotalvolumesizeingb', value)
return value
#PARTI00.storage.zerofillvolumes
[docs] def get_storage_zerofillvolumes(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.zerofillvolumes')
return value
[docs] def set_storage_zerofillvolumes(self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.zerofillvolumes', value)
#PARTI00.storage.volumesdir
[docs] def get_storage_volumesdir(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.volumesdir')
return value
[docs] def set_storage_volumesdir(self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.volumesdir', value)
#PARTI00.storage.tid
[docs] def get_storage_tid(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.tid')
return value
[docs] def set_storage_tid(self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.tid', value)
#PARTI00.storage.storeprefix
[docs] def get_storage_storeprefix(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.storeprefix')
return value
[docs] def set_storage_storeprefix(self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.storeprefix', value)
#PARTI00.storageinterface
[docs] def get_storageinterface(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.storageinterface')
return value
[docs] def set_storageinterface(self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.storageinterface', value)
#PARTI00.storage.snappercent
[docs] def get_storage_snappercent(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.snappercent')
return value
[docs] def set_storage_snappercent(self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.snappercent', value)
#PARTI00.storage.shouldtransfersnapshots
[docs] def get_storage_shouldtransfersnapshots(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.shouldtransfersnapshots')
return value
[docs] def set_storage_shouldtransfersnapshots(self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.shouldtransfersnapshots', value)
#PARTI00.storage.sanuser
[docs] def get_storage_sanuser(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.sanuser')
return value
[docs] def set_storage_sanuser(self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.sanuser', value)
#PARTI00.storage.sanpassword
[docs] def get_storage_sanpassword(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.sanpassword')
return value
[docs] def set_storage_sanpassword(self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.sanpassword', value)
#PARTI00.storage.sanhost
[docs] def get_storage_sanhost(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.sanhost')
return value
[docs] def set_storage_sanhost(self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.sanhost', value)
#PARTI00.storage.minornumber
[docs] def get_storage_minornumber(self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.minornumber')
return value
[docs] def set_storage_minornumber(self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.minornumber', value)
#PARTI00.storage.majornumber
[docs] def get_storage_majornumber (self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.majornumber ')
return value
[docs] def set_storage_majornumber (self, value, zone='PARTI00'):
return self.set_property( zone+'.storage.majornumber', value)
#PARTI00.storage.dasdevice
[docs] def get_storage_dasdevice (self, zone='PARTI00'):
value = self.get_property_value( zone+'.storage.dasdevice')
return value
[docs] def set_storage_dasdevice (self, value, zone='PARTI00'):
if not isinstance(value, types.StringTypes):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.dasdevice ', value)
[docs] def get_storage_activestoragegroupcleaning(self, zone='PARTI00'): #false
return self.get_property_value( zone+'.storage.activestoragegroupcleaning')
[docs] def set_storage_activestoragegroupcleaning(self, boolean, zone='PARTI00'):
if not isinstance(boolean, types.BooleanType):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.activestoragegroupcleaning', boolean)
[docs] def get_storage_chapuser(self, zone='PARTI00'):
return self.get_property_value( zone+'.storage.chapuser')
[docs] def set_storage_chapuser(self, string, zone='PARTI00'): #e4c6-1000
if not isinstance(string, types.StringTypes):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.chapuser')
[docs] def get_storage_blockstoragemanager(self, zone='PARTI00'):
return self.get_property_value( zone+'.storage.blockstoragemanager')
[docs] def set_storage_blockstoragemanager(self, string, zone='PARTI00'): #e4c6-1000
if not isinstance(string, types.StringTypes):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.blockstoragemanager')
[docs] def get_storage_clipath(self, zone='PARTI00'):
return self.get_property_value( zone+'.storage.clipath')
[docs] def set_storage_clipath(self, path, zone='PARTI00'): #/opt/Navisphere/bin/naviseccli
if not isinstance(path, types.StringTypes):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.clipath')
[docs] def get_storage_clonestoragegroup(self, zone='PARTI00'):
return self.get_property_value( zone+'.storage.clonestoragegroup')
[docs] def set_storage_clonestoragegroup(self, string, zone='PARTI00'): #eucalyptus_clonelungroup
if not isinstance(string, types.StringTypes):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.clonestoragegroup')
[docs] def get_storage_loginscope(self, zone='PARTI00'):
return self.get_property_value( zone+'.storage.loginscope')
[docs] def set_storage_loginscope(self, int, zone='PARTI00'): #0
if not isinstance(int, types.IntType):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.loginscope')
[docs] def get_storage_lunspallocator(self, zone='PARTI00'):
return self.get_property_value( zone+'.storage.lunspallocator')
[docs] def set_storage_lunspallocator(self, string, zone='PARTI00'): #EmcVnxLunSpAllocatorByVolIdHash
if not isinstance(string, types.StringTypes):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.lunspallocator')
[docs] def get_storage_ncpaths(self, zone='PARTI00'):
return self.get_property_value( zone+'.storage.ncpaths')
[docs] def set_storage_ncpaths(self, string, zone='PARTI00'): #iface0:192.168.25.182,iface1:10.109.25.186
if not isinstance(string, types.StringTypes):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.ncpaths')
[docs] def get_storage_quiescetimeseconds(self, zone='PARTI00'):
return self.get_property_value( zone+'.storage.quiescetimeseconds')
[docs] def set_storage_quiescetimeseconds(self, int, zone='PARTI00'): #10
if not isinstance(int, types.IntType):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.quiescetimeseconds')
[docs] def get_storage_scpaths(self, zone='PARTI00'):
return self.get_property_value( zone+'.storage.scpaths')
[docs] def set_storage_scpaths(self, string, zone='PARTI00'): #iface0:192.168.25.182,iface1:10.109.25.186
if not isinstance(string, types.StringTypes):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.scpaths')
[docs] def get_storage_storagepool(self, zone='PARTI00'):
return self.get_property_value( zone+'.storage.storagepool')
[docs] def set_storage_storagepool(self, int, zone='PARTI00'): #0
if not isinstance(int, types.IntType):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.storagepool')
[docs] def get_storage_syncrate(self, zone='PARTI00'):
return self.get_property_value( zone+'.storage.syncrate')
[docs] def set_storage_syncrate(self, string, zone='PARTI00'): #high
if not isinstance(string, types.StringTypes):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.syncrate')
[docs] def get_storage_timeoutinmillis(self, zone='PARTI00'):
return self.get_property_value( zone+'.storage.timeoutinmillis')
[docs] def set_storage_timeoutinmillis(self, int, zone='PARTI00'): #<unset
if not isinstance(int, types.IntType):
raise Exception("Incorrect type passed")
return self.set_property( zone+'.storage.timeoutinmillis')
'''
########################################################################
WALRUS RELATED PROPERTY METHODS...
########################################################################
'''
#walrus.storagemaxtotalsnapshotsizeingb
[docs] def get_walrus_storagemaxtotalsnapshotsizeingb(self, tester=None):
value = self.get_property_value( 'walrus.storagemaxtotalsnapshotsizeingb')
return value
[docs] def set_walrus_storagemaxtotalsnapshotsizeingb(self, value, tester=None):
return self.set_property( 'walrus.storagemaxtotalsnapshotsizeingb', value)
[docs]class EuPropertiesException(Exception):
def __init__(self, value):
self.value = value
def __str__ (self):
return repr(self.value)