import synapse.exc as s_exc
import synapse.lib.stormtypes as s_stormtypes
[docs]@s_stormtypes.registry.registerLib
class AhaLib(s_stormtypes.Lib):
'''
A Storm Library for interacting with AHA.
'''
_storm_locals = (
{'name': 'del', 'desc': '''Delete a service from AHA.
Examples:
Deleting a service with its relative name::
$lib.aha.del(00.mysvc...)
Deleting a service with its full name::
$lib.aha.del(00.mysvc.loop.vertex.link)
''',
'type': {'type': 'function', '_funcname': '_methAhaDel',
'args': (
{'name': 'svcname', 'type': 'str',
'desc': 'The name of the service to delete. It is easiest to use the relative name of a service, ending with "...".', },
),
'returns': {'type': 'null'}}},
{'name': 'get', 'desc': '''Get information about an AHA service.
Examples:
Getting service information with a relative name::
$lib.aha.get(00.cortex...)
Getting service information with its full name::
$lib.aha.get(00.cortex.loop.vertex.link)
''',
'type': {'type': 'function', '_funcname': '_methAhaGet',
'args': (
{'name': 'svcname', 'type': 'str',
'desc': 'The name of the AHA service to look up. It is easiest to use the relative name of a service, ending with "...".', },
{'name': 'filters', 'type': 'dict', 'default': None,
'desc': 'An optional dictionary of filters to use when resolving the AHA service.'}
),
'returns': {'type': ('null', 'dict'),
'desc': 'The AHA service information dictionary, or $lib.null.', }}},
{'name': 'list', 'desc': 'Enumerate all of the AHA services.',
'type': {'type': 'function', '_funcname': '_methAhaList', 'args': (),
'returns': {'name': 'Yields', 'type': 'list',
'desc': 'The AHA service dictionaries.', }}},
)
_storm_lib_path = ('aha',)
[docs] def getObjLocals(self):
return {
'del': self._methAhaDel,
'get': self._methAhaGet,
'list': self._methAhaList,
}
@s_stormtypes.stormfunc(readonly=True)
async def _methAhaList(self):
self.runt.reqAdmin()
proxy = await self.runt.snap.core.reqAhaProxy()
async for info in proxy.getAhaSvcs():
yield info
async def _methAhaDel(self, svcname):
self.runt.reqAdmin()
svcname = await s_stormtypes.tostr(svcname)
proxy = await self.runt.snap.core.reqAhaProxy()
svc = await proxy.getAhaSvc(svcname)
if svc is None:
raise s_exc.NoSuchName(mesg=f'No AHA service for {svcname=}')
if svc.get('services'): # It is an AHA Pool!
mesg = f'Cannot use $lib.aha.del() to remove an AHA Pool. Use $lib.aha.pool.del(); {svcname=}'
raise s_exc.BadArg(mesg=mesg)
return await proxy.delAhaSvc(svc.get('svcname'), network=svc.get('svcnetw'))
@s_stormtypes.stormfunc(readonly=True)
async def _methAhaGet(self, svcname, filters=None):
self.runt.reqAdmin()
svcname = await s_stormtypes.tostr(svcname)
filters = await s_stormtypes.toprim(filters)
proxy = await self.runt.snap.core.reqAhaProxy()
return await proxy.getAhaSvc(svcname, filters=filters)
[docs]@s_stormtypes.registry.registerLib
class AhaPoolLib(s_stormtypes.Lib):
'''
A Storm Library for interacting with AHA service pools.
'''
_storm_locals = (
{'name': 'add', 'desc': '''Add a new AHA service pool.
Examples:
Add a pool via its relative name::
$lib.aha.pool.add(pool00.cortex...)
''',
'type': {'type': 'function', '_funcname': '_methPoolAdd',
'args': (
{'name': 'name', 'type': 'str',
'desc': 'The name of the pool to add. It is easiest to use the relative name of a pool, ending with "...".', },
),
'returns': {'type': 'aha:pool'}}},
{'name': 'del', 'desc': '''Delete an existing AHA service pool.
Examples:
Delete a pool via its relative name::
$lib.aha.pool.del(pool00.cortex...)
''',
'type': {'type': 'function', '_funcname': '_methPoolDel',
'args': (
{'name': 'name', 'type': 'str',
'desc': 'The name of the pool to delete. It is easiest to use the relative name of a pool, ending with "...".', },
),
'returns': {'type': 'dict', 'desc': 'The AHA pool definition that was deleted.'}}},
{'name': 'get', 'desc': 'Get an existing AHA service pool.',
'type': {'type': 'function', '_funcname': '_methPoolGet',
'args': (
{'name': 'name', 'type': 'str',
'desc': 'The name of the pool to get. It is easiest to use the relative name of a pool, ending with "...".', },
),
'returns': {'type': ['null', 'aha:pool'], 'desc': 'The pool if it exists, or $lib.null.'}}},
{'name': 'list', 'desc': 'Enumerate all of the AHA service pools.',
'type': {'type': 'function', '_funcname': '_methPoolList',
'returns': {'name': 'yields', 'type': 'aha:pool'}}},
)
_storm_lib_path = ('aha', 'pool')
[docs] def getObjLocals(self):
return {
'add': self._methPoolAdd,
'del': self._methPoolDel,
'get': self._methPoolGet,
'list': self._methPoolList,
}
async def _methPoolAdd(self, name):
self.runt.reqAdmin()
name = await s_stormtypes.tostr(name)
proxy = await self.runt.snap.core.reqAhaProxy()
poolinfo = {'creator': self.runt.user.iden}
poolinfo = await proxy.addAhaPool(name, poolinfo)
return AhaPool(self.runt, poolinfo)
async def _methPoolDel(self, name):
self.runt.reqAdmin()
name = await s_stormtypes.tostr(name)
proxy = await self.runt.snap.core.reqAhaProxy()
return await proxy.delAhaPool(name)
@s_stormtypes.stormfunc(readonly=True)
async def _methPoolGet(self, name):
self.runt.reqAdmin()
name = await s_stormtypes.tostr(name)
proxy = await self.runt.snap.core.reqAhaProxy()
poolinfo = await proxy.getAhaPool(name)
if poolinfo is not None:
return AhaPool(self.runt, poolinfo)
@s_stormtypes.stormfunc(readonly=True)
async def _methPoolList(self):
self.runt.reqAdmin()
proxy = await self.runt.snap.core.reqAhaProxy()
async for poolinfo in proxy.getAhaPools():
yield AhaPool(self.runt, poolinfo)
[docs]@s_stormtypes.registry.registerType
class AhaPool(s_stormtypes.StormType):
'''
Implements the Storm API for an AHA pool.
'''
_storm_locals = (
{'name': 'add', 'desc': '''Add a service to the AHA pool
Examples:
Add a service to a pool with its relative name::
$pool = $lib.aha.pool.get(pool00.cortex...)
$pool.add(00.cortex...)
''',
'type': {'type': 'function', '_funcname': '_methPoolSvcAdd',
'args': (
{'name': 'svcname', 'type': 'str',
'desc': 'The name of the AHA service to add. It is easiest to use the relative name of a service, ending with "...".', },
),
'returns': {'type': 'null', }}},
{'name': 'add', 'desc': '''Remove a service from the AHA pool.
Examples:
Remove a service from a pool with its relative name::
$pool = $lib.aha.pool.get(pool00.cortex...)
$pool.del(00.cortex...)
''',
'type': {'type': 'function', '_funcname': '_methPoolSvcDel',
'args': (
{'name': 'svcname', 'type': 'str',
'desc': 'The name of the AHA service to remove. It is easiest to use the relative name of a service, ending with "...".', },
),
'returns': {'type': 'null', }}},
)
_storm_typename = 'aha:pool'
def __init__(self, runt, poolinfo):
s_stormtypes.StormType.__init__(self)
self.runt = runt
self.poolinfo = poolinfo
self.locls.update({
'add': self._methPoolSvcAdd,
'del': self._methPoolSvcDel,
})
[docs] async def stormrepr(self):
return f'{self._storm_typename}: {self.poolinfo.get("name")}'
async def _derefGet(self, name):
return self.poolinfo.get(name)
async def _methPoolSvcAdd(self, svcname):
self.runt.reqAdmin()
svcname = await s_stormtypes.tostr(svcname)
proxy = await self.runt.snap.core.reqAhaProxy()
poolname = self.poolinfo.get('name')
poolinfo = {'creator': self.runt.user.iden}
poolinfo = await proxy.addAhaPoolSvc(poolname, svcname, poolinfo)
self.poolinfo.update(poolinfo)
async def _methPoolSvcDel(self, svcname):
self.runt.reqAdmin()
svcname = await s_stormtypes.tostr(svcname)
proxy = await self.runt.snap.core.reqAhaProxy()
poolname = self.poolinfo.get('name')
await proxy.delAhaPoolSvc(poolname, svcname)
self.poolinfo = await proxy.getAhaPool(poolname)
stormcmds = (
{
'name': 'aha.pool.list',
'descr': 'Display a list of AHA service pools and their services.',
'storm': '''
$count = (0)
for $pool in $lib.aha.pool.list() {
$count = ($count + 1)
$lib.print(`Pool: {$pool.name}`)
for ($svcname, $svcinfo) in $pool.services {
$lib.print(` {$svcname}`)
}
}
$lib.print(`{$count} pools.`)
''',
},
{
'name': 'aha.pool.add',
'descr': 'Create an AHA service pool configuration.',
'cmdargs': (
('name', {'help': 'The name of the new AHA service pool.'}),
),
'storm': '''
$pool = $lib.aha.pool.add($cmdopts.name)
$lib.print(`Created AHA service pool: {$pool.name}`)
'''
},
{
'name': 'aha.pool.del',
'descr': 'Delete an AHA service pool configuration.',
'cmdargs': (
('name', {'help': 'The name of the AHA pool to delete.'}),
),
'storm': '''
$pool = $lib.aha.pool.del($cmdopts.name)
if $pool { $lib.print(`Removed AHA service pool: {$pool.name}`) }
''',
},
{
'name': 'aha.pool.svc.add',
'descr': '''
Add an AHA service to a service pool.
Examples:
// add 00.cortex... to the existing pool named pool.cortex
aha.pool.svc.add pool.cortex... 00.cortex...
''',
'cmdargs': (
('poolname', {'help': 'The name of the AHA pool.'}),
('svcname', {'help': 'The name of the AHA service.'}),
),
'storm': '''
$pool = $lib.aha.pool.get($cmdopts.poolname)
if (not $pool) { $lib.exit(`No AHA service pool named: {$cmdopts.poolname}`) }
$pool.add($cmdopts.svcname)
$lib.print(`AHA service ({$cmdopts.svcname}) added to service pool ({$pool.name})`)
''',
},
{
'name': 'aha.pool.svc.del',
'descr': 'Remove an AHA service from a service pool.',
'cmdargs': (
('poolname', {'help': 'The name of the AHA pool.'}),
('svcname', {'help': 'The name of the AHA service.'}),
),
'storm': '''
$pool = $lib.aha.pool.get($cmdopts.poolname)
if (not $pool) { $lib.exit(`No AHA service pool named: {$cmdopts.poolname}`) }
$pool.del($cmdopts.svcname)
$lib.print(`AHA service ({$cmdopts.svcname}) removed from service pool ({$pool.name})`)
''',
},
{
'name': 'aha.svc.stat',
'descr': '''Show all information for a specific AHA service.
If the --nexus argument is given, the Cortex will attempt to connect the service and report the Nexus offset of the service.
The ready value indicates that a service has entered into the realtime change window for synchronizing changes from its leader.
''',
'cmdargs': (
('svc', {'help': 'The service to inspect.'}),
('--nexus', {'help': 'Try to connect to online services and report their nexus offset.',
'default': False, 'action': 'store_true'}),
),
'storm': '''
function _getNexus(svcname) {
$_url = `aha://{$svcname}/`
try {
$_prox = $lib.telepath.open($_url)
$_info = $_prox.getCellInfo()
return ( $_info.cell.nexsindx )
} catch * as _err {
$_emsg = $_err.mesg
if ($_emsg = null ) {
$_emsg = `{$_err}`
}
return ( $_emsg )
}
}
$svc = $lib.aha.get($cmdopts.svc)
if ($svc = null) {
$lib.print(`No service found for: "{$cmdopts.svc}"`)
} else {
$services = $svc.services
if $services {
$lib.print(`Resolved {$cmdopts.svc} to an AHA Pool.\n`)
$lib.print(`The pool currently has {$lib.len($services)} members.`)
$lib.print(`AHA Pool: {$svc.name}`)
for ($_svcname, $_svcinfo) in $services {
$lib.print(`Member: {$_svcname}`)
}
} else {
$lib.print(`Resolved {$cmdopts.svc} to an AHA Service.\n`)
$svcinfo = $svc.svcinfo
$leader = $svcinfo.leader
if ($leader = null) {
$leader = 'Service did not register itself with a leader name.'
}
$online = false
if $svcinfo.online {
$online = true
}
$ready = 'null'
if $lib.dict.has($svcinfo, ready) {
$ready = `{$svcinfo.ready}`
}
$lib.print(`Name: {$svc.name}`)
$lib.print(`Online: {$online}`)
$lib.print(`Ready: {$ready}`)
$lib.print(`Run iden: {$svcinfo.run}`)
$lib.print(`Cell iden: {$svcinfo.iden}`)
$lib.print(`Leader: {$leader}`)
if $cmdopts.nexus {
if $svcinfo.online {
$nexusOffset = $_getNexus($svc.name)
} else {
$nexusOffset = 'Service is not online. Will not attempt to retrieve its nexus offset.'
}
$lib.print(`Nexus: {$nexusOffset}`)
}
$lib.print('Connection information:')
$urlinfo = $svcinfo.urlinfo
$keys = $lib.dict.keys($urlinfo)
$keys.sort()
for $k in $keys {
$dk = `{$k}:`
$dk = $dk.ljust(12)
$lib.print(` {$dk}{$urlinfo.$k}`)
}
}
}
'''
},
{
'name': 'aha.svc.list',
'descr': '''List AHA services.
If the --nexus argument is given, the Cortex will attempt to connect to each service and report the Nexus offset of the service.
The ready column indicates that a service has entered into the realtime change window for synchronizing changes from its leader.''',
'cmdargs': (
('--nexus', {'help': 'Try to connect to online services and report their nexus offset.',
'default': False, 'action': 'store_true'}),
),
'storm': '''
function _getNexus(svcname) {
$_url = `aha://{$svcname}/`
try {
$_prox = $lib.telepath.open($_url)
$_info = $_prox.getCellInfo()
return ( $_info.cell.nexsindx )
} catch * as _err {
$_emsg = $_err.mesg
if ($_emsg = null ) {
$_emsg = `{$_err}`
}
return ( $_emsg )
}
}
$svcs = ()
for $svc in $lib.aha.list() {
$svcs.append($svc)
}
if ($lib.len($svcs) = 0) {
$lib.print('No AHA services registered.')
}
else {
$columns = 'Name Leader Online Ready Host Port '
if $cmdopts.nexus {
$columns = `{$columns} Nexus`
}
$leaders = $lib.set()
for $info in $svcs {
$svcinfo = $info.svcinfo
if $svcinfo {
if ($info.svcname = $svcinfo.leader) {
$leaders.add($svcinfo.run)
}
}
}
$lib.print($columns)
for $info in $svcs {
$name = $info.name
$nexusOffset = (null)
$svcinfo = $info.svcinfo
if $cmdopts.nexus {
if $svcinfo.online {
$nexusOffset = $_getNexus($name)
} else {
$nexusOffset = 'Service is not online. Will not attempt to retrieve its nexus offset.'
}
}
$name=$name.ljust(45)
$online = false
if $svcinfo.online {
$online = true
}
$online = $online.ljust(6)
$urlinfo = $svcinfo.urlinfo
$host = $urlinfo.host
$host = $host.ljust(15)
$port = $lib.cast(str, $urlinfo.port) // Cast to str
$port = $port.ljust(5)
$ready = 'null'
if $lib.dict.has($svcinfo, ready) {
$ready = `{$svcinfo.ready}`
}
$ready = $ready.ljust(5)
$leader = null
if ( $svcinfo.leader != null ) {
if $leaders.has($svcinfo.run) {
$leader = true
} else {
$leader = false
}
}
$leader = $leader.ljust(6)
if $info {
$s = `{$name} {$leader} {$online} {$ready} {$host} {$port}`
if ($nexusOffset != null) {
$s = `{$s} {$nexusOffset}`
}
$lib.print($s)
}
}
}
'''
}
)