Package ganeti :: Module cmdlib :: Class LUTestJobqueue
[hide private]
[frames] | no frames]

Class LUTestJobqueue

source code


Utility LU to test some aspects of the job queue.

Instance Methods [hide private]
 
_SendNotification(self, test, arg, sockname)
Sends a notification to the client.
source code
 
_Notify(self, prereq, test, arg)
Notifies the client of a test.
source code
 
CheckArguments(self)
Check syntactic validity for the opcode arguments.
source code
 
ExpandNames(self)
Expand names for this LU.
source code
 
Exec(self, feedback_fn)
Execute the LU.
source code

Inherited from NoHooksLU: BuildHooksEnv

Inherited from LogicalUnit: CheckPrereq, DeclareLocks, HooksCallBack, __init__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]
 
_NotifyUsingSocket(cls, cb, errcls)
Opens a Unix socket and waits for another program to connect.
source code
Class Variables [hide private]
  _OP_PARAMS = [("notify_waitlock", False, ht.TBool), ("notify_e...
a list of opcode attributes, their defaults values they should get if not already defined, and types they must match
  REQ_BGL = False
  _CLIENT_CONNECT_TIMEOUT = 20.0
  _CLIENT_CONFIRM_TIMEOUT = 60.0

Inherited from NoHooksLU: HPATH, HTYPE

Inherited from LogicalUnit: ssh

Instance Variables [hide private]

Inherited from LogicalUnit: dry_run_result

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

_NotifyUsingSocket(cls, cb, errcls)
Class Method

source code 

Opens a Unix socket and waits for another program to connect.

Parameters:
  • cb (callable) - Callback to send socket name to client
  • errcls (class) - Exception class to use for errors

_SendNotification(self, test, arg, sockname)

source code 

Sends a notification to the client.

Parameters:
  • test (string) - Test name
  • arg - Test argument (depends on test)
  • sockname (string) - Socket path

_Notify(self, prereq, test, arg)

source code 

Notifies the client of a test.

Parameters:
  • prereq (bool) - Whether this is a prereq-phase test
  • test (string) - Test name
  • arg - Test argument (depends on test)

CheckArguments(self)

source code 

Check syntactic validity for the opcode arguments.

This method is for doing a simple syntactic check and ensure validity of opcode parameters, without any cluster-related checks. While the same can be accomplished in ExpandNames and/or CheckPrereq, doing these separate is better because:

  • ExpandNames is left as as purely a lock-related function
  • CheckPrereq is run after we have acquired locks (and possible waited for them)

The function is allowed to change the self.op attribute so that later methods can no longer worry about missing parameters.

Overrides: LogicalUnit.CheckArguments
(inherited documentation)

ExpandNames(self)

source code 

Expand names for this LU.

This method is called before starting to execute the opcode, and it should update all the parameters of the opcode to their canonical form (e.g. a short node name must be fully expanded after this method has successfully completed). This way locking, hooks, logging, ecc. can work correctly.

LUs which implement this method must also populate the self.needed_locks member, as a dict with lock levels as keys, and a list of needed lock names as values. Rules:

  • use an empty dict if you don't need any lock
  • if you don't need any lock at a particular level omit that level
  • don't put anything for the BGL level
  • if you want all locks at a level use locking.ALL_SET as a value

If you need to share locks (rather than acquire them exclusively) at one level you can modify self.share_locks, setting a true value (usually 1) for that level. By default locks are not shared.

This function can also define a list of tasklets, which then will be executed in order instead of the usual LU-level CheckPrereq and Exec functions, if those are not defined by the LU.

Examples:

 # Acquire all nodes and one instance
 self.needed_locks = {
   locking.LEVEL_NODE: locking.ALL_SET,
   locking.LEVEL_INSTANCE: ['instance1.example.com'],
 }
 # Acquire just two nodes
 self.needed_locks = {
   locking.LEVEL_NODE: ['node1.example.com', 'node2.example.com'],
 }
 # Acquire no locks
 self.needed_locks = {} # No, you can't leave it to the default value None
Overrides: LogicalUnit.ExpandNames
(inherited documentation)

Exec(self, feedback_fn)

source code 

Execute the LU.

This method should implement the actual work. It should raise errors.OpExecError for failures that are somewhat dealt with in code, or expected.

Overrides: LogicalUnit.Exec
(inherited documentation)

Class Variable Details [hide private]

_OP_PARAMS

a list of opcode attributes, their defaults values they should get if not already defined, and types they must match
Value:
[("notify_waitlock", False, ht.TBool), ("notify_exec", False, ht.TBool\
), ("log_messages", ht.EmptyList, ht.TListOf(ht.TString)), ("fail", Fa\
lse, ht.TBool),]