X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/3f0ab95f56562c0d1955f5d787d799ffe1c8b59f..61413377c7a1c624c4a5f2c2ec55dbc3d8691896:/lib/opcodes.py diff --git a/lib/opcodes.py b/lib/opcodes.py index 3c7355f..0293ba4 100644 --- a/lib/opcodes.py +++ b/lib/opcodes.py @@ -34,6 +34,7 @@ opcodes. # pylint: disable-msg=R0903 import logging +import re from ganeti import constants from ganeti import errors @@ -77,6 +78,30 @@ _PTagKind = ("kind", ht.NoDefault, ht.TElemOf(constants.VALID_TAG_TYPES)) #: List of tag strings _PTags = ("tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)) +#: OP_ID conversion regular expression +_OPID_RE = re.compile("([a-z])([A-Z])") + + +def _NameToId(name): + """Convert an opcode class name to an OP_ID. + + @type name: string + @param name: the class name, as OpXxxYyy + @rtype: string + @return: the name in the OP_XXXX_YYYY format + + """ + if not name.startswith("Op"): + return None + # Note: (?<=[a-z])(?=[A-Z]) would be ideal, since it wouldn't + # consume any input, and hence we would just have all the elements + # in the list, one by one; but it seems that split doesn't work on + # non-consuming input, hence we have to process the input string a + # bit + name = _OPID_RE.sub(r"\1,\2", name) + elems = name.split(",") + return "_".join(n.upper() for n in elems) + def RequireFileStorage(): """Checks that file storage is enabled. @@ -138,7 +163,9 @@ class _AutoOpParamSlots(type): """ assert "__slots__" not in attrs, \ "Class '%s' defines __slots__ when it should use OP_PARAMS" % name - assert "OP_ID" in attrs, "Class '%s' is missing OP_ID attribute" % name + assert "OP_ID" not in attrs, "Class '%s' defining OP_ID" % name + + attrs["OP_ID"] = _NameToId(name) # Always set OP_PARAMS to avoid duplicates in BaseOpCode.GetAllParams params = attrs.setdefault("OP_PARAMS", []) @@ -161,10 +188,10 @@ class BaseOpCode(object): field handling. """ + # pylint: disable-msg=E1101 + # as OP_ID is dynamically defined __metaclass__ = _AutoOpParamSlots - OP_ID = None - def __init__(self, **kwargs): """Constructor for BaseOpCode. @@ -296,7 +323,8 @@ class OpCode(BaseOpCode): @ivar priority: Opcode priority for queue """ - OP_ID = "OP_ABSTRACT" + # pylint: disable-msg=E1101 + # as OP_ID is dynamically defined WITH_LU = True OP_PARAMS = [ ("dry_run", None, ht.TMaybeBool), @@ -352,12 +380,14 @@ class OpCode(BaseOpCode): def Summary(self): """Generates a summary description of this opcode. - The summary is the value of the OP_ID attribute (without the "OP_" prefix), - plus the value of the OP_DSC_FIELD attribute, if one was defined; this field - should allow to easily identify the operation (for an instance creation job, - e.g., it would be the instance name). + The summary is the value of the OP_ID attribute (without the "OP_" + prefix), plus the value of the OP_DSC_FIELD attribute, if one was + defined; this field should allow to easily identify the operation + (for an instance creation job, e.g., it would be the instance + name). """ + assert self.OP_ID is not None and len(self.OP_ID) > 3 # all OP_ID start with OP_, we remove that txt = self.OP_ID[3:] field_name = getattr(self, "OP_DSC_FIELD", None) @@ -378,7 +408,6 @@ class OpClusterPostInit(OpCode): after the cluster has been initialized. """ - OP_ID = "OP_CLUSTER_POST_INIT" class OpClusterDestroy(OpCode): @@ -388,12 +417,10 @@ class OpClusterDestroy(OpCode): lost after the execution of this opcode. """ - OP_ID = "OP_CLUSTER_DESTROY" class OpClusterQuery(OpCode): """Query cluster information.""" - OP_ID = "OP_CLUSTER_QUERY" class OpClusterVerify(OpCode): @@ -406,7 +433,6 @@ class OpClusterVerify(OpCode): only L{constants.VERIFY_NPLUSONE_MEM} can be passed """ - OP_ID = "OP_CLUSTER_VERIFY" OP_PARAMS = [ ("skip_checks", ht.EmptyList, ht.TListOf(ht.TElemOf(constants.VERIFY_OPTIONAL_CHECKS))), @@ -437,7 +463,6 @@ class OpClusterVerifyDisks(OpCode): consideration. This might need to be revisited in the future. """ - OP_ID = "OP_CLUSTER_VERIFY_DISKS" class OpClusterRepairDiskSizes(OpCode): @@ -456,7 +481,6 @@ class OpClusterRepairDiskSizes(OpCode): @ivar instances: the list of instances to check, or empty for all instances """ - OP_ID = "OP_CLUSTER_REPAIR_DISK_SIZES" OP_PARAMS = [ ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)), ] @@ -464,7 +488,6 @@ class OpClusterRepairDiskSizes(OpCode): class OpClusterConfigQuery(OpCode): """Query cluster configuration values.""" - OP_ID = "OP_CLUSTER_CONFIG_QUERY" OP_PARAMS = [ _POutputFields ] @@ -479,7 +502,6 @@ class OpClusterRename(OpCode): address. """ - OP_ID = "OP_CLUSTER_RENAME" OP_DSC_FIELD = "name" OP_PARAMS = [ ("name", ht.NoDefault, ht.TNonEmptyString), @@ -493,7 +515,6 @@ class OpClusterSetParams(OpCode): @ivar vg_name: The new volume group name or None to disable LVM usage. """ - OP_ID = "OP_CLUSTER_SET_PARAMS" OP_PARAMS = [ ("vg_name", None, ht.TMaybeString), ("enabled_hypervisors", None, @@ -512,8 +533,8 @@ class OpClusterSetParams(OpCode): ("remove_uids", None, ht.NoType), ("maintain_node_health", None, ht.TMaybeBool), ("prealloc_wipe_disks", None, ht.TMaybeBool), - ("nicparams", None, ht.TOr(ht.TDict, ht.TNone)), - ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)), + ("nicparams", None, ht.TMaybeDict), + ("ndparams", None, ht.TMaybeDict), ("drbd_helper", None, ht.TOr(ht.TString, ht.TNone)), ("default_iallocator", None, ht.TOr(ht.TString, ht.TNone)), ("master_netdev", None, ht.TOr(ht.TString, ht.TNone)), @@ -535,7 +556,6 @@ class OpClusterRedistConf(OpCode): """Force a full push of the cluster configuration. """ - OP_ID = "OP_CLUSTER_REDIST_CONF" class OpQuery(OpCode): @@ -546,7 +566,6 @@ class OpQuery(OpCode): @ivar filter: Query filter """ - OP_ID = "OP_QUERY" OP_PARAMS = [ ("what", ht.NoDefault, ht.TElemOf(constants.QR_OP_QUERY)), ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)), @@ -562,7 +581,6 @@ class OpQueryFields(OpCode): @ivar fields: List of fields to retrieve """ - OP_ID = "OP_QUERY_FIELDS" OP_PARAMS = [ ("what", ht.NoDefault, ht.TElemOf(constants.QR_OP_QUERY)), ("fields", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString))), @@ -571,9 +589,8 @@ class OpQueryFields(OpCode): class OpOobCommand(OpCode): """Interact with OOB.""" - OP_ID = "OP_OOB_COMMAND" OP_PARAMS = [ - _PNodeName, + ("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)), ("command", None, ht.TElemOf(constants.OOB_COMMANDS)), ("timeout", constants.OOB_TIMEOUT, ht.TInt), ] @@ -589,7 +606,6 @@ class OpNodeRemove(OpCode): instances on it, the operation will fail. """ - OP_ID = "OP_NODE_REMOVE" OP_DSC_FIELD = "node_name" OP_PARAMS = [ _PNodeName, @@ -624,7 +640,6 @@ class OpNodeAdd(OpCode): @ivar master_capable: The master_capable node attribute """ - OP_ID = "OP_NODE_ADD" OP_DSC_FIELD = "node_name" OP_PARAMS = [ _PNodeName, @@ -634,13 +649,12 @@ class OpNodeAdd(OpCode): ("group", None, ht.TMaybeString), ("master_capable", None, ht.TMaybeBool), ("vm_capable", None, ht.TMaybeBool), - ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)), + ("ndparams", None, ht.TMaybeDict), ] class OpNodeQuery(OpCode): """Compute the list of nodes.""" - OP_ID = "OP_NODE_QUERY" OP_PARAMS = [ _POutputFields, ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)), @@ -650,7 +664,6 @@ class OpNodeQuery(OpCode): class OpNodeQueryvols(OpCode): """Get list of volumes on node.""" - OP_ID = "OP_NODE_QUERYVOLS" OP_PARAMS = [ _POutputFields, ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)), @@ -659,7 +672,6 @@ class OpNodeQueryvols(OpCode): class OpNodeQueryStorage(OpCode): """Get information on storage for node(s).""" - OP_ID = "OP_NODE_QUERY_STORAGE" OP_PARAMS = [ _POutputFields, _PStorageType, @@ -670,7 +682,6 @@ class OpNodeQueryStorage(OpCode): class OpNodeModifyStorage(OpCode): """Modifies the properies of a storage unit""" - OP_ID = "OP_NODE_MODIFY_STORAGE" OP_PARAMS = [ _PNodeName, _PStorageType, @@ -681,7 +692,6 @@ class OpNodeModifyStorage(OpCode): class OpRepairNodeStorage(OpCode): """Repairs the volume group on a node.""" - OP_ID = "OP_REPAIR_NODE_STORAGE" OP_DSC_FIELD = "node_name" OP_PARAMS = [ _PNodeName, @@ -693,7 +703,6 @@ class OpRepairNodeStorage(OpCode): class OpNodeSetParams(OpCode): """Change the parameters of a node.""" - OP_ID = "OP_NODE_SET_PARAMS" OP_DSC_FIELD = "node_name" OP_PARAMS = [ _PNodeName, @@ -705,14 +714,13 @@ class OpNodeSetParams(OpCode): ("master_capable", None, ht.TMaybeBool), ("vm_capable", None, ht.TMaybeBool), ("secondary_ip", None, ht.TMaybeString), - ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)), + ("ndparams", None, ht.TMaybeDict), ("powered", None, ht.TMaybeBool), ] class OpNodePowercycle(OpCode): """Tries to powercycle a node.""" - OP_ID = "OP_NODE_POWERCYCLE" OP_DSC_FIELD = "node_name" OP_PARAMS = [ _PNodeName, @@ -722,7 +730,6 @@ class OpNodePowercycle(OpCode): class OpNodeMigrate(OpCode): """Migrate all instances from a node.""" - OP_ID = "OP_NODE_MIGRATE" OP_DSC_FIELD = "node_name" OP_PARAMS = [ _PNodeName, @@ -733,7 +740,6 @@ class OpNodeMigrate(OpCode): class OpNodeEvacStrategy(OpCode): """Compute the evacuation strategy for a list of nodes.""" - OP_ID = "OP_NODE_EVAC_STRATEGY" OP_DSC_FIELD = "nodes" OP_PARAMS = [ ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)), @@ -756,7 +762,6 @@ class OpInstanceCreate(OpCode): (remote import only) """ - OP_ID = "OP_INSTANCE_CREATE" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -793,19 +798,17 @@ class OpInstanceCreate(OpCode): class OpInstanceReinstall(OpCode): """Reinstall an instance's OS.""" - OP_ID = "OP_INSTANCE_REINSTALL" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, ("os_type", None, ht.TMaybeString), ("force_variant", False, ht.TBool), - ("osparams", None, ht.TOr(ht.TDict, ht.TNone)), + ("osparams", None, ht.TMaybeDict), ] class OpInstanceRemove(OpCode): """Remove an instance.""" - OP_ID = "OP_INSTANCE_REMOVE" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -816,7 +819,6 @@ class OpInstanceRemove(OpCode): class OpInstanceRename(OpCode): """Rename an instance.""" - OP_ID = "OP_INSTANCE_RENAME" OP_PARAMS = [ _PInstanceName, ("new_name", ht.NoDefault, ht.TNonEmptyString), @@ -827,7 +829,6 @@ class OpInstanceRename(OpCode): class OpInstanceStartup(OpCode): """Startup an instance.""" - OP_ID = "OP_INSTANCE_STARTUP" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -840,7 +841,6 @@ class OpInstanceStartup(OpCode): class OpInstanceShutdown(OpCode): """Shutdown an instance.""" - OP_ID = "OP_INSTANCE_SHUTDOWN" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -851,7 +851,6 @@ class OpInstanceShutdown(OpCode): class OpInstanceReboot(OpCode): """Reboot an instance.""" - OP_ID = "OP_INSTANCE_REBOOT" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -863,7 +862,6 @@ class OpInstanceReboot(OpCode): class OpInstanceReplaceDisks(OpCode): """Replace the disks of an instance.""" - OP_ID = "OP_INSTANCE_REPLACE_DISKS" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -877,7 +875,6 @@ class OpInstanceReplaceDisks(OpCode): class OpInstanceFailover(OpCode): """Failover an instance.""" - OP_ID = "OP_INSTANCE_FAILOVER" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -896,7 +893,6 @@ class OpInstanceMigrate(OpCode): @ivar mode: the migration mode (live, non-live or None for auto) """ - OP_ID = "OP_INSTANCE_MIGRATE" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -916,7 +912,6 @@ class OpInstanceMove(OpCode): @ivar target_node: the destination node """ - OP_ID = "OP_INSTANCE_MOVE" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -927,7 +922,6 @@ class OpInstanceMove(OpCode): class OpInstanceConsole(OpCode): """Connect to an instance's console.""" - OP_ID = "OP_INSTANCE_CONSOLE" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName @@ -936,7 +930,6 @@ class OpInstanceConsole(OpCode): class OpInstanceActivateDisks(OpCode): """Activate an instance's disks.""" - OP_ID = "OP_INSTANCE_ACTIVATE_DISKS" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -946,16 +939,15 @@ class OpInstanceActivateDisks(OpCode): class OpInstanceDeactivateDisks(OpCode): """Deactivate an instance's disks.""" - OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ - _PInstanceName + _PInstanceName, + _PForce, ] class OpInstanceRecreateDisks(OpCode): """Deactivate an instance's disks.""" - OP_ID = "OP_INSTANCE_RECREATE_DISKS" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -965,7 +957,6 @@ class OpInstanceRecreateDisks(OpCode): class OpInstanceQuery(OpCode): """Compute the list of instances.""" - OP_ID = "OP_INSTANCE_QUERY" OP_PARAMS = [ _POutputFields, ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)), @@ -975,7 +966,6 @@ class OpInstanceQuery(OpCode): class OpInstanceQueryData(OpCode): """Compute the run-time status of instances.""" - OP_ID = "OP_INSTANCE_QUERY_DATA" OP_PARAMS = [ ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)), ("static", False, ht.TBool), @@ -984,7 +974,6 @@ class OpInstanceQueryData(OpCode): class OpInstanceSetParams(OpCode): """Change the parameters of an instance.""" - OP_ID = "OP_INSTANCE_SET_PARAMS" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -997,13 +986,12 @@ class OpInstanceSetParams(OpCode): ("remote_node", None, ht.TMaybeString), ("os_name", None, ht.TMaybeString), ("force_variant", False, ht.TBool), - ("osparams", None, ht.TOr(ht.TDict, ht.TNone)), + ("osparams", None, ht.TMaybeDict), ] class OpInstanceGrowDisk(OpCode): """Grow a disk of an instance.""" - OP_ID = "OP_INSTANCE_GROW_DISK" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -1017,11 +1005,10 @@ class OpInstanceGrowDisk(OpCode): class OpGroupAdd(OpCode): """Add a node group to the cluster.""" - OP_ID = "OP_GROUP_ADD" OP_DSC_FIELD = "group_name" OP_PARAMS = [ _PGroupName, - ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)), + ("ndparams", None, ht.TMaybeDict), ("alloc_policy", None, ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES))), ] @@ -1029,7 +1016,6 @@ class OpGroupAdd(OpCode): class OpGroupAssignNodes(OpCode): """Assign nodes to a node group.""" - OP_ID = "OP_GROUP_ASSIGN_NODES" OP_DSC_FIELD = "group_name" OP_PARAMS = [ _PGroupName, @@ -1040,7 +1026,6 @@ class OpGroupAssignNodes(OpCode): class OpGroupQuery(OpCode): """Compute the list of node groups.""" - OP_ID = "OP_GROUP_QUERY" OP_PARAMS = [ _POutputFields, ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)), @@ -1049,11 +1034,10 @@ class OpGroupQuery(OpCode): class OpGroupSetParams(OpCode): """Change the parameters of a node group.""" - OP_ID = "OP_GROUP_SET_PARAMS" OP_DSC_FIELD = "group_name" OP_PARAMS = [ _PGroupName, - ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)), + ("ndparams", None, ht.TMaybeDict), ("alloc_policy", None, ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES))), ] @@ -1061,7 +1045,6 @@ class OpGroupSetParams(OpCode): class OpGroupRemove(OpCode): """Remove a node group from the cluster.""" - OP_ID = "OP_GROUP_REMOVE" OP_DSC_FIELD = "group_name" OP_PARAMS = [ _PGroupName, @@ -1070,7 +1053,6 @@ class OpGroupRemove(OpCode): class OpGroupRename(OpCode): """Rename a node group in the cluster.""" - OP_ID = "OP_GROUP_RENAME" OP_DSC_FIELD = "old_name" OP_PARAMS = [ ("old_name", ht.NoDefault, ht.TNonEmptyString), @@ -1081,7 +1063,6 @@ class OpGroupRename(OpCode): # OS opcodes class OpOsDiagnose(OpCode): """Compute the list of guest operating systems.""" - OP_ID = "OP_OS_DIAGNOSE" OP_PARAMS = [ _POutputFields, ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)), @@ -1091,7 +1072,6 @@ class OpOsDiagnose(OpCode): # Exports opcodes class OpBackupQuery(OpCode): """Compute the list of exported images.""" - OP_ID = "OP_BACKUP_QUERY" OP_PARAMS = [ ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)), ("use_locking", False, ht.TBool), @@ -1105,7 +1085,6 @@ class OpBackupPrepare(OpCode): @ivar mode: Export mode (one of L{constants.EXPORT_MODES}) """ - OP_ID = "OP_BACKUP_PREPARE" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -1129,7 +1108,6 @@ class OpBackupExport(OpCode): only) """ - OP_ID = "OP_BACKUP_EXPORT" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -1148,7 +1126,6 @@ class OpBackupExport(OpCode): class OpBackupRemove(OpCode): """Remove an instance's export.""" - OP_ID = "OP_BACKUP_REMOVE" OP_DSC_FIELD = "instance_name" OP_PARAMS = [ _PInstanceName, @@ -1156,9 +1133,8 @@ class OpBackupRemove(OpCode): # Tags opcodes -class OpGetTags(OpCode): +class OpTagsGet(OpCode): """Returns the tags of the given object.""" - OP_ID = "OP_TAGS_GET" OP_DSC_FIELD = "name" OP_PARAMS = [ _PTagKind, @@ -1167,18 +1143,16 @@ class OpGetTags(OpCode): ] -class OpSearchTags(OpCode): +class OpTagsSearch(OpCode): """Searches the tags in the cluster for a given pattern.""" - OP_ID = "OP_TAGS_SEARCH" OP_DSC_FIELD = "pattern" OP_PARAMS = [ ("pattern", ht.NoDefault, ht.TNonEmptyString), ] -class OpAddTags(OpCode): +class OpTagsSet(OpCode): """Add a list of tags on a given object.""" - OP_ID = "OP_TAGS_SET" OP_PARAMS = [ _PTagKind, _PTags, @@ -1189,7 +1163,6 @@ class OpAddTags(OpCode): class OpTagsDel(OpCode): """Remove a list of tags from a given object.""" - OP_ID = "OP_TAGS_DEL" OP_PARAMS = [ _PTagKind, _PTags, @@ -1219,7 +1192,6 @@ class OpTestDelay(OpCode): generator. The case of duration == 0 will not be treated specially. """ - OP_ID = "OP_TEST_DELAY" OP_DSC_FIELD = "duration" OP_PARAMS = [ ("duration", ht.NoDefault, ht.TFloat), @@ -1240,7 +1212,6 @@ class OpTestAllocator(OpCode): return the allocator output (direction 'out') """ - OP_ID = "OP_TEST_ALLOCATOR" OP_DSC_FIELD = "allocator" OP_PARAMS = [ ("direction", ht.NoDefault, @@ -1262,11 +1233,10 @@ class OpTestAllocator(OpCode): ] -class OpTestJobqueue(OpCode): +class OpTestJqueue(OpCode): """Utility opcode to test some aspects of the job queue. """ - OP_ID = "OP_TEST_JQUEUE" OP_PARAMS = [ ("notify_waitlock", False, ht.TBool), ("notify_exec", False, ht.TBool), @@ -1279,7 +1249,6 @@ class OpTestDummy(OpCode): """Utility opcode used by unittests. """ - OP_ID = "OP_TEST_DUMMY" OP_PARAMS = [ ("result", ht.NoDefault, ht.NoType), ("messages", ht.NoDefault, ht.NoType),