Ockle’s Network Tree Data Structure

The Whole Network Tree

Ockle’s main data structure is a acyclic graph implemented by pygraph, that lives in an instance of networkTree/ServerNetwork.py . This graph holds ServerNodes instances, each one represents a server.

You can build a server network from Ockle’s ini files using the Sever Network Generator

class networkTree.ServerNetwork.ServerNetwork

The class that handles the graph server network

addDependency(server, dependency)

Add a dependency to a server

Parameters:

• server – the name of the server
• dependency – the name of the server the former is dependent on

Raises DependencyException:  

Will raise an exception if there was a cycle in the server network

addServer(node, dependencies=[])

Add a server to the network

Parameters:

• node – a server in the network
• dependencies – list of the server names this sever is dependent on

allOff()

Turn all servers off ungracefully

getDependencies(server)

Get a list of servers a given server is dependent on (only one level)

Parameters:server – the server name

getDependent(server)

Get a list of servers that are dependent on this server

Parameters:server – the server name

getRoot()

Gets the root server of the tree

Returns:the root server

getServer(serverNameSearch)

Get a server by name

Parameters:serverNameSearch – The server to search for Returns:The server class, None if not found

getServernode(serverName)

Get a server node by name

Parameters:serverName – The name of the server node Returns:The server node

getSortedNodeList()

returns a list of the nodes topologically sorted

Returns:a list of the nodes topologically sorted

getSortedNodeListIndex()

returns a list of the node names topologically sorted

Returns:a list of the node names topologically sorted

isAllOpState(opState)

Check if all servers are ok

Returns:True if all servers are on

isReadyToTurnOn(server)

Is a server ready to be turned on?

Returns:True if the server is ready to be turned on

removeDependency(server, dependency)

Remove a dependency from a server

Parameters:

• server – the name of the server
• dependency – the name of the server the former is dependent on

turnOffServer(serverName)

Turn a server off by name

Parameters:serverName – The server name

turnOnServer(serverName)

Turn a server on by name

Parameters:serverName – The server name

turningOn()

Returns:true if we have any servers that are in intermediate states

updateNetwork()

Updates the opstate of all the nodes and their outlets/tests and controllers

A Server Node Within the Network

The Server Node object holds the global operation state of the server, and methods to control the server as a whole. Server objects are also stored in this instance. Currently server objects are: Outlets, Controls and Tests.

class networkTree.ServerNode.ServerNode(name, outlets=[], tests=[], controls=[])

This class represents a PC in the network

action(actionString, ignoreDeps=False)

Execute an on/off action on the server

Parameters:

• actionString – Either “on” or “off”
• ignoreDeps – True if you want to ignore other server dependencies

controlsStillStarting()

Return true if any control is still on SwitcingOn OpState

getControlsDataDict()

Get the data dict of all the controls

Returns:the controls data dict

getFailedTests()

return a list of failed tests

getNotControlsOpState(opState)

Returns controls that don’t have a given opState

Parameters:opState – Returns:controls that don’t have a given state

getNotOutletsOpState(opState)

Returns outlets that don’t have a given opState

Parameters:opState – Returns:outlets that don’t have a given state

getOutlet(number)

Get an outlet from the outlet list

:param number outlet number in the list :return: an outlet type that is in the given place

getOutlets()

Get a list of outlet numbers @return: a list of outlets

getOutletsDataDict()

Returns a dict that holds all the outlets and their data dict. This gets sent to the logger

Returns:A dict with each outlet name, and a dict of its data

getShutdownAttempts()

Get number of shutdown attempts

Returns:Number of shutdown attempts

getStartAttempts()

Get number of startup attempts

Returns:Number of startup attempts

incrementShutdownAttempt()

Increment the stop attempt counter

Returns:Number of shutdown attempts

incrementStartAttempt()

Increment the startup attempt counter

Returns:Number of startup attempts

outletsStillStarting()

Return true if any outlet is still on SwitcingOn OpState

setControlOpState(opState)

Set all the controls to a given opState

Parameters:opState – The opState to set the control to

setName(name)

Set the name of the Server :param name: The name ot be set

setOpState(state)

Set the operating state of the server

setOutletsOpState(opState)

Set all the outlets to a given opState

Parameters:opState – The opState to set the outlets to

setOutletsState(state)

Sets the outlets all to a given state by force

Parameters:state – set the outlets to state (boolean) Returns:A list of outlets the failed (note: you can check with “if not” to see if there was no failure

setState(state)

Set server state

Parameters:state – server state type

turnOn(ignoreDeps=False)

Turn on the server outlets, and check if all services are in order

Parameters:ignoreDeps – True if you want to ignore other server dependencies

updateOpState(runTests=True)

Update all the OpStates and run all tests of the server

Related Topics

• Sever Network Generator
• Operation States (OpStates)
  • Server/Outlet/control OpStates
  • Test OpStates