class documentation

class LUTestJqueue(NoHooksLU):

View In Hierarchy

Utility LU to test some aspects of the job queue.

Method CheckArguments Check syntactic validity for the opcode arguments.
Method Exec Execute the LU.
Method ExpandNames Expand names for this LU.
Constant REQ_BGL Undocumented
Instance Variable checkargs_calls Undocumented
Instance Variable expandnames_calls Undocumented
Instance Variable needed_locks Undocumented
Class Method _NotifyUsingSocket Opens a Unix socket and waits for another program to connect.
Method _Notify Notifies the client of a test.
Method _SendNotification Sends a notification to the client.
Constant _CLIENT_CONFIRM_TIMEOUT Undocumented
Constant _CLIENT_CONNECT_TIMEOUT Undocumented

Inherited from NoHooksLU:

Method BuildHooksEnv Empty BuildHooksEnv for NoHooksLu.
Method BuildHooksNodes Empty BuildHooksNodes for NoHooksLU.
Method PreparePostHookNodes Empty PreparePostHookNodes for NoHooksLU.
Constant HPATH Undocumented
Constant HTYPE Undocumented

Inherited from LogicalUnit (via NoHooksLU):

Method __init__ Constructor for LogicalUnit.
Method AssertReleasedLocks Raise AssertionError if the LU holds some locks of the given level.
Method CheckPrereq Check prerequisites for this LU.
Method DeclareLocks Declare LU locking needs for a level
Method HooksCallBack Notify the LU about the results of its hooks.
Method owned_locks Return the list of locks owned by the LU at a given level.
Method PrepareRetry Prepare the LU to run again.
Method release_request Return a request to release the specified locks of the given level.
Method WConfdClient Undocumented
Instance Variable add_locks Undocumented
Instance Variable cfg Undocumented
Instance Variable dont_collate_locks Undocumented
Instance Variable dry_run_result the value (if any) that will be returned to the caller in dry-run mode (signalled by opcode dry_run parameter)
Instance Variable Log Undocumented
Instance Variable LogInfo Undocumented
Instance Variable LogStep Undocumented
Instance Variable LogWarning Undocumented
Instance Variable op Undocumented
Instance Variable opportunistic_locks Undocumented
Instance Variable opportunistic_locks_count Undocumented
Instance Variable proc Undocumented
Instance Variable recalculate_locks Undocumented
Instance Variable rpc Undocumented
Instance Variable share_locks Undocumented
Instance Variable tasklets Undocumented
Instance Variable wconfd Undocumented
Instance Variable wconfdcontext Undocumented
Instance Variable wconfdlocks Undocumented
Method _ExpandAndLockInstance Helper function to expand and lock an instance.
Method _LockInstancesNodes Helper function to declare instances' nodes for locking.
def CheckArguments(self):

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.

def Exec(self, feedback_fn):

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.

def ExpandNames(self):

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, etc. 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 (note that in this case DeclareLocks won't be called at all for that level)
  • if you need locks at a level, but you can't calculate it in this function, initialise that level with an empty list and do further processing in LogicalUnit.DeclareLocks (see that function's docstring)
  • 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-uuid', 'node2-uuid'],
  }
  # Acquire no locks
  self.needed_locks = {} # No, you can't leave it to the default value None
REQ_BGL: bool =

Undocumented

Value
False
checkargs_calls =

Undocumented

expandnames_calls: int =

Undocumented

needed_locks =
@classmethod
def _NotifyUsingSocket(cls, cb, errcls):

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

Parameters
cb:callableCallback to send socket name to client
errcls:classException class to use for errors
def _Notify(self, prereq, test, arg):

Notifies the client of a test.

Parameters
prereq:boolWhether this is a prereq-phase test
test:stringTest name
argTest argument (depends on test)
def _SendNotification(self, test, arg, sockname):

Sends a notification to the client.

Parameters
test:stringTest name
argTest argument (depends on test)
sockname:stringSocket path
_CLIENT_CONFIRM_TIMEOUT: float =

Undocumented

Value
60.0
_CLIENT_CONNECT_TIMEOUT: float =

Undocumented

Value
20.0