serializer.DumpJson: Control indentation by parameter
[ganeti-local] / lib / opcodes.py
index 7203b8a..9065738 100644 (file)
@@ -36,24 +36,127 @@ are two kinds of classes defined:
 # few public methods:
 # pylint: disable-msg=R0903
 
-class OpCode(object):
-  """Abstract OpCode"""
-  OP_ID = "OP_ABSTRACT"
+
+class BaseJO(object):
+  """A simple serializable object.
+
+  This object serves as a parent class for both OpCode and Job since
+  they are serialized in the same way.
+
+  """
   __slots__ = []
 
   def __init__(self, **kwargs):
     for key in kwargs:
       if key not in self.__slots__:
-        raise TypeError("OpCode %s doesn't support the parameter '%s'" %
+        raise TypeError("Object %s doesn't support the parameter '%s'" %
                         (self.__class__.__name__, key))
       setattr(self, key, kwargs[key])
 
+  def __getstate__(self):
+    state = {}
+    for name in self.__slots__:
+      if hasattr(self, name):
+        state[name] = getattr(self, name)
+    return state
+
+  def __setstate__(self, state):
+    if not isinstance(state, dict):
+      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
+                       type(state))
+
+    for name in self.__slots__:
+      if name not in state:
+        delattr(self, name)
+
+    for name in state:
+      setattr(self, name, state[name])
+
+
+class Job(BaseJO):
+  """Job definition structure
+
+  The Job definitions has two sets of parameters:
+    - the parameters of the job itself (all filled by server):
+      - job_id,
+      - status: pending, running, successfull, failed, aborted
+    - opcode parameters:
+      - op_list, list of opcodes, clients creates this
+      - op_status, status for each opcode, server fills in
+      - op_result, result for each opcode, server fills in
+
+  """
+  STATUS_PENDING = 1
+  STATUS_RUNNING = 2
+  STATUS_SUCCESS = 3
+  STATUS_FAIL = 4
+  STATUS_ABORT = 5
+
+  __slots__ = [
+    "job_id",
+    "status",
+    "op_list",
+    "op_status",
+    "op_result",
+    ]
+
+  def __getstate__(self):
+    """Specialized getstate for jobs
+
+    """
+    data = BaseJO.__getstate__(self)
+    if "op_list" in data:
+      data["op_list"] = [op.__getstate__() for op in data["op_list"]]
+    return data
+
+  def __setstate__(self, state):
+    """Specialized setstate for jobs
+
+    """
+    BaseJO.__setstate__(self, state)
+    if "op_list" in state:
+      self.op_list = [OpCode.LoadOpCode(op) for op in state["op_list"]]
+
+
+class OpCode(BaseJO):
+  """Abstract OpCode"""
+  OP_ID = "OP_ABSTRACT"
+  __slots__ = []
 
-class OpInitCluster(OpCode):
-  """Initialise the cluster."""
-  OP_ID = "OP_CLUSTER_INIT"
-  __slots__ = ["cluster_name", "secondary_ip", "hypervisor_type",
-               "vg_name", "mac_prefix", "def_bridge", "master_netdev"]
+  def __getstate__(self):
+    """Specialized getstate for opcodes.
+
+    """
+    data = BaseJO.__getstate__(self)
+    data["OP_ID"] = self.OP_ID
+    return data
+
+  @classmethod
+  def LoadOpCode(cls, data):
+    """Generic load opcode method.
+
+    """
+    if not isinstance(data, dict):
+      raise ValueError("Invalid data to LoadOpCode (%s)" % type(data))
+    if "OP_ID" not in data:
+      raise ValueError("Invalid data to LoadOpcode, missing OP_ID")
+    op_id = data["OP_ID"]
+    op_class = None
+    for item in globals().values():
+      if (isinstance(item, type) and
+          issubclass(item, cls) and
+          hasattr(item, "OP_ID") and
+          getattr(item, "OP_ID") == op_id):
+        op_class = item
+        break
+    if op_class is None:
+      raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
+                       op_id)
+    op = op_class()
+    new_data = data.copy()
+    del new_data["OP_ID"]
+    op.__setstate__(new_data)
+    return op
 
 
 class OpDestroyCluster(OpCode):
@@ -68,22 +171,10 @@ class OpQueryClusterInfo(OpCode):
   __slots__ = []
 
 
-class OpClusterCopyFile(OpCode):
-  """Copy a file to multiple nodes."""
-  OP_ID = "OP_CLUSTER_COPYFILE"
-  __slots__ = ["nodes", "filename"]
-
-
-class OpRunClusterCommand(OpCode):
-  """Run a command on multiple nodes."""
-  OP_ID = "OP_CLUSTER_RUNCOMMAND"
-  __slots__ = ["nodes", "command"]
-
-
 class OpVerifyCluster(OpCode):
   """Verify the cluster state."""
   OP_ID = "OP_CLUSTER_VERIFY"
-  __slots__ = []
+  __slots__ = ["skip_checks"]
 
 
 class OpVerifyDisks(OpCode):
@@ -129,6 +220,12 @@ class OpRenameCluster(OpCode):
   __slots__ = ["name"]
 
 
+class OpSetClusterParams(OpCode):
+  """Change the parameters of the cluster."""
+  OP_ID = "OP_CLUSTER_SET_PARAMS"
+  __slots__ = ["vg_name"]
+
+
 # node opcodes
 
 class OpRemoveNode(OpCode):
@@ -140,7 +237,7 @@ class OpRemoveNode(OpCode):
 class OpAddNode(OpCode):
   """Add a node."""
   OP_ID = "OP_NODE_ADD"
-  __slots__ = ["node_name", "primary_ip", "secondary_ip"]
+  __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd"]
 
 
 class OpQueryNodes(OpCode):
@@ -165,7 +262,10 @@ class OpCreateInstance(OpCode):
     "disk_template", "snode", "swap_size", "mode",
     "vcpus", "ip", "bridge", "src_node", "src_path", "start",
     "wait_for_sync", "ip_check", "mac",
-    "kernel_path", "initrd_path", "hvm_boot_order",
+    "kernel_path", "initrd_path", "hvm_boot_order", "hvm_acpi",
+    "hvm_pae", "hvm_cdrom_image_path", "vnc_bind_address",
+    "file_storage_dir", "file_driver",
+    "iallocator",
     ]
 
 
@@ -201,27 +301,15 @@ class OpShutdownInstance(OpCode):
 
 class OpRebootInstance(OpCode):
   """Reboot an instance."""
-  OP_ID = "OP_INSTANCE_STARTUP"
+  OP_ID = "OP_INSTANCE_REBOOT"
   __slots__ = ["instance_name", "reboot_type", "extra_args",
                "ignore_secondaries" ]
 
 
-class OpAddMDDRBDComponent(OpCode):
-  """Add a MD-DRBD component."""
-  OP_ID = "OP_INSTANCE_ADD_MDDRBD"
-  __slots__ = ["instance_name", "remote_node", "disk_name"]
-
-
-class OpRemoveMDDRBDComponent(OpCode):
-  """Remove a MD-DRBD component."""
-  OP_ID = "OP_INSTANCE_REMOVE_MDDRBD"
-  __slots__ = ["instance_name", "disk_name", "disk_id"]
-
-
 class OpReplaceDisks(OpCode):
   """Replace the disks of an instance."""
   OP_ID = "OP_INSTANCE_REPLACE_DISKS"
-  __slots__ = ["instance_name", "remote_node", "mode", "disks"]
+  __slots__ = ["instance_name", "remote_node", "mode", "disks", "iallocator"]
 
 
 class OpFailoverInstance(OpCode):
@@ -260,20 +348,28 @@ class OpQueryInstanceData(OpCode):
   __slots__ = ["instances"]
 
 
-class OpSetInstanceParms(OpCode):
+class OpSetInstanceParams(OpCode):
   """Change the parameters of an instance."""
-  OP_ID = "OP_INSTANCE_SET_PARMS"
+  OP_ID = "OP_INSTANCE_SET_PARAMS"
   __slots__ = [
     "instance_name", "mem", "vcpus", "ip", "bridge", "mac",
-    "kernel_path", "initrd_path", "hvm_boot_order",
+    "kernel_path", "initrd_path", "hvm_boot_order", "hvm_acpi",
+    "hvm_pae", "hvm_cdrom_image_path", "vnc_bind_address"
     ]
 
 
+class OpGrowDisk(OpCode):
+  """Grow a disk of an instance."""
+  OP_ID = "OP_INSTANCE_GROW_DISK"
+  __slots__ = ["instance_name", "disk", "amount"]
+
+
 # OS opcodes
 class OpDiagnoseOS(OpCode):
   """Compute the list of guest operating systems."""
   OP_ID = "OP_OS_DIAGNOSE"
-  __slots__ = []
+  __slots__ = ["output_fields", "names"]
+
 
 # Exports opcodes
 class OpQueryExports(OpCode):
@@ -281,11 +377,16 @@ class OpQueryExports(OpCode):
   OP_ID = "OP_BACKUP_QUERY"
   __slots__ = ["nodes"]
 
+
 class OpExportInstance(OpCode):
   """Export an instance."""
   OP_ID = "OP_BACKUP_EXPORT"
   __slots__ = ["instance_name", "target_node", "shutdown"]
 
+class OpRemoveExport(OpCode):
+  """Remove an instance's export."""
+  OP_ID = "OP_BACKUP_REMOVE"
+  __slots__ = ["instance_name"]
 
 # Tags opcodes
 class OpGetTags(OpCode):
@@ -336,3 +437,22 @@ class OpTestDelay(OpCode):
   """
   OP_ID = "OP_TEST_DELAY"
   __slots__ = ["duration", "on_master", "on_nodes"]
+
+
+class OpTestAllocator(OpCode):
+  """Allocator framework testing.
+
+  This opcode has two modes:
+    - gather and return allocator input for a given mode (allocate new
+      or replace secondary) and a given instance definition (direction
+      'in')
+    - run a selected allocator for a given operation (as above) and
+      return the allocator output (direction 'out')
+
+  """
+  OP_ID = "OP_TEST_ALLOCATOR"
+  __slots__ = [
+    "direction", "mode", "allocator", "name",
+    "mem_size", "disks", "disk_template",
+    "os", "tags", "nics", "vcpus",
+    ]