synapse 2.183.0__py311-none-any.whl → 2.185.0__py311-none-any.whl

synapse/tests/test_lib_storm.py

@@ -147,6 +147,20 @@ class StormTest(s_t_utils.SynTest):
             retn = await core.callStorm('return(({"foo": "bar", "baz": 10 , }))')
             self.eq(retn, {'foo': 'bar', 'baz': 10})
 
+            q = '''
+            $foo = ({"bar": ${[inet:fqdn=foo.com]}})
+            for $n in $foo.bar { return($n.repr()) }
+            '''
+            retn = await core.callStorm(q)
+            self.eq(retn, 'foo.com')
+
+            q = '''
+            $foo = ([${[inet:fqdn=foo.com]}])
+            for $n in $foo.0 { return($n.repr()) }
+            '''
+            retn = await core.callStorm(q)
+            self.eq(retn, 'foo.com')
+
             with self.raises(s_exc.BadSyntax):
                 await core.callStorm('return((["foo" "foo"]))')
 
@@ -612,6 +626,12 @@ class StormTest(s_t_utils.SynTest):
             ''')
             self.eq((0, 'haha'), await core.callStorm('return($lib.queue.get(bar).get())'))
 
+            await core.nodes('$foo = (foo,) background ${ $foo.append(bar) $lib.queue.get(bar).put($foo) }')
+            self.eq((1, ['foo', 'bar']), await core.callStorm('return($lib.queue.get(bar).get(1))'))
+
+            await core.nodes('$foo = ([["foo"]]) background ${ $foo.0.append(bar) $lib.queue.get(bar).put($foo) }')
+            self.eq((2, [['foo', 'bar']]), await core.callStorm('return($lib.queue.get(bar).get(2))'))
+
             with self.raises(s_exc.StormRuntimeError):
                 await core.nodes('[ ou:org=*] $text = $node.repr() | background $text')
 
@@ -3586,7 +3606,7 @@ class StormTest(s_t_utils.SynTest):
             'quickly became his weapon of choice.'])
         pars.help()
         helptext = '\n'.join(pars.mesgs)
-        self.isin('default: \n[', helptext)
+        self.isin('default:\n                                [', helptext)
 
         pars = s_storm.Parser()
         pars.add_argument('--ques', nargs='?')
@@ -3771,6 +3791,27 @@ class StormTest(s_t_utils.SynTest):
         opts = pars.parse_args(['faz', '--cat', 'cam', 'cool'])
         self.nn(opts)
 
+        pars = s_storm.Parser()
+        pars.add_argument('--baz', nargs=3, help='''
+             This is the top line, nothing special.
+             This is my second line with sublines that should have some leading spaces:
+                subline 1: this is a line which has three spaces.
+                  subline 2: this is another line with five leading spaces.
+               subline 3: yet another line with only two leading spaces.
+              subline 4: this line has one space and is long which should wrap around because it exceeds the default display width.
+             This is the final line with no leading spaces.''')
+        pars.add_argument('--taz', type='bool', default=True, help='Taz option')
+        pars.help()
+        self.eq('  --baz <baz>                 : This is the top line, nothing special.', pars.mesgs[5])
+        self.eq('                                This is my second line with sublines that should have some leading spaces:', pars.mesgs[6])
+        self.eq('                                   subline 1: this is a line which has three spaces.', pars.mesgs[7])
+        self.eq('                                     subline 2: this is another line with five leading spaces.', pars.mesgs[8])
+        self.eq('                                  subline 3: yet another line with only two leading spaces.', pars.mesgs[9])
+        self.eq('                                 subline 4: this line has one space and is long which should wrap around because it', pars.mesgs[10])
+        self.eq('                                 exceeds the default display width.', pars.mesgs[11])
+        self.eq('                                This is the final line with no leading spaces.', pars.mesgs[12])
+        self.eq('  --taz <taz>                 : Taz option (default: True)', pars.mesgs[13])
+
     async def test_storm_cmd_help(self):
 
         async with self.getTestCore() as core:
@@ -3917,6 +3958,11 @@ class StormTest(s_t_utils.SynTest):
             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 --verbose $lib.inet.whois.guid')
+            self.stormIsInPrint('Warning', msgs)
+            self.stormIsInPrint('``$lib.inet.whois.guid`` has been deprecated and will be removed in version v3.0.0.', msgs)
+            self.stormIsInPrint('Please use the GUID constructor syntax.', 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'
@@ -3947,6 +3993,15 @@ class StormTest(s_t_utils.SynTest):
             msgs = await core.stormlist('$mod=$lib.import(foosmod) help $mod.f')
             self.stormIsInErr('help does not currently support runtime defined functions.', msgs)
 
+            msgs = await core.stormlist('help --verbose $lib.bytes')
+            self.stormIsInPrint('Warning', msgs)
+            self.stormIsInPrint('$lib.bytes.put`` has been deprecated and will be removed in version v3.0.0', msgs)
+            self.stormIsInPrint('$lib.bytes.has`` has been deprecated and will be removed in version v3.0.0', msgs)
+            self.stormIsInPrint('$lib.bytes.size`` has been deprecated and will be removed in version v3.0.0', msgs)
+            self.stormIsInPrint('$lib.bytes.upload`` has been deprecated and will be removed in version v3.0.0', msgs)
+            self.stormIsInPrint('$lib.bytes.hashset`` has been deprecated and will be removed in version v3.0.0', msgs)
+            self.stormIsInPrint('Use the corresponding ``$lib.axon`` function.', msgs)
+
     async def test_liftby_edge(self):
         async with self.getTestCore() as core:
 
@@ -5071,3 +5126,15 @@ class StormTest(s_t_utils.SynTest):
             ''')
 
             self.none(await core.callStorm('return($lib.queue.gen(haha).get().1)'))
+
+            await core.nodes('''
+                $foo = (foo,)
+                $query = ${
+                    $foo.append(bar)
+                    $lib.queue.gen(hoho).put($foo)
+                    $lib.dmon.del($auto.iden)
+                }
+                $lib.dmon.add($query)
+            ''')
+
+            self.eq(['foo', 'bar'], await core.callStorm('return($lib.queue.gen(hoho).get().1)'))

synapse/tests/test_lib_stormlib_modelext.py

@@ -510,3 +510,55 @@ class StormtypesModelextTest(s_test.SynTest):
                 with self.raises(s_exc.BadArg) as exc:
                     await core.callStorm(query)
                 self.eq(err, exc.exception.get('mesg'))
+
+    async def test_lib_stormlib_modelext_interfaces(self):
+        async with self.getTestCore() as core:
+
+            await core.callStorm('''
+                $forminfo = ({"interfaces": ["test:interface"]})
+                $lib.model.ext.addForm(_test:iface, str, ({}), $forminfo)
+                $lib.model.ext.addFormProp(_test:iface, tick, (time, ({})), ({}))
+            ''')
+
+            self.nn(core.model.form('_test:iface'))
+            self.nn(core.model.prop('_test:iface:flow'))
+            self.nn(core.model.prop('_test:iface:proc'))
+            self.nn(core.model.prop('_test:iface:tick'))
+            self.isin('_test:iface', core.model.formsbyiface['test:interface'])
+            self.isin('_test:iface', core.model.formsbyiface['inet:proto:request'])
+            self.isin('_test:iface', core.model.formsbyiface['it:host:activity'])
+            self.isin('_test:iface:flow', core.model.ifaceprops['inet:proto:request:flow'])
+            self.isin('_test:iface:proc', core.model.ifaceprops['test:interface:proc'])
+            self.isin('_test:iface:proc', core.model.ifaceprops['inet:proto:request:proc'])
+            self.isin('_test:iface:proc', core.model.ifaceprops['it:host:activity:proc'])
+
+            q = '$lib.model.ext.delForm(_test:iface)'
+            with self.raises(s_exc.CantDelForm) as exc:
+                await core.callStorm(q)
+            self.eq('Form has extended properties: tick', exc.exception.get('mesg'))
+
+            await core.callStorm('''
+                $lib.model.ext.delFormProp(_test:iface, tick)
+                $lib.model.ext.delForm(_test:iface)
+            ''')
+
+            self.none(core.model.form('_test:iface'))
+            self.none(core.model.prop('_test:iface:flow'))
+            self.none(core.model.prop('_test:iface:proc'))
+            self.none(core.model.prop('_test:iface:tick'))
+            self.notin('_test:iface', core.model.formsbyiface['test:interface'])
+            self.notin('_test:iface', core.model.formsbyiface['inet:proto:request'])
+            self.notin('_test:iface', core.model.formsbyiface['it:host:activity'])
+            self.notin('_test:iface:flow', core.model.ifaceprops['inet:proto:request:flow'])
+            self.notin('_test:iface:proc', core.model.ifaceprops['test:interface:proc'])
+            self.notin('_test:iface:proc', core.model.ifaceprops['inet:proto:request:proc'])
+            self.notin('_test:iface:proc', core.model.ifaceprops['it:host:activity:proc'])
+
+            await core.stormlist('''
+                $forminfo = ({"interfaces": ["newp"]})
+                $lib.model.ext.addForm(_test:iface, str, ({}), $forminfo)
+            ''')
+            self.nn(core.model.form('_test:iface'))
+
+            await core.callStorm('$lib.model.ext.delForm(_test:iface)')
+            self.none(core.model.form('_test:iface'))

synapse/tests/test_lib_stormlib_stix.py

@@ -55,6 +55,7 @@ class StormLibStixTest(s_test.SynTest):
     async def test_stormlib_libstix(self, conf=None):
 
         async with self.getTestCore(conf=conf) as core:
+            visi = await core.auth.addUser('visi')
             opts = {'vars': {
                 'ind': '6ba7d8500964902bf2e03126ed0f6cb1',
                 'news': '840b9b003a765020705ea8d203a7659c',
@@ -228,9 +229,9 @@ class StormLibStixTest(s_test.SynTest):
                 opts = {'vars': {'config': config}}
                 await core.callStorm('$lib.stix.export.bundle(config=$config)', opts=opts)
 
-            with self.raises(s_exc.BadConfValu):
+            with self.raises(s_exc.AuthDeny):
                 config = {'maxsize': 10000000}
-                opts = {'vars': {'config': config}}
+                opts = {'user': visi.iden, 'vars': {'config': config}}
                 await core.callStorm('$lib.stix.export.bundle(config=$config)', opts=opts)
 
             with self.raises(s_exc.NoSuchForm):

synapse/tests/test_lib_stormwhois.py

@@ -84,8 +84,8 @@ class StormWhoisTest(s_test.SynTest):
             '''
             opts = {'vars': {'props': props}}
             mesgs = await core.stormlist(stormcmd, opts=opts)
-            warn = [m[1]['mesg'] for m in mesgs if m[0] == 'warn']
-            self.isin('Insufficient guid vals identified, using random guid:', warn[0])
+            self.stormIsInWarn('$lib.inet.whois.guid() is deprecated', mesgs)
+            self.stormIsInWarn('Insufficient guid vals identified, using random guid:', mesgs)
             self.len(1, await core.nodes(f'inet:whois:ipquery:fqdn={props["fqdn"]}'))
 
             props = {
@@ -97,8 +97,8 @@ class StormWhoisTest(s_test.SynTest):
             '''
             opts = {'vars': {'props': props}}
             mesgs = await core.stormlist(stormcmd, opts=opts)
-            warn = [m[1]['mesg'] for m in mesgs if m[0] == 'warn']
-            self.isin('Insufficient guid vals identified, using random guid:', warn[0])
+            self.stormIsInWarn('$lib.inet.whois.guid() is deprecated', mesgs)
+            self.stormIsInWarn('Insufficient guid vals identified, using random guid:', mesgs)
             self.len(1, await core.nodes(f'inet:whois:ipcontact:asn={props["asn"]}'))
 
             # Failure cases

synapse/tests/test_model_doc.py

@@ -0,0 +1,51 @@
+import synapse.tests.utils as s_tests
+
+class DocModelTest(s_tests.SynTest):
+
+    async def test_model_doc(self):
+
+        async with self.getTestCore() as core:
+
+            nodes = await core.nodes('''
+                [ doc:policy=*
+                    :id=V-41
+                    :name="Rule 41"
+                    :text="If you can AAAAAAAA..."
+                    :file=*
+                    :created=20241018
+                    :updated=20241018
+                    :author={[ ps:contact=* :name=visi ]}
+                    :contributors={[ ps:contact=* :name=shuka ]}
+                    :version=1.2.3
+                    :supersedes={[ doc:policy=* doc:policy=* ]}
+                ]
+            ''')
+            self.len(1, nodes)
+            self.eq('V-41', nodes[0].get('id'))
+            self.eq('rule 41', nodes[0].get('name'))
+            self.eq('If you can AAAAAAAA...', nodes[0].get('text'))
+            self.eq(1729209600000, nodes[0].get('created'))
+            self.eq(1729209600000, nodes[0].get('updated'))
+            self.eq(1099513724931, nodes[0].get('version'))
+
+            self.nn(nodes[0].get('file'))
+            self.nn(nodes[0].get('author'))
+
+            self.len(2, nodes[0].get('supersedes'))
+            self.len(1, nodes[0].get('contributors'))
+
+            self.len(1, await core.nodes('doc:policy:id=V-41 :file -> file:bytes'))
+            self.len(2, await core.nodes('doc:policy:id=V-41 :supersedes -> doc:policy'))
+            self.len(1, await core.nodes('doc:policy:id=V-41 :author -> ps:contact +:name=visi'))
+            self.len(1, await core.nodes('doc:policy:id=V-41 :contributors -> ps:contact +:name=shuka'))
+
+            nodes = await core.nodes('''
+                [ doc:standard=*
+                    :id=V-99
+                    :policy={ doc:policy:id=V-41 }
+                ]
+            ''')
+            self.len(1, nodes)
+            self.eq('V-99', nodes[0].get('id'))
+            self.nn(nodes[0].get('policy'))
+            self.len(1, await core.nodes('doc:standard -> doc:policy'))

synapse/tests/test_model_infotech.py

@@ -1675,8 +1675,12 @@ class InfotechModelTest(s_t_utils.SynTest):
             self.eq(1640995200000, nodes[0].get('updated'))
             self.nn(nodes[0].get('author'))
 
-            nodes = await core.nodes('[ it:app:snort:hit=$hit :rule=$rule :flow=$flow :src="tcp://[::ffff:0102:0304]:0" :dst="tcp://[::ffff:0505:0505]:80" :time=2015 :sensor=$host :version=1.2.3 ]', opts=opts)
+            nodes = await core.nodes('''[ it:app:snort:hit=$hit
+                :rule=$rule :flow=$flow :src="tcp://[::ffff:0102:0304]:0"
+                :dst="tcp://[::ffff:0505:0505]:80" :time=2015 :sensor=$host
+                :version=1.2.3 :dropped=true ]''', opts=opts)
             self.len(1, nodes)
+            self.true(nodes[0].get('dropped'))
             self.eq(rule, nodes[0].get('rule'))
             self.eq(flow, nodes[0].get('flow'))
             self.eq(host, nodes[0].get('sensor'))

synapse/tests/test_model_orgs.py

@@ -640,6 +640,7 @@ class OuModelTest(s_t_utils.SynTest):
 
             nodes = await core.nodes('''[ ou:requirement=50b757fafe4a839ec499023ebcffe7c0
                 :name="acquire pizza toppings"
+                :type=foo.bar
                 :text="The team must acquire ANSI standard pizza toppings."
                 :goal={[ ou:goal=* :name=pizza ]}
                 :issuer={[ ps:contact=* :name=visi ]}
@@ -657,6 +658,7 @@ class OuModelTest(s_t_utils.SynTest):
             self.eq('The team must acquire ANSI standard pizza toppings.', nodes[0].get('text'))
             self.eq(1, nodes[0].get('deps:min'))
             self.eq(50, nodes[0].get('priority'))
+            self.eq('foo.bar.', nodes[0].get('type'))
             self.eq(True, nodes[0].get('optional'))
             self.eq(1328140800000, nodes[0].get('issued'))
             self.eq((1672531200000, 9223372036854775807), nodes[0].get('period'))
@@ -665,6 +667,80 @@ class OuModelTest(s_t_utils.SynTest):
             self.len(1, await core.nodes('ou:requirement=50b757fafe4a839ec499023ebcffe7c0 -> ou:goal +:name=pizza'))
             self.len(1, await core.nodes('ou:requirement=50b757fafe4a839ec499023ebcffe7c0 :issuer -> ps:contact +:name=visi'))
             self.len(1, await core.nodes('ou:requirement=50b757fafe4a839ec499023ebcffe7c0 :assignee -> ps:contact +:orgname=ledos'))
+            self.len(1, await core.nodes('ou:requirement=50b757fafe4a839ec499023ebcffe7c0 -> ou:requirement:type:taxonomy'))
+
+            nodes = await core.nodes('''
+                [ ou:asset=*
+                    :id=V-31337
+                    :name="visi laptop"
+                    :type=host.laptop
+                    :priority=highest
+                    :priority:confidentiality=highest
+                    :priority:integrity=highest
+                    :priority:availability=highest
+                    :node = (it:host, *)
+                    :period=(2016, ?)
+                    :status=deployed
+                    :org={[ ou:org=* :name=vertex ]}
+                    :owner={[ ps:contact=* :name=foo ]}
+                    :operator={[ ps:contact=* :name=bar ]}
+                ]''')
+            self.len(1, nodes)
+            self.eq((1451606400000, 9223372036854775807), nodes[0].get('period'))
+            self.eq('visi laptop', nodes[0].get('name'))
+            self.eq('host.laptop.', nodes[0].get('type'))
+            self.eq('deployed.', nodes[0].get('status'))
+            self.eq(50, nodes[0].get('priority'))
+            self.eq(50, nodes[0].get('priority:confidentiality'))
+            self.eq(50, nodes[0].get('priority:integrity'))
+            self.eq(50, nodes[0].get('priority:availability'))
+
+            self.len(1, await core.nodes('ou:asset -> ou:asset:type:taxonomy'))
+            self.len(1, await core.nodes('ou:asset :node -> it:host'))
+            self.len(1, await core.nodes('ou:asset :org -> ou:org +:name=vertex'))
+            self.len(1, await core.nodes('ou:asset :owner -> ps:contact +:name=foo '))
+            self.len(1, await core.nodes('ou:asset :operator -> ps:contact +:name=bar '))
+
+            visi = await core.auth.addUser('visi')
+
+            nodes = await core.nodes('''
+                [ ou:enacted=*
+                    :id=V-99
+                    :project={[ proj:project=* ]}
+                    :status=10
+                    :priority=highest
+                    :created=20241018
+                    :updated=20241018
+                    :due=20241018
+                    :completed=20241018
+                    :creator=root
+                    :assignee=visi
+                    :scope=(ou:team, *)
+                    :ext:creator={[ ps:contact=* :name=root ]}
+                    :ext:assignee={[ ps:contact=* :name=visi ]}
+                ]
+            ''')
+            self.len(1, nodes)
+            self.eq('V-99', nodes[0].get('id'))
+            self.eq(10, nodes[0].get('status'))
+            self.eq(50, nodes[0].get('priority'))
+
+            self.eq(1729209600000, nodes[0].get('due'))
+            self.eq(1729209600000, nodes[0].get('created'))
+            self.eq(1729209600000, nodes[0].get('updated'))
+            self.eq(1729209600000, nodes[0].get('completed'))
+
+            self.eq(visi.iden, nodes[0].get('assignee'))
+            self.eq(core.auth.rootuser.iden, nodes[0].get('creator'))
+
+            self.nn(nodes[0].get('scope'))
+            self.nn(nodes[0].get('ext:creator'))
+            self.nn(nodes[0].get('ext:assignee'))
+
+            self.len(1, await core.nodes('ou:enacted -> proj:project'))
+            self.len(1, await core.nodes('ou:enacted :scope -> ou:team'))
+            self.len(1, await core.nodes('ou:enacted :ext:creator -> ps:contact +:name=root'))
+            self.len(1, await core.nodes('ou:enacted :ext:assignee -> ps:contact +:name=visi'))
 
     async def test_ou_code_prefixes(self):
         guid0 = s_common.guid()
@@ -832,6 +908,7 @@ class OuModelTest(s_t_utils.SynTest):
                     :orgfqdn = wootwoot.com
                     :currency = USD
                     :costs = 200
+                    :budget = 300
                     :revenue = 500
                     :profit = 300
                     :valuation = 1000000000
@@ -850,6 +927,7 @@ class OuModelTest(s_t_utils.SynTest):
             self.eq(nodes[0].get('orgfqdn'), 'wootwoot.com')
             self.eq(nodes[0].get('currency'), 'usd')
             self.eq(nodes[0].get('costs'), '200')
+            self.eq(nodes[0].get('budget'), '300')
             self.eq(nodes[0].get('revenue'), '500')
             self.eq(nodes[0].get('profit'), '300')
             self.eq(nodes[0].get('valuation'), '1000000000')

synapse/tests/test_model_risk.py

@@ -542,6 +542,7 @@ class RiskModelTest(s_t_utils.SynTest):
                 risk:mitigation=*
                     :vuln=*
                     :name="  FooBar  "
+                    :type=foo.bar
                     :desc=BazFaz
                     :hardware=*
                     :software=*
@@ -552,11 +553,13 @@ class RiskModelTest(s_t_utils.SynTest):
             self.eq('foobar', nodes[0].props['name'])
             self.eq('BazFaz', nodes[0].props['desc'])
             self.eq('vertex', nodes[0].get('reporter:name'))
+            self.eq('foo.bar.', nodes[0].get('type'))
             self.nn(nodes[0].get('reporter'))
             self.len(1, await core.nodes('risk:mitigation -> risk:vuln'))
             self.len(1, await core.nodes('risk:mitigation -> it:prod:softver'))
             self.len(1, await core.nodes('risk:mitigation -> it:prod:hardware'))
             self.len(1, await core.nodes('risk:mitigation -> it:mitre:attack:mitigation'))
+            self.len(1, await core.nodes('risk:mitigation -> risk:mitigation:type:taxonomy'))
 
     async def test_model_risk_tool_software(self):
 

synapse/tests/test_model_syn.py

@@ -1,5 +1,7 @@
 import synapse.exc as s_exc
+import synapse.common as s_common
 import synapse.cortex as s_cortex
+import synapse.datamodel as s_datamodel
 
 import synapse.lib.stormsvc as s_stormsvc
 
@@ -46,6 +48,47 @@ class TestService(s_stormsvc.StormSvc):
 
 class SynModelTest(s_t_utils.SynTest):
 
+    async def test_syn_userrole(self):
+
+        async with self.getTestCore() as core:
+
+            (ok, iden) = await core.callStorm('return($lib.trycast(syn:user, root))')
+            self.true(ok)
+            self.eq(iden, core.auth.rootuser.iden)
+
+            # coverage for iden taking precedence
+            (ok, iden) = await core.callStorm(f'return($lib.trycast(syn:user, {iden}))')
+            self.true(ok)
+            self.eq(iden, core.auth.rootuser.iden)
+
+            self.eq('root', await core.callStorm(f'return($lib.repr(syn:user, {iden}))'))
+
+            (ok, iden) = await core.callStorm('return($lib.trycast(syn:role, all))')
+            self.true(ok)
+            self.eq(iden, core.auth.allrole.iden)
+
+            # coverage for iden taking precedence
+            (ok, iden) = await core.callStorm(f'return($lib.trycast(syn:role, {iden}))')
+            self.true(ok)
+            self.eq(iden, core.auth.allrole.iden)
+
+            self.eq('all', await core.callStorm(f'return($lib.repr(syn:role, {iden}))'))
+
+            # coverage for DataModel without a cortex reference
+            iden = s_common.guid()
+
+            model = core.model
+            model.core = None
+
+            synuser = model.type('syn:user')
+            synrole = model.type('syn:user')
+
+            self.eq(iden, synuser.repr(iden))
+            self.eq(iden, synrole.repr(iden))
+
+            self.eq(iden, synuser.norm(iden)[0])
+            self.eq(iden, synrole.norm(iden)[0])
+
     async def test_syn_tag(self):
 
         async with self.getTestCore() as core:

synapse/tests/test_tools_promote.py

@@ -0,0 +1,67 @@
+import synapse.common as s_common
+
+import synapse.lib.base as s_base
+import synapse.lib.cell as s_cell
+
+import synapse.tools.promote as s_tools_promote
+
+import synapse.tests.utils as s_t_utils
+
+
+class PromoteToolTest(s_t_utils.SynTest):
+
+    async def test_tool_promote_simple(self):
+        async with self.getTestAha() as aha:
+            async with await s_base.Base.anit() as base:
+                with self.getTestDir() as dirn:
+                    dirn00 = s_common.genpath(dirn, '00.cell')
+                    dirn01 = s_common.genpath(dirn, '01.cell')
+
+                    cell00 = await base.enter_context(self.addSvcToAha(aha, '00.cell', s_cell.Cell, dirn=dirn00))
+                    cell01 = await base.enter_context(self.addSvcToAha(aha, '01.cell', s_cell.Cell, dirn=dirn01,
+                                                                       provinfo={'mirror': 'cell'}))
+                    self.true(cell00.isactive)
+                    self.false(cell01.isactive)
+                    await cell01.sync()
+
+                    outp = self.getTestOutp()
+                    argv = ['--svcurl', cell00.getLocalUrl()]
+                    ret = await s_tools_promote.main(argv, outp=outp)
+                    self.eq(1, ret)
+                    outp.expect('Failed to promote service')
+                    outp.expect('promote() called on non-mirror')
+
+                    outp.clear()
+                    argv = ['--svcurl', cell01.getLocalUrl()]
+                    ret = await s_tools_promote.main(argv, outp=outp)
+                    self.eq(0, ret)
+                    self.false(cell00.isactive)
+                    self.true(cell01.isactive)
+                    await cell00.sync()
+
+    async def test_tool_promote_schism(self):
+        # Create a mirror of mirrors and try promoting the end mirror.
+        async with self.getTestAha() as aha:
+            async with await s_base.Base.anit() as base:
+                with self.getTestDir() as dirn:
+                    dirn00 = s_common.genpath(dirn, '00.cell')
+                    dirn01 = s_common.genpath(dirn, '01.cell')
+                    dirn02 = s_common.genpath(dirn, '02.cell')
+
+                    cell00 = await base.enter_context(self.addSvcToAha(aha, '00.cell', s_cell.Cell, dirn=dirn00))
+                    cell01 = await base.enter_context(self.addSvcToAha(aha, '01.cell', s_cell.Cell, dirn=dirn01,
+                                                                       provinfo={'mirror': '00.cell'}))
+                    cell02 = await base.enter_context(self.addSvcToAha(aha, '02.cell', s_cell.Cell, dirn=dirn02,
+                                                                       provinfo={'mirror': '01.cell'}))
+                    self.true(cell00.isactive)
+                    self.false(cell01.isactive)
+                    self.false(cell02.isactive)
+                    await cell02.sync()
+
+                    outp = self.getTestOutp()
+                    argv = ['--svcurl', cell02.getLocalUrl()]
+                    ret = await s_tools_promote.main(argv, outp=outp)
+                    self.eq(1, ret)
+                    outp.expect('Failed to promote service')
+                    # Note: The following message may change when SYN-7659 is addressed
+                    outp.expect('ahaname=01.cell is not the current leader and cannot handoff leadership to aha://02.cell.synapse')

synapse/tests/utils.py

@@ -201,6 +201,32 @@ class LibTst(s_stormtypes.Lib):
         ret = f'A {valu} beep which {bar} the {faz}!'
         return ret
 
+class LibDepr(s_stormtypes.Lib):
+    '''
+    Deprecate me!
+    '''
+    _storm_locals = (
+        {'name': 'boop',
+         'desc': '''
+         An example storm function that's not deprecated on its own, but the entire library is.
+         ''',
+         'type': {'type': 'function', '_funcname': 'boop',
+                  'args': (
+                      {'name': 'valu', 'type': 'str', 'desc': 'What to boop.', },
+                  ),
+                  'returns': {'type': 'str', 'desc': 'The booped.', }}},
+    )
+    _storm_lib_path = ('depr',)
+    _storm_lib_deprecation = {'eolvers': 'v3.0.0'}
+
+    def addLibFuncs(self):  # pragma: no cover
+        self.locls.update({
+            'boop': self.boop,
+        })
+
+    async def boop(self, valu):  # pragma: no cover
+        return f'You have been booped, {valu}!'
+
 class TestType(s_types.Type):
 
     stortype = s_layer.STOR_TYPE_UTF8

synapse/tools/promote.py

@@ -2,9 +2,12 @@ import sys
 import asyncio
 import argparse
 
+import synapse.exc as s_exc
+
 import synapse.telepath as s_telepath
 
 import synapse.lib.output as s_output
+import synapse.lib.urlhelp as s_urlhelp
 
 descr = '''
 Promote a mirror to the leader.
@@ -29,7 +32,17 @@ async def main(argv, outp=s_output.stdout):
             graceful = not opts.failure
 
             outp.printf(f'Promoting to leader: {opts.svcurl}')
-            await cell.promote(graceful=graceful)
+            try:
+                await cell.promote(graceful=graceful)
+            except s_exc.BadState as e:
+                mesg = f'Failed to promote service to being a leader; {e.get("mesg")}'
+                outp.printf(mesg)
+                return 1
+            except s_exc.SynErr as e:
+                outp.printf(f'Failed to promote service {s_urlhelp.sanitizeUrl(opts.svcurl)}: {e}')
+                return 1
+
+    return 0
 
 if __name__ == '__main__':  # pragma: no cover
     sys.exit(asyncio.run(main(sys.argv[1:])))

{synapse-2.183.0.dist-info → synapse-2.185.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: synapse
-Version: 2.183.0
+Version: 2.185.0
 Summary: Synapse Intelligence Analysis Framework
 Author-email: The Vertex Project LLC <root@vertex.link>
 License: Apache License 2.0
@@ -59,15 +59,10 @@ Requires-Dist: bump2version<1.1.0,>=1.0.1; extra == "dev"
 Requires-Dist: pytest-xdist<4.0.0,>=3.0.2; extra == "dev"
 Requires-Dist: coverage<8.0.0,>=7.0.0; extra == "dev"
 Provides-Extra: docs
-Requires-Dist: nbconvert<8.0.0,>=7.3.1; extra == "docs"
-Requires-Dist: jupyter-client<=8.2.0; extra == "docs"
-Requires-Dist: jupyter<2.0.0,>=1.0.0; extra == "docs"
-Requires-Dist: hide-code<0.8.0,>=0.7.0; extra == "docs"
-Requires-Dist: nbstripout<1.0.0,>=0.3.3; extra == "docs"
-Requires-Dist: sphinx<7.0.0,>=6.2.0; extra == "docs"
-Requires-Dist: sphinx-rtd-theme<2.0.0,>=1.0.0; extra == "docs"
-Requires-Dist: sphinx-notfound-page==0.8.3; extra == "docs"
-Requires-Dist: jinja2<3.1.0; extra == "docs"
+Requires-Dist: sphinx<9.0.0,>=8.0.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme<4.0.0,>=3.0.0; extra == "docs"
+Requires-Dist: sphinx-notfound-page<2.0.0,>=1.0.4; extra == "docs"
+Requires-Dist: jinja2<4.0.0,>=3.1.4; extra == "docs"
 
 Synapse
 =======