synapse 2.182.0__tar.gz → 2.183.0__tar.gz

{synapse-2.182.0/synapse.egg-info → synapse-2.183.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: synapse
-Version: 2.182.0
+Version: 2.183.0
 Summary: Synapse Intelligence Analysis Framework
 Author-email: The Vertex Project LLC <root@vertex.link>
 License: Apache License 2.0

{synapse-2.182.0 → synapse-2.183.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = 'setuptools.build_meta'
 
 [project]
 name = 'synapse'
-version = '2.182.0'
+version = '2.183.0'
 authors = [
     { name = 'The Vertex Project LLC', email = 'root@vertex.link'},
 ]

{synapse-2.182.0 → synapse-2.183.0}/synapse/cortex.py

@@ -1453,6 +1453,11 @@ class Cortex(s_oauth.OAuthMixin, s_cell.Cell):  # type: ignore
             {'perm': ('storm', 'macro', 'edit'), 'gate': 'cortex',
              'desc': 'Controls access to edit a storm macro.'},
 
+            {'perm': ('task', 'get'), 'gate': 'cortex',
+             'desc': 'Controls access to view other users tasks.'},
+            {'perm': ('task', 'del'), 'gate': 'cortex',
+             'desc': 'Controls access to terminate other users tasks.'},
+
             {'perm': ('view',), 'gate': 'cortex',
              'desc': 'Controls all view permissions.'},
             {'perm': ('view', 'add'), 'gate': 'cortex',

{synapse-2.182.0 → synapse-2.183.0}/synapse/lib/ast.py

@@ -4517,7 +4517,7 @@ class EditTagAdd(Edit):
         else:
             oper_offset = 0
 
-        excignore = (s_exc.BadTypeValu,) if oper_offset == 1 else ()
+        excignore = (s_exc.BadTypeValu, s_exc.BadTag) if oper_offset == 1 else ()
 
         hasval = len(self.kids) > 2 + oper_offset
 

{synapse-2.182.0 → synapse-2.183.0}/synapse/lib/autodoc.py

@@ -28,6 +28,7 @@ stormtype_doc_schema = {
                          'description': 'For a function argument, the name of the argument.'},
                 'desc': {'type': 'string',
                          'description': 'For a function argument or return value, the description of the value.'},
+                'deprecated': {'$ref': '#/definitions/deprecatedItem'},
                 'type': {'$ref': '#/definitions/stormType'},
                 'args': {
                     'type': 'array',
@@ -46,7 +47,28 @@ stormtype_doc_schema = {
                            'documentation for.',
             'additionalProperties': False,
         },
-
+        'deprecatedItem': {
+            'type': 'object',
+            'properties': {
+                'eolvers': {'type': 'string', 'minLength': 1,
+                            'description': "The version which will not longer support the item."},
+                'eoldate': {'type': 'string', 'minLength': 1,
+                            'description': 'Optional string indicating Synapse releases after this date may no longer support the item.'},
+                'mesg': {'type': ['string', 'null'], 'default': None,
+                         'description': 'Optional message to include in the warning text.'}
+            },
+            'oneOf': [
+                {
+                    'required': ['eolvers'],
+                    'not': {'required': ['eoldate']}
+                },
+                {
+                    'required': ['eoldate'],
+                    'not': {'required': ['eolvers']}
+                }
+            ],
+            'additionalProperties': False,
+        },
         'stormtypeDoc': {
             'type': 'object',
             'properties': {
@@ -54,6 +76,7 @@ stormtype_doc_schema = {
                          'description': 'The name of the object.'},
                 'desc': {'type': 'string',
                          'description': 'The docstring of the object.'},
+                'deprecated': {'$ref': '#/definitions/deprecatedItem'},
                 'type': {'$ref': '#/definitions/stormType'}
             },
             'additionalProperties': False,
@@ -186,6 +209,34 @@ def getArgLines(rtype):
 
     return lines
 
+def genDeprecationWarning(name, depr, runt=False):
+    assert name is not None
+    assert depr is not None
+    lines = []
+    if runt:
+        lines.append('.. warning::')
+    else:
+        lines.append('Warning:')
+
+    mesg = depr.get('mesg')
+    date = depr.get('eoldate')
+    vers = depr.get('eolvers')
+
+    ws = ''
+    if runt:
+        ws = '   '
+
+    if date:
+        lines.append(f'{ws}``{name}`` has been deprecated and will be removed on or after {date}.')
+    else:
+        lines.append(f'{ws}``{name}`` has been deprecated and will be removed in version {vers}.')
+    if mesg:
+        lines.append(f'{ws}{mesg}')
+
+    lines.append('\n')
+
+    return lines
+
 def runtimeGetArgLines(rtype):
     lines = []
     args = rtype.get('args', ())
@@ -424,6 +475,9 @@ def docStormTypes(page, docinfo, linkprefix, islib=False, lvl=1,
             assert rtype is not None
 
             link = f'.. _{linkprefix}-{loclname.replace(":", ".").replace(".", "-")}:'
+            lines = []
+            if depr := locl.get('deprecated'):
+                lines.extend(genDeprecationWarning(f'${loclname}', depr, True))
 
             if isinstance(rtype, dict):
                 rname = rtype.get('type')
@@ -445,7 +499,7 @@ def docStormTypes(page, docinfo, linkprefix, islib=False, lvl=1,
                 if rname == 'stor' or 'stor' in rname:
                     isstor = True
 
-                lines = prepareRstLines(desc)
+                lines.extend(prepareRstLines(desc))
                 arglines = getArgLines(rtype)
                 lines.extend(arglines)
 
@@ -461,7 +515,7 @@ def docStormTypes(page, docinfo, linkprefix, islib=False, lvl=1,
 
             else:
                 header = name
-                lines = prepareRstLines(desc)
+                lines.extend(prepareRstLines(desc))
 
                 retlines = getReturnLines(rtype, known_types=known_types, types_prefix=types_prefix,
                                           suffix=types_suffix)
@@ -472,6 +526,7 @@ def docStormTypes(page, docinfo, linkprefix, islib=False, lvl=1,
                 header = f'${header}'
 
             page.addHead(header, lvl=lvl + 1, link=link)
+
             page.addLines(*lines)
 
 def runtimeDocStormTypes(page, docinfo, islib=False, lvl=1,
@@ -568,13 +623,17 @@ def runtimeDocStormTypes(page, docinfo, islib=False, lvl=1,
             assert desc is not None
             assert rtype is not None
 
+            lines = []
+            if (depr := locl.get('deprecated')) and not oneline:
+                lines.extend(genDeprecationWarning(f'${loclname}', depr))
+
             if isinstance(rtype, dict):
                 rname = rtype.get('type')
 
                 if isinstance(rname, dict):
                     raise AssertionError(f'rname as dict not supported loclname={loclname} rname={rname}')
 
-                lines = prepareRstLines(desc)
+                lines.extend(prepareRstLines(desc))
                 arglines = runtimeGetArgLines(rtype)
                 lines.extend(arglines)
 
@@ -588,7 +647,7 @@ def runtimeDocStormTypes(page, docinfo, islib=False, lvl=1,
 
             else:
                 header = name
-                lines = prepareRstLines(desc)
+                lines.extend(prepareRstLines(desc))
 
                 retlines = runtimeGetReturnLines(rtype)
                 lines.extend(retlines)

{synapse-2.182.0 → synapse-2.183.0}/synapse/lib/storm.py

@@ -342,6 +342,7 @@ reqValidPkgdef = s_config.getJsValidator({
             'properties': {
                 'name': {'type': 'string'},
                 'desc': {'type': 'string'},
+                'deprecated': {'$ref': '#/definitions/deprecatedItem'},
                 'type': {
                     'type': 'object',
                     'properties': {
@@ -395,6 +396,28 @@ reqValidPkgdef = s_config.getJsValidator({
             'additionalProperties': False,
             'required': ['name', 'desc', 'type']
         },
+        'deprecatedItem': {
+            'type': 'object',
+            'properties': {
+                'eolvers': {'type': 'string', 'minLength': 1,
+                            'description': "The version which will not longer support the item."},
+                'eoldate': {'type': 'string', 'minLength': 1,
+                            'description': 'Optional string indicating Synapse releases after this date may no longer support the item.'},
+                'mesg': {'type': ['string', 'null'], 'default': None,
+                         'description': 'Optional message to include in the warning text.'}
+            },
+            'oneOf': [
+                {
+                    'required': ['eolvers'],
+                    'not': {'required': ['eoldate']}
+                },
+                {
+                    'required': ['eoldate'],
+                    'not': {'required': ['eolvers']}
+                }
+            ],
+            'additionalProperties': False,
+        },
         'apitype': {
             'type': 'string',
         },

{synapse-2.182.0 → synapse-2.183.0}/synapse/lib/stormlib/cortex.py

@@ -715,6 +715,7 @@ class HttpPermsList(s_stormtypes.List):
                   ),
                   'returns': {'type': 'any', 'desc': 'The permission present in the list at the index position.', }}},
         {'name': 'length', 'desc': 'Get the length of the list. This is deprecated; please use ``.size()`` instead.',
+         'deprecated': {'eolvers': 'v3.0.0'},
          'type': {'type': 'function', '_funcname': '_methListLength',
                   'returns': {'type': 'int', 'desc': 'The size of the list.', }}},
         {'name': 'append', 'desc': 'Append a permission to the list.',

{synapse-2.182.0 → synapse-2.183.0}/synapse/lib/stormlib/infosec.py

@@ -537,6 +537,7 @@ class CvssLib(s_stormtypes.Lib):
                   'returns': {'type': 'dict', 'desc': 'A dictionary containing the computed score and subscores.', }
         }},
         {'name': 'vectToProps', 'desc': 'Parse a CVSS v3.1 vector and return a dictionary of risk:vuln props.',
+         'deprecated': {'eolvers': 'v3.0.0'},
          'type': {'type': 'function', '_funcname': 'vectToProps',
                   'args': (
                       {'name': 'text', 'type': 'str', 'desc': 'A CVSS vector string.'},
@@ -544,6 +545,7 @@ class CvssLib(s_stormtypes.Lib):
                   'returns': {'type': 'dict', 'desc': 'A dictionary of risk:vuln secondary props.', }
         }},
         {'name': 'saveVectToNode', 'desc': 'Parse a CVSS v3.1 vector and record properties on a risk:vuln node.',
+         'deprecated': {'eolvers': 'v3.0.0'},
          'type': {'type': 'function', '_funcname': 'saveVectToNode',
                   'args': (
                       {'name': 'node', 'type': 'node',

{synapse-2.182.0 → synapse-2.183.0}/synapse/lib/stormlib/model.py

@@ -543,7 +543,7 @@ class ModelType(s_stormtypes.Prim):
 @s_stormtypes.registry.registerLib
 class LibModelEdge(s_stormtypes.Lib):
     '''
-    A Storm Library for interacting with light edges and manipulating their key-value attributes.
+    A Storm Library for interacting with light edges and manipulating their key-value attributes. This Library is deprecated.
     '''
     _storm_locals = (
         {'name': 'get', 'desc': 'Get the key-value data for a given Edge verb.',
@@ -588,6 +588,7 @@ class LibModelEdge(s_stormtypes.Lib):
     hivepath = ('cortex', 'model', 'edges')
 
     _storm_lib_path = ('model', 'edge')
+    _storm_lib_deprecation = {'eolvers': 'v3.0.0'}
 
     def __init__(self, runt, name=()):
         s_stormtypes.Lib.__init__(self, runt, name)

synapse-2.183.0/synapse/lib/stormlib/random.py

@@ -0,0 +1,117 @@
+import random
+
+import synapse.exc as s_exc
+import synapse.common as s_common
+
+import synapse.lib.stormtypes as s_stormtypes
+
+from typing import Optional
+
+randinst = random.SystemRandom()
+
+
+@s_stormtypes.registry.registerType
+class Random(s_stormtypes.StormType):
+    '''
+    A random number generator.
+    '''
+    _storm_typename = 'random'
+    _storm_locals = (
+        {'name': 'int', 'desc': 'Generate a random integer.',
+         'type': {'type': 'function', '_funcname': '_methInt',
+                  'args': (
+                      {'name': 'maxval', 'type': 'int', 'desc': 'The maximum random value.'},
+                      {'name': 'minval', 'type': 'int', 'desc': 'The minimum random value.', 'default': 0},
+                  ),
+                  'returns': {'type': 'int', 'desc': 'A random integer in the range min-max inclusive.'}}},
+        {'name': 'seed', 'desc': 'The seed used for the generator. Setting this value resets the generator state.',
+         'type': {'type': ['gtor', 'stor'], '_storfunc': '_storSeed', '_gtorfunc': '_gtorSeed',
+                  'returns': {'type': ['str', 'null']}}},
+    )
+    _ismutable = False
+
+    def __init__(self, runt, seed: Optional[str] =None):
+        s_stormtypes.StormType.__init__(self)
+        self.runt = runt
+        self._seed = seed
+        self.robj = random.Random()
+        if seed is not None:
+            self.robj.seed(self._seed, version=2)
+        self.locls.update(self.getObjLocals())
+        self.gtors.update({
+            'seed': self._gtorSeed,
+        })
+        self.stors.update({
+            'seed': self._storSeed,
+        })
+
+    async def stormrepr(self):
+        ret = f'{self._storm_typename}'
+        if self._seed is not None:
+            ret = f'{ret} seed={s_common.trimText(self._seed, n=40)}'
+        return ret
+
+    def getObjLocals(self):
+        return {
+            'int': self._methInt,
+        }
+
+    async def _gtorSeed(self):
+        return self._seed
+
+    async def _storSeed(self, seed):
+        self._seed = await s_stormtypes.tostr(seed, noneok=True)
+        self.robj.seed(self._seed)
+
+    @s_stormtypes.stormfunc(readonly=True)
+    async def _methInt(self, maxval, minval=0):
+        maxval = await s_stormtypes.toint(maxval)
+        minval = await s_stormtypes.toint(minval)
+        if minval > maxval:
+            raise s_exc.BadArg(mesg=f'Minval must be less than or equal to maxval, minval={minval}, maxval={maxval}',
+                               minval=minval, maxval=maxval)
+        return self.robj.randint(minval, maxval)
+
+@s_stormtypes.registry.registerLib
+class LibRandom(s_stormtypes.Lib):
+    '''
+    A Storm library for generating random values.
+    '''
+    _storm_locals = (
+        {'name': 'int', 'desc': 'Generate a random integer.',
+         'type': {'type': 'function', '_funcname': '_methInt',
+                  'args': (
+                      {'name': 'maxval', 'type': 'int', 'desc': 'The maximum random value.'},
+                      {'name': 'minval', 'type': 'int', 'desc': 'The minimum random value.', 'default': 0},
+                  ),
+                  'returns': {'type': 'int', 'desc': 'A random integer in the range min-max inclusive.'}}},
+        {'name': 'generator', 'desc': 'Make a random generator with a given seed.',
+         'type': {'type': 'function', '_funcname': '_methGenerator',
+                  'args': (
+                      {'name': 'seed', 'type': 'str', 'default': None,
+                       'desc': 'The seed value used for the random generator.'},
+                  ),
+                  'returns': {'type': 'random', 'desc': 'The random generator object.'}}
+        }
+    )
+    _storm_lib_path = ('random',)
+
+    def getObjLocals(self):
+        return {
+            'int': self._methInt,
+            'generator': self._methGenerator,
+        }
+
+    @s_stormtypes.stormfunc(readonly=True)
+    async def _methGenerator(self, seed=None):
+        seed = await s_stormtypes.tostr(seed, noneok=True)
+        return Random(self.runt, seed=seed)
+
+    @s_stormtypes.stormfunc(readonly=True)
+    async def _methInt(self, maxval, minval=0):
+        maxval = await s_stormtypes.toint(maxval)
+        minval = await s_stormtypes.toint(minval)
+        if minval > maxval:
+            raise s_exc.BadArg(mesg=f'Minval must be less than or equal to maxval, minval={minval}, maxval={maxval}',
+                               minval=minval, maxval=maxval)
+        return randinst.randint(minval, maxval)

{synapse-2.182.0 → synapse-2.183.0}/synapse/lib/stormtypes.py

@@ -277,6 +277,7 @@ class StormTypesRegistry:
                 'desc': getDoc(slib, sname),
                 'locals': locs,
                 'path': ('lib',) + slib._storm_lib_path,
+                'deprecated': slib._storm_lib_deprecation,
             }
             for info in sorted(slib._storm_locals, key=lambda x: x.get('name')):
                 info = s_msgpack.deepcopy(info)
@@ -509,6 +510,7 @@ class Lib(StormType):
     _storm_query = None
     _storm_typename = 'lib'
     _storm_lib_perms = ()
+    _storm_lib_deprecation = None
 
     def __init__(self, runt, name=()):
         StormType.__init__(self)
@@ -2659,6 +2661,7 @@ class LibBytes(Lib):
                   'returns': {'type': 'list', 'desc': 'A tuple of the file size and sha256 value.', }}},
     )
     _storm_lib_path = ('bytes',)
+    _storm_lib_deprecation = {'eolvers': 'v3.0.0'}
 
     def getObjLocals(self):
         return {
@@ -5005,6 +5008,7 @@ class List(Prim):
                   ),
                   'returns': {'type': 'any', 'desc': 'The item present in the list at the index position.', }}},
         {'name': 'length', 'desc': 'Get the length of the list. This is deprecated; please use ``.size()`` instead.',
+         'deprecated': {'eolvers': 'v3.0.0'},
          'type': {'type': 'function', '_funcname': '_methListLength',
                   'returns': {'type': 'int', 'desc': 'The size of the list.', }}},
         {'name': 'append', 'desc': 'Append a value to the list.',

{synapse-2.182.0 → synapse-2.183.0}/synapse/lib/version.py

@@ -223,6 +223,6 @@ def reqVersion(valu, reqver,
 ##############################################################################
 # The following are touched during the release process by bumpversion.
 # Do not modify these directly.
-version = (2, 182, 0)
+version = (2, 183, 0)
 verstring = '.'.join([str(x) for x in version])
-commit = '72e535c8c22073fd1b7428121849de4b9fb034ae'
+commit = '68e4f3dd36f4ff9dd7818ea2c8180b086092148f'

{synapse-2.182.0 → synapse-2.183.0}/synapse/models/infotech.py

@@ -2709,15 +2709,12 @@ class ItModule(s_module.CoreModule):
                         'doc': 'The path for the file.',
                     }),
                     ('path:dir', ('file:path', {}), {
-                        'ro': True,
                         'doc': 'The parent directory of the file path (parsed from :path).',
                     }),
                     ('path:ext', ('str', {'lower': True, 'strip': True}), {
-                        'ro': True,
                         'doc': 'The file extension of the file name (parsed from :path).',
                     }),
                     ('path:base', ('file:base', {}), {
-                        'ro': True,
                         'doc': 'The final component of the file path (parsed from :path).',
                     }),
                     ('file', ('file:bytes', {}), {
@@ -2755,15 +2752,12 @@ class ItModule(s_module.CoreModule):
                         'doc': 'The path where the file was created.',
                     }),
                     ('path:dir', ('file:path', {}), {
-                        'ro': True,
                         'doc': 'The parent directory of the file path (parsed from :path).',
                     }),
                     ('path:ext', ('str', {'lower': True, 'strip': True}), {
-                        'ro': True,
                         'doc': 'The file extension of the file name (parsed from :path).',
                     }),
                     ('path:base', ('file:base', {}), {
-                        'ro': True,
                         'doc': 'The final component of the file path (parsed from :path).',
                     }),
                     ('file', ('file:bytes', {}), {
@@ -2789,15 +2783,12 @@ class ItModule(s_module.CoreModule):
                         'doc': 'The path where the file was deleted.',
                     }),
                     ('path:dir', ('file:path', {}), {
-                        'ro': True,
                         'doc': 'The parent directory of the file path (parsed from :path).',
                     }),
                     ('path:ext', ('str', {'lower': True, 'strip': True}), {
-                        'ro': True,
                         'doc': 'The file extension of the file name (parsed from :path).',
                     }),
                     ('path:base', ('file:base', {}), {
-                        'ro': True,
                         'doc': 'The final component of the file path (parsed from :path).',
                     }),
                     ('file', ('file:bytes', {}), {
@@ -2823,15 +2814,12 @@ class ItModule(s_module.CoreModule):
                         'doc': 'The path where the file was read.',
                     }),
                     ('path:dir', ('file:path', {}), {
-                        'ro': True,
                         'doc': 'The parent directory of the file path (parsed from :path).',
                     }),
                     ('path:ext', ('str', {'lower': True, 'strip': True}), {
-                        'ro': True,
                         'doc': 'The file extension of the file name (parsed from :path).',
                     }),
                     ('path:base', ('file:base', {}), {
-                        'ro': True,
                         'doc': 'The final component of the file path (parsed from :path).',
                     }),
                     ('file', ('file:bytes', {}), {
@@ -2857,15 +2845,12 @@ class ItModule(s_module.CoreModule):
                         'doc': 'The path where the file was written to/modified.',
                     }),
                     ('path:dir', ('file:path', {}), {
-                        'ro': True,
                         'doc': 'The parent directory of the file path (parsed from :path).',
                     }),
                     ('path:ext', ('str', {'lower': True, 'strip': True}), {
-                        'ro': True,
                         'doc': 'The file extension of the file name (parsed from :path).',
                     }),
                     ('path:base', ('file:base', {}), {
-                        'ro': True,
                         'doc': 'The final component of the file path (parsed from :path).',
                     }),
                     ('file', ('file:bytes', {}), {

{synapse-2.182.0 → synapse-2.183.0}/synapse/tests/files/stormpkg/testpkg.yaml

@@ -30,6 +30,16 @@ modules:
             returns:
               type: dict
               desc: A status dictionary.
+        - name: newp
+          desc: Some nonexistent function.
+          deprecated:
+            eolvers: v2.300.4
+            mesg: Newp is no longer maintained. Use bar() instead.
+          type:
+            type: function
+            returns:
+              type: 'null'
+              desc: '``newp()`` does not return data.'
 
 onload: |
   $lib.time.sleep($lib.globals.get(onload_sleep, 0))

{synapse-2.182.0 → synapse-2.183.0}/synapse/tests/test_cortex.py

@@ -2985,6 +2985,16 @@ class CortexBasicTest(s_t_utils.SynTest):
             info = await view.pack()
             self.eq(info['name'], 'default')
 
+            depr = [x for x in coreinfo['stormdocs']['libraries'] if x['path'] == ('lib', 'bytes')]
+            self.len(1, depr)
+            deprinfo = depr[0].get('deprecated')
+            self.nn(deprinfo)
+            self.eq(deprinfo.get('eolvers'), 'v3.0.0')
+
+            depr = [x for x in coreinfo['stormdocs']['libraries'] if x['path'] == ('lib', 'infosec', 'cvss')]
+            self.len(1, depr)
+            self.len(2, [x for x in depr[0]['locals'] if x.get('deprecated')])
+
     async def test_cortex_model_dict(self):
 
         async with self.getTestCoreAndProxy() as (core, prox):
@@ -7195,6 +7205,12 @@ class CortexBasicTest(s_t_utils.SynTest):
             with self.raises(s_exc.BadTag):
                 await core.nodes('[ inet:ipv4=1.2.3.4 +#cno.cve.12345 ]')
 
+            nodes = await core.nodes('[ test:str=beep +?#cno.cve.12345 ]')
+            self.len(1, nodes)
+            self.none(nodes[0].get('#cno'))
+            self.none(nodes[0].get('#cno.cve'))
+            self.none(nodes[0].get('#cno.cve.12345'))
+
             self.eq((None, None, '[0-9]{4}', '[0-9]{5}'), await core.callStorm('''
                 return($lib.model.tags.pop(cno.cve, regex))
             '''))

{synapse-2.182.0 → synapse-2.183.0}/synapse/tests/test_lib_autodoc.py

@@ -1,4 +1,6 @@
 import copy
+
+import synapse.exc as s_exc
 import synapse.lib.autodoc as s_autodoc
 import synapse.lib.stormtypes as s_stormtypes
 
@@ -153,6 +155,10 @@ LibTst for testing!
 beep(valu)
 ==========
 
+.. warning::
+   ``$lib.test.beep`` has been deprecated and will be removed on or after 8080-08-08.
+
+
 Example storm func.
 
 Notes:
@@ -173,6 +179,11 @@ Returns:
 someargs(valu, bar=$lib.true, faz=$lib.null)
 ============================================
 
+.. warning::
+   ``$lib.test.someargs`` has been deprecated and will be removed in version v3.0.0.
+   This is a test library was deprecated from the day it was made.
+
+
 Example storm func with args.
 
 
@@ -220,6 +231,10 @@ LibTst for testing!
 $lib.test.beep(valu)
 ====================
 
+.. warning::
+   ``$lib.test.beep`` has been deprecated and will be removed on or after 8080-08-08.
+
+
 Example storm func.
 
 Notes:
@@ -240,6 +255,11 @@ Returns:
 $lib.test.someargs(valu, bar=$lib.true, faz=$lib.null)
 ======================================================
 
+.. warning::
+   ``$lib.test.someargs`` has been deprecated and will be removed in version v3.0.0.
+   This is a test library was deprecated from the day it was made.
+
+
 Example storm func with args.
 
 
@@ -257,3 +277,14 @@ Args:
 Returns:
     The beeped string. The return type is ``str``.'''
         self.eq(text, expected)
+
+        badlocls = copy.deepcopy(libtst._storm_locals)
+        badlocls[0]['deprecated']['eolvers'] = 'v4.4.4'
+        page = s_autodoc.RstHelp()
+        doc = {
+            'desc': s_stormtypes.getDoc(libtst, "err"),
+            'path': ('lib',) + libtst._storm_lib_path,
+            'locals': badlocls,
+        }
+        with self.raises(s_exc.SchemaViolation):
+            s_autodoc.docStormTypes(page, (doc,), linkprefix='test')

{synapse-2.182.0 → synapse-2.183.0}/synapse/tests/test_lib_storm.py

@@ -3913,6 +3913,10 @@ class StormTest(s_t_utils.SynTest):
             self.stormIsInPrint('Returns an ou:org by name, adding the node if it does not exist.\n'
                                 'Args:\n    name (str): The name of the org.', msgs)
 
+            msgs = await core.stormlist('help --verbose $lib.infosec.cvss.saveVectToNode')
+            self.stormIsInPrint('Warning', msgs)
+            self.stormIsInPrint('``$lib.infosec.cvss.saveVectToNode`` has been deprecated and will be removed in version v3.0.0.', msgs)
+
             msgs = await core.stormlist('help $lib.inet')
             self.stormIsInPrint('The following libraries are available:\n\n'
                                 '$lib.inet.http                : A Storm Library exposing an HTTP client API.\n'