eva-shell 0.2.20__tar.gz → 0.2.22__tar.gz

{eva-shell-0.2.20 → eva-shell-0.2.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eva-shell
-Version: 0.2.20
+Version: 0.2.22
 Summary: EVA ICS v4 shell
 Home-page: https://github.com/eva-ics/eva4
 Author: Bohemia Automation / Altertech

{eva-shell-0.2.20 → eva-shell-0.2.22}/eva4_shell/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '0.2.20'
+__version__ = '0.2.22'
 
 DEFAULT_REPOSITORY_URL = 'https://pub.bma.ai/eva4'

{eva-shell-0.2.20 → eva-shell-0.2.22}/eva4_shell/ap.py

@@ -17,7 +17,24 @@ from .compl import ComplOIDtp, ComplSvcRpcMethod, ComplSvcRpcParams, ComplEdit
 from .client import call_rpc, DEFAULT_DB_SERVICE, DEFAULT_REPL_SERVICE
 from .client import DEFAULT_ACL_SERVICE, DEFAULT_AUTH_SERVICE
 from .client import DEFAULT_KIOSK_SERVICE, DEFAULT_GENERATOR_SERVICE
-from .client import DEFAULT_ACCOUNTING_SERVICE
+from .client import DEFAULT_ACCOUNTING_SERVICE, DEFAULT_ALARM_SERVICE
+
+ALARM_OP_CODES = [
+    'TT', 'TL', 'LL', 'SS', 'SD', 'OS', 'CC', 'AA', 'US', 'RD', 'IS'
+]
+
+ALARM_OP_SOURCE_KINDS = ['U', 'R', 'P']
+
+ALARM_CURRENT_CODES = [
+    'TT',
+    'TL',
+    'LL',
+    'SS',
+    'SD',
+    'OS',
+    'CC',
+    'AA',
+]
 
 DEFAULT_RPC_ERROR_MESSAGE = {
     -32700: 'parse error',
@@ -233,6 +250,160 @@ def append_accounting_cli(root_sp):
     p.add_argument('--err', metavar='ERR')
 
 
+def append_alarm_cli(root_sp):
+    ap = root_sp.add_parser('alarm', help='alarm commands')
+    sp = ap.add_subparsers(dest='_subc', help='sub command')
+
+    p = sp.add_parser('summary', help='alarm summary')
+    p.add_argument('-a',
+                   '--alarm-svc',
+                   help=f'Alarm service (default: {DEFAULT_ALARM_SERVICE})',
+                   default=DEFAULT_ALARM_SERVICE).completer = ComplSvc('alarm')
+
+    p = sp.add_parser('state', help='alarm state')
+    p.add_argument('--node', metavar='NODE', help='filter by node')
+    p.add_argument('--group', metavar='GROUP', help='filter by group')
+    p.add_argument('--level', metavar='LEVEL', help='filter by level')
+    p.add_argument('--id', metavar='ID', help='filter by ID')
+    p.add_argument('--current',
+                   choices=ALARM_CURRENT_CODES,
+                   metavar='CURRENT',
+                   help='filter by current status')
+    p.add_argument('--active', action='store_true', help='active only')
+    p.add_argument('--inactive', action='store_true', help='inactive only')
+    p.add_argument('--user', help='view user subscriptions')
+    p.add_argument('-a',
+                   '--alarm-svc',
+                   help=f'Alarm service (default: {DEFAULT_ALARM_SERVICE})',
+                   default=DEFAULT_ALARM_SERVICE).completer = ComplSvc('alarm')
+
+    p = sp.add_parser('history', help='alarm history')
+    p.add_argument('-y', '--full', action='store_true')
+    p.add_argument('-s', '--time-start', metavar='TIME', help='start time')
+    p.add_argument('-e', '--time-end', metavar='TIME', help='end time')
+    p.add_argument('-z',
+                   '--time-zone',
+                   metavar='ZONE',
+                   help='time zone (pytz, e.g. UTC or Europe/Prague)')
+    p.add_argument('--node', metavar='NODE').completer = ComplNode()
+    p.add_argument('--level-min', metavar='LEVEL', type=int)
+    p.add_argument('--level-max', metavar='LEVEL', type=int)
+    p.add_argument('--group', metavar='GROUP')
+    p.add_argument('--id', metavar='ID')
+    p.add_argument('--ack', action='store_true')
+    p.add_argument('--no-ack', action='store_true')
+    p.add_argument('--latch', action='store_true')
+    p.add_argument('--no-latch', action='store_true')
+    p.add_argument('--oos', action='store_true')
+    p.add_argument('--no-oos', action='store_true')
+    p.add_argument('--sbd', action='store_true')
+    p.add_argument('--no-sbd', action='store_true')
+    p.add_argument('--shelv', action='store_true')
+    p.add_argument('--no-shelv', action='store_true')
+    p.add_argument('--trig', action='store_true')
+    p.add_argument('--no-trig', action='store_true')
+    p.add_argument('--lo', choices=ALARM_OP_CODES, help='last operation')
+    p.add_argument('--losk',
+                   choices=ALARM_OP_SOURCE_KINDS,
+                   help='last operation source kind')
+    p.add_argument('--los', help='last operation source')
+
+    p.add_argument('-a',
+                   '--alarm-svc',
+                   help=f'Alarm service (default: {DEFAULT_ALARM_SERVICE})',
+                   default=DEFAULT_ALARM_SERVICE).completer = ComplSvc('alarm')
+
+    p = sp.add_parser('list', help='list managed alarms')
+    p.add_argument('--group', metavar='GROUP', help='filter by group')
+    p.add_argument('--level', metavar='LEVEL', help='filter by level')
+    p.add_argument('--id', metavar='ID', help='filter by ID')
+    p.add_argument('-a',
+                   '--alarm-svc',
+                   help=f'Alarm service (default: {DEFAULT_ALARM_SERVICE})',
+                   default=DEFAULT_ALARM_SERVICE).completer = ComplSvc('alarm')
+
+    p = sp.add_parser('edit', help='edit a managed alarm')
+    p.add_argument('i', metavar='OID').completer = ComplOIDtp('lvar')
+    p.add_argument('-a',
+                   '--alarm-svc',
+                   help=f'Alarm service (default: {DEFAULT_ALARM_SERVICE})',
+                   default=DEFAULT_ALARM_SERVICE).completer = ComplSvc('alarm')
+
+    p = sp.add_parser('create', help='create a new managed alarm')
+    p.add_argument('level', type=int, metavar='LEVEL')
+    p.add_argument('full_id', metavar='GROUP/ID')
+    p.add_argument('-a',
+                   '--alarm-svc',
+                   help=f'Alarm service (default: {DEFAULT_ALARM_SERVICE})',
+                   default=DEFAULT_ALARM_SERVICE).completer = ComplSvc('alarm')
+
+    p = sp.add_parser('destroy', help='destroy a managed alarm')
+    p.add_argument('i', metavar='OID').completer = ComplOIDtp('lvar')
+    p.add_argument('-a',
+                   '--alarm-svc',
+                   help=f'Alarm service (default: {DEFAULT_ALARM_SERVICE})',
+                   default=DEFAULT_ALARM_SERVICE).completer = ComplSvc('alarm')
+
+    p = sp.add_parser('acknowledge', help='acknowledge alarm')
+    p.add_argument('i', metavar='OID').completer = ComplOIDtp('lvar')
+    p.add_argument(
+        '-w',
+        '--wait',
+        metavar='SEC',
+        type=float,
+        help='wait max seconds until the action is completed (default: timeout)'
+    )
+
+    p = sp.add_parser('shelve', help='shelve alarm')
+    p.add_argument('i', metavar='OID').completer = ComplOIDtp('lvar')
+    p.add_argument(
+        '-w',
+        '--wait',
+        metavar='SEC',
+        type=float,
+        help='wait max seconds until the action is completed (default: timeout)'
+    )
+
+    p = sp.add_parser('unshelve', help='unshelve alarm')
+    p.add_argument('i', metavar='OID').completer = ComplOIDtp('lvar')
+    p.add_argument(
+        '-w',
+        '--wait',
+        metavar='SEC',
+        type=float,
+        help='wait max seconds until the action is completed (default: timeout)'
+    )
+
+    p = sp.add_parser('deploy',
+                      help='deploy managed alarm(s) from a deployment file')
+    p.add_argument('-f', '--file', metavar='FILE',
+                   help='deployment file').completer = ComplDeployFile()
+    p.add_argument('-a',
+                   '--alarm-svc',
+                   help=f'Alarm service (default: {DEFAULT_ALARM_SERVICE})',
+                   default=DEFAULT_ALARM_SERVICE).completer = ComplSvc('alarm')
+
+    p = sp.add_parser('undeploy',
+                      help='undeploy managed alarm(s) using a deployment file')
+    p.add_argument('-f', '--file', metavar='FILE',
+                   help='deployment file').completer = ComplDeployFile()
+    p.add_argument('-a',
+                   '--alarm-svc',
+                   help=f'Alarm service (default: {DEFAULT_ALARM_SERVICE})',
+                   default=DEFAULT_ALARM_SERVICE).completer = ComplSvc('alarm')
+
+    p = sp.add_parser('export', help='export managed alarms')
+    p.add_argument('--group', metavar='GROUP', help='filter by group')
+    p.add_argument('--level', metavar='LEVEL', help='filter by level')
+    p.add_argument('--id', metavar='ID', help='filter by ID')
+    p.add_argument('-o', '--output', metavar='FILE',
+                   help='output file').completer = ComplDeployFile()
+    p.add_argument('-a',
+                   '--alarm-svc',
+                   help=f'Alarm service (default: {DEFAULT_ALARM_SERVICE})',
+                   default=DEFAULT_ALARM_SERVICE).completer = ComplSvc('alarm')
+
+
 def append_dobj_cli(root_sp):
     ap = root_sp.add_parser('dobj', help='data object commands')
     sp = ap.add_subparsers(dest='_subc', help='sub command')
@@ -941,6 +1112,9 @@ def append_cloud_cli(root_sp):
     p.add_argument('--test',
                    action='store_true',
                    help=f'test deployment config and exit')
+    p.add_argument('--verbose-extra',
+                   action='store_true',
+                   help=f'output extra bus call parameters and results')
 
     p = sp.add_parser('undeploy', help='cloud undeploy')
     p.add_argument('file', metavar='FILE',
@@ -957,6 +1131,9 @@ def append_cloud_cli(root_sp):
     p.add_argument('--test',
                    action='store_true',
                    help=f'test deployment config and exit')
+    p.add_argument('--verbose-extra',
+                   action='store_true',
+                   help=f'output extra bus call parameters and results')
 
     p = sp.add_parser('update', help='update cloud nodes')
     p.add_argument('nodes',
@@ -1370,22 +1547,27 @@ def init_ap():
 
     ap.sections = {
         'action': [],
+        'acl': [],
         'accounting': [],
+        'alarm': [],
         'broker': [],
+        'cloud': [],
         'item': [],
-        'lvar': [],
+        'dobj': [],
+        'generator': [],
+        'key': [],
+        'kiosk': [],
         'log': [],
-        'svc': [],
+        'lvar': [],
+        'mirror': [],
+        'node': [],
         'server': [],
+        'spoint': [],
+        'system': [],
         'registry': [],
-        'node': [],
-        'cloud': [],
-        'venv': [],
-        'acl': [],
-        'key': [],
+        'svc': [],
         'user': [],
-        'system': [],
-        'mirror': []
+        'venv': [],
     }
 
     ap.add_argument('-D',
@@ -1404,28 +1586,29 @@ def init_ap():
     append_action_cli(sp)
     append_acl_cli(sp)
     append_accounting_cli(sp)
+    append_alarm_cli(sp)
     append_broker_cli(sp)
+    append_cloud_cli(sp)
     append_item_cli(sp)
     append_dobj_cli(sp)
+    append_generator_cli(sp)
     append_key_cli(sp)
-    append_lvar_cli(sp)
+    append_kiosk_cli(sp)
     append_log_cli(sp)
+    append_lvar_cli(sp)
+    if is_local_shell():
+        append_mirror_cli(sp)
     append_node_cli(sp)
+    if is_local_shell():
+        append_server_cli(sp)
     append_spoint_cli(sp)
     if is_local_shell():
-        append_registry_cli(sp)
+        append_system_cli(sp)
     if is_local_shell():
-        append_server_cli(sp)
+        append_registry_cli(sp)
     append_user_cli(sp)
     if is_local_shell():
         append_venv_cli(sp)
-    append_cloud_cli(sp)
-    append_generator_cli(sp)
-    if is_local_shell():
-        append_system_cli(sp)
-    if is_local_shell():
-        append_mirror_cli(sp)
-    append_kiosk_cli(sp)
 
     sp.add_parser('save', help='save scheduled states (if instant-save is off)')
     append_svc_cli(sp)

{eva-shell-0.2.20 → eva-shell-0.2.22}/eva4_shell/cli.py

@@ -109,7 +109,7 @@ class CLI:
     def server_status(self):
         eva_control_c('status')
 
-    def cloud_deploy(self, file, config_var, config, test):
+    def cloud_deploy(self, file, config_var, config, test, verbose_extra):
         args = ''
         if current_command.debug:
             args += ' --verbose '
@@ -122,9 +122,11 @@ class CLI:
             args += f' --config "{config}"'
         if test:
             args += ' --test'
+        if verbose_extra:
+            args += ' --verbose-extra'
         exec_cmd('eva-cloud-manager', args)
 
-    def cloud_undeploy(self, file, config_var, config, test):
+    def cloud_undeploy(self, file, config_var, config, test, verbose_extra):
         args = ''
         if current_command.debug:
             args += ' --verbose '
@@ -137,6 +139,8 @@ class CLI:
             args += f' --config "{config}"'
         if test:
             args += ' --test'
+        if verbose_extra:
+            args += ' --verbose-extra'
         exec_cmd('eva-cloud-manager', args)
 
     def cloud_update(self, nodes, check_timeout, all, info_only, yes):
@@ -785,7 +789,28 @@ class CLI:
         else:
             print_action_result(result)
 
-    def action_run(self, i, arg, kwarg, priority, wait):
+    def alarm_shelve(self, i, wait=None):
+        self.alarm_control_command(i, 'SS', wait=wait)
+
+    def alarm_unshelve(self, i, wait=None):
+        self.alarm_control_command(i, 'US', wait=wait)
+
+    def alarm_acknowledge(self, i, wait=None):
+        self.alarm_control_command(i, 'AA', wait=wait)
+
+    def alarm_control_command(self, i, cmd, wait=None):
+        if wait is None:
+            wait = current_command.timeout
+        try:
+            lmacro_oid = 'lmacro:' + i.rsplit('/', maxsplit=3)[0].split(
+                ':', maxsplit=1)[-1] + '/control'
+        except:
+            raise RuntimeError('invalid alarm OID')
+        self.action_run(lmacro_oid, [],
+                        [f'i={i}', f'cmd={cmd}', 'sk=U', 'src=console'],
+                        wait=wait)
+
+    def action_run(self, i, arg, kwarg, priority=None, wait=None):
         params = dict(i=i, wait=wait)
         if priority is not None:
             params['priority'] = int(priority)
@@ -1834,3 +1859,214 @@ class CLI:
     def generator_source_destroy(self, i, generator_svc):
         call_rpc('source.destroy', dict(i=i), target=generator_svc)
         ok()
+
+    def alarm_create(self, level, full_id, alarm_svc):
+        if '/' not in full_id:
+            raise ValueError('alarm full ID must contain GROUP/ID')
+        group, id = full_id.rsplit('/', 1)
+        call_rpc('alarm.deploy',
+                 dict(alarms=[dict(level=level, group=group, id=id)]),
+                 target=alarm_svc)
+        ok()
+
+    def alarm_deploy(self, alarm_svc, file=None):
+        import yaml
+        alarms = yaml.safe_load(read_file(file).decode()).pop('alarms')
+        call_rpc('alarm.deploy', dict(alarms=alarms), target=alarm_svc)
+        print(f'{len(alarms)} alarm(s) deployed')
+        print()
+
+    def alarm_undeploy(self, alarm_svc, file=None):
+        import yaml
+        alarms = yaml.safe_load(read_file(file).decode()).pop('alarms')
+        call_rpc('alarm.undeploy', dict(alarms=alarms), target=alarm_svc)
+        print(f'{len(alarms)} alarm(s) undeployed')
+        print()
+
+    def alarm_list(self, alarm_svc, level=None, group=None, id=None):
+        flt = {}
+        if level:
+            flt['level'] = level
+        if group:
+            flt['group'] = group
+        if id:
+            flt['id'] = id
+        data = call_rpc('alarm.list', flt, target=alarm_svc)
+        print_result(data, cols=['oid', 'level', 'group', 'id'])
+
+    def alarm_state(self,
+                    alarm_svc,
+                    node=None,
+                    level=None,
+                    group=None,
+                    id=None,
+                    current=None,
+                    active=None,
+                    inactive=None,
+                    user=None):
+        flt = {}
+        if node:
+            flt['node'] = node
+        if level is not None:
+            flt['level'] = level
+        if group:
+            flt['group'] = group
+        if id:
+            flt['id'] = id
+        if current:
+            flt['current'] = current
+        if active:
+            flt['active'] = True
+        if inactive:
+            flt['active'] = False
+        if user:
+            flt['u'] = user
+        data = call_rpc('alarm.state', flt, target=alarm_svc)
+        if current_command.json:
+            print_result(data)
+        else:
+            cols = ['oid', 'node', 'level', 'group', 'id', 'current']
+            if user:
+                cols += ['subscriptions']
+                for d in data:
+                    d['subscriptions'] = ''
+                    if d['subscribed_email']:
+                        d['subscriptions'] += 'M:' + ','.join(
+                            d['subscribed_email'])
+            print_result(data, cols=cols)
+
+    def alarm_summary(self, alarm_svc):
+        data = call_rpc('alarm.summary', target=alarm_svc)
+        if current_command.json:
+            print_result(data)
+        else:
+            res = []
+            for node, active in data['active_by_node'].items():
+                res.append({'node': node, 'active': active})
+            res.sort(key=lambda x: x['node'])
+            print_result(res)
+            print('total active:', data['active'])
+
+    def alarm_destroy(self, i, alarm_svc):
+        call_rpc('alarm.destroy', dict(i=i), target=alarm_svc)
+        ok()
+
+    def alarm_edit(self, i, alarm_svc):
+
+        def deploy_edited_alarm(cfg, i, alarm_svc):
+            call_rpc('alarm.deploy', dict(alarms=[cfg]), target=alarm_svc)
+            print(f'alarms re-deployed: {i}')
+            print()
+
+        config = call_rpc('alarm.get_config', dict(i=i), target=alarm_svc)
+        edit_config(config,
+                    f'alarm|{i}|config',
+                    deploy_fn=partial(deploy_edited_alarm,
+                                      i=i,
+                                      alarm_svc=alarm_svc))
+
+    def alarm_export(self,
+                     alarm_svc,
+                     level=None,
+                     group=None,
+                     id=None,
+                     output=None):
+        c = 0
+        configs = []
+        flt = {}
+        if level:
+            flt['level'] = level
+        if group:
+            flt['group'] = group
+        if id:
+            flt['id'] = id
+        for alarm in call_rpc('alarm.list', flt, target=alarm_svc):
+            config = call_rpc('alarm.get_config',
+                              dict(i=alarm['oid']),
+                              target=alarm_svc)
+            configs.append(config)
+            c += 1
+        result = dict(alarms=configs)
+        if current_command.json:
+            print_result(result)
+        else:
+            import yaml
+            dump = yaml.dump(result, default_flow_style=False)
+            if output is None:
+                print(dump)
+            else:
+                write_file(output, dump)
+                print(f'{c} alarm(s) exported')
+                print()
+
+    def alarm_history(self, alarm_svc, time_start, time_end, time_zone, node,
+                      level_min, level_max, group, id, ack, no_ack, latch,
+                      no_latch, oos, no_oos, sbd, no_sbd, shelv, no_shelv, trig,
+                      no_trig, lo, losk, los, full):
+        payload = {}
+        if time_start is not None:
+            payload['t_start'] = time_start
+        if time_end is not None:
+            payload['t_end'] = time_end
+        if node is not None:
+            payload['node'] = node
+        if level_min is not None:
+            payload['level_min'] = level_min
+        if level_max is not None:
+            payload['level_max'] = level_max
+        if group is not None:
+            payload['group'] = group
+        if id is not None:
+            payload['id'] = id
+        if ack:
+            payload['ack'] = True
+        if no_ack:
+            payload['ack'] = False
+        if latch:
+            payload['latch'] = True
+        if no_latch:
+            payload['latch'] = False
+        if oos:
+            payload['oos'] = True
+        if no_oos:
+            payload['oos'] = False
+        if sbd:
+            payload['sbd'] = True
+        if no_sbd:
+            payload['sbd'] = False
+        if shelv:
+            payload['shelv'] = True
+        if no_shelv:
+            payload['shelv'] = False
+        if trig:
+            payload['trig'] = True
+        if no_trig:
+            payload['trig'] = False
+        if lo:
+            payload['lo'] = lo
+        if losk:
+            payload['losk'] = losk
+        if los:
+            payload['los'] = los
+        data = call_rpc('alarm.history', payload, target=alarm_svc)
+        cols = [
+            't|n=time|f=time_sec{}'.format(
+                f':{time_zone}' if time_zone else ''),
+            'alarm_node|n=node',
+            'alarm_level|n=lvl',
+            'alarm_group|n=group',
+            'alarm_id|n=id',
+            'lo',
+            'losk',
+            'los',
+        ]
+        if full:
+            cols += [
+                'ack',
+                'latch',
+                'oos',
+                'sbd',
+                'shelv',
+                'trig',
+            ]
+        print_result(data, cols=cols)

{eva-shell-0.2.20 → eva-shell-0.2.22}/eva4_shell/client.py

@@ -17,7 +17,7 @@ DEFAULT_AUTH_SERVICE = 'eva.aaa.localauth'
 DEFAULT_KIOSK_SERVICE = 'eva.kioskman.default'
 DEFAULT_GENERATOR_SERVICE = 'eva.generator.default'
 DEFAULT_ACCOUNTING_SERVICE = 'eva.aaa.accounting'
-
+DEFAULT_ALARM_SERVICE = 'eva.alarm.default'
 
 def print_trace_msg(msg):
     level = msg['l']

{eva-shell-0.2.20 → eva-shell-0.2.22}/eva4_shell/compl.py

@@ -59,6 +59,7 @@ class ComplSvc:
             if self.prefix is None or i.startswith(self.prefix):
                 yield i
 
+
 class ComplDobj:
 
     def __init__(self):
@@ -70,6 +71,7 @@ class ComplDobj:
             if self.prefix is None or i.startswith(self.prefix):
                 yield i
 
+
 class ComplSvcRpcMethod:
 
     def __call__(self, prefix, parsed_args=None, **kwargs):
@@ -127,6 +129,9 @@ class ComplDeployFile:
         else:
             prefix = expand_user(prefix)
             masks = [f'{prefix}*.yml', f'{prefix}*.yaml', f'{prefix}*.json']
+            if '.' in prefix:
+                p = prefix.rsplit('.', 1)[0]
+                masks += [f'{p}*.yml', f'{p}*.yaml', f'{p}*.json']
         for mask in masks:
             for f in glob.glob(mask):
                 yield contract_user(f)

{eva-shell-0.2.20 → eva-shell-0.2.22}/eva_shell.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eva-shell
-Version: 0.2.20
+Version: 0.2.22
 Summary: EVA ICS v4 shell
 Home-page: https://github.com/eva-ics/eva4
 Author: Bohemia Automation / Altertech

{eva-shell-0.2.20 → eva-shell-0.2.22}/setup.py

@@ -1,4 +1,4 @@
-__version__ = '0.2.20'
+__version__ = '0.2.22'
 
 import setuptools