+import logging
+import re
+import operator
+
+from ganeti import constants
+from ganeti import errors
+from ganeti import ht
+
+
+# Common opcode attributes
+
+#: output fields for a query operation
+_POutputFields = ("output_fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
+ "Selected output fields")
+
+#: the shutdown timeout
+_PShutdownTimeout = \
+ ("shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt,
+ "How long to wait for instance to shut down")
+
+#: the force parameter
+_PForce = ("force", False, ht.TBool, "Whether to force the operation")
+
+#: a required instance name (for single-instance LUs)
+_PInstanceName = ("instance_name", ht.NoDefault, ht.TNonEmptyString,
+ "Instance name")
+
+#: Whether to ignore offline nodes
+_PIgnoreOfflineNodes = ("ignore_offline_nodes", False, ht.TBool,
+ "Whether to ignore offline nodes")
+
+#: a required node name (for single-node LUs)
+_PNodeName = ("node_name", ht.NoDefault, ht.TNonEmptyString, "Node name")
+
+#: a required node group name (for single-group LUs)
+_PGroupName = ("group_name", ht.NoDefault, ht.TNonEmptyString, "Group name")
+
+#: Migration type (live/non-live)
+_PMigrationMode = ("mode", None,
+ ht.TOr(ht.TNone, ht.TElemOf(constants.HT_MIGRATION_MODES)),
+ "Migration mode")
+
+#: Obsolete 'live' migration mode (boolean)
+_PMigrationLive = ("live", None, ht.TMaybeBool,
+ "Legacy setting for live migration, do not use")
+
+#: Tag type
+_PTagKind = ("kind", ht.NoDefault, ht.TElemOf(constants.VALID_TAG_TYPES), None)
+
+#: List of tag strings
+_PTags = ("tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString), None)
+
+_PForceVariant = ("force_variant", False, ht.TBool,
+ "Whether to force an unknown OS variant")
+
+_PWaitForSync = ("wait_for_sync", True, ht.TBool,
+ "Whether to wait for the disk to synchronize")
+
+_PIgnoreConsistency = ("ignore_consistency", False, ht.TBool,
+ "Whether to ignore disk consistency")
+
+_PStorageName = ("name", ht.NoDefault, ht.TMaybeString, "Storage name")
+
+_PUseLocking = ("use_locking", False, ht.TBool,
+ "Whether to use synchronization")
+
+_PNameCheck = ("name_check", True, ht.TBool, "Whether to check name")
+
+_PNodeGroupAllocPolicy = \
+ ("alloc_policy", None,
+ ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES)),
+ "Instance allocation policy")
+
+_PGroupNodeParams = ("ndparams", None, ht.TMaybeDict,
+ "Default node parameters for group")
+
+_PIpCheckDoc = "Whether to ensure instance's IP address is inactive"
+
+#: OP_ID conversion regular expression
+_OPID_RE = re.compile("([a-z])([A-Z])")
+
+#: Utility function for L{OpClusterSetParams}
+_TestClusterOsList = ht.TOr(ht.TNone,
+ ht.TListOf(ht.TAnd(ht.TList, ht.TIsLength(2),
+ ht.TMap(ht.WithDesc("GetFirstItem")(operator.itemgetter(0)),
+ ht.TElemOf(constants.DDMS_VALUES)))))
+
+
+# TODO: Generate check from constants.INIC_PARAMS_TYPES
+#: Utility function for testing NIC definitions
+_TestNicDef = ht.TDictOf(ht.TElemOf(constants.INIC_PARAMS),
+ ht.TOr(ht.TNone, ht.TNonEmptyString))
+
+
+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.
+
+ While it doesn't really fit into this module, L{utils} was deemed too large
+ of a dependency to be imported for just one or two functions.
+
+ @raise errors.OpPrereqError: when file storage is disabled
+
+ """
+ if not constants.ENABLE_FILE_STORAGE:
+ raise errors.OpPrereqError("File storage disabled at configure time",
+ errors.ECODE_INVAL)
+
+
+@ht.WithDesc("CheckFileStorage")
+def _CheckFileStorage(value):
+ """Ensures file storage is enabled if used.
+
+ """
+ if value == constants.DT_FILE:
+ RequireFileStorage()
+ return True
+
+
+_CheckDiskTemplate = ht.TAnd(ht.TElemOf(constants.DISK_TEMPLATES),
+ _CheckFileStorage)
+
+
+def _CheckStorageType(storage_type):
+ """Ensure a given storage type is valid.
+
+ """
+ if storage_type not in constants.VALID_STORAGE_TYPES:
+ raise errors.OpPrereqError("Unknown storage type: %s" % storage_type,
+ errors.ECODE_INVAL)
+ if storage_type == constants.ST_FILE:
+ RequireFileStorage()
+ return True
+
+
+#: Storage type parameter
+_PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType,
+ "Storage type")
+
+
+class _AutoOpParamSlots(type):
+ """Meta class for opcode definitions.
+
+ """
+ def __new__(mcs, name, bases, attrs):
+ """Called when a class should be created.
+
+ @param mcs: The meta class
+ @param name: Name of created class
+ @param bases: Base classes
+ @type attrs: dict
+ @param attrs: Class attributes
+
+ """
+ assert "__slots__" not in attrs, \
+ "Class '%s' defines __slots__ when it should use OP_PARAMS" % 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", [])
+
+ # Use parameter names as slots
+ slots = [pname for (pname, _, _, _) in params]
+
+ assert "OP_DSC_FIELD" not in attrs or attrs["OP_DSC_FIELD"] in slots, \
+ "Class '%s' uses unknown field in OP_DSC_FIELD" % name
+
+ attrs["__slots__"] = slots
+
+ return type.__new__(mcs, name, bases, attrs)
+
projects / ganeti-local / blobdiff