synapse 2.215.0__py311-none-any.whl → 2.216.0__py311-none-any.whl

synapse/tools/changelog.py

@@ -1,11 +1,8 @@
 import os
 import re
-import sys
 import copy
 import gzip
 import pprint
-import asyncio
-import argparse
 import datetime
 import tempfile
 import textwrap
@@ -19,6 +16,7 @@ import synapse.exc as s_exc
 import synapse.common as s_common
 import synapse.cortex as s_cortex
 
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 import synapse.lib.autodoc as s_autodoc
 import synapse.lib.schemas as s_schemas
@@ -458,7 +456,7 @@ def _getModelFile(fp: str) -> dict | None:
         ref_modl = s_common.yamlloads(large_bytz)
     return ref_modl
 
-async def gen(opts: argparse.Namespace,
+async def gen(opts: s_cmd.argparse.Namespace,
               outp: s_output.OutPut):
 
     name = opts.name
@@ -806,7 +804,7 @@ def _gen_model_rst(version, model_ref, changes, current_model, outp: s_output.Ou
     return rst
 
 
-async def format(opts: argparse.Namespace,
+async def format(opts: s_cmd.argparse.Namespace,
            outp: s_output.OutPut):
 
     if not regex.match(version_regex, opts.version):
@@ -976,7 +974,7 @@ async def format(opts: argparse.Namespace,
 
     return 0
 
-async def model(opts: argparse.Namespace,
+async def model(opts: s_cmd.argparse.Namespace,
            outp: s_output.OutPut):
 
     if opts.save:
@@ -1017,11 +1015,8 @@ async def model(opts: argparse.Namespace,
             outp.printf(line)
         return 0
 
-async def main(argv, outp=None):
-    if outp is None:
-        outp = s_output.OutPut()
-
-    pars = makeargparser()
+async def main(argv, outp=s_output.stdout):
+    pars = getArgParser(outp)
 
     opts = pars.parse_args(argv)
     if opts.git_dir_check:
@@ -1038,11 +1033,11 @@ async def main(argv, outp=None):
         outp.printf(f'Error running {opts.func}: {traceback.format_exc()}')
     return 1
 
-def makeargparser():
+def getArgParser(outp: s_output.OutPut):
     desc = '''Command line tool to manage changelog entries.
     This tool and any data formats associated with it may change at any time.
     '''
-    pars = argparse.ArgumentParser('synapse.tools.changelog', description=desc)
+    pars = s_cmd.Parser(prog='synapse.tools.changelog', outp=outp, description=desc)
 
     subpars = pars.add_subparsers(required=True,
                                   title='subcommands',
@@ -1059,7 +1054,7 @@ def makeargparser():
                           help='Add the newly created file to the current git staging area.')
     # Hidden name override. Mainly for testing.
     gen_pars.add_argument('-n', '--name', default=None, type=str,
-                          help=argparse.SUPPRESS)
+                          help=s_cmd.argparse.SUPPRESS)
 
     format_pars = subpars.add_parser('format', help='Format existing files into a RST block.')
     format_pars.set_defaults(func=format)
@@ -1101,10 +1096,11 @@ def makeargparser():
                        help='Enable verbose output')
         p.add_argument('--cdir', default='./changes', action='store',
                        help='Directory of changelog files.')
+        # Hidden name override. Mainly for testing.
         p.add_argument('--disable-git-dir-check', dest='git_dir_check', default=True, action='store_false',
-                       help=argparse.SUPPRESS)
+                       help=s_cmd.argparse.SUPPRESS)
 
     return pars
 
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(main(sys.argv[1:], s_output.stdout)))
+    s_cmd.exitmain(main)

synapse/tools/cmdr.py

@@ -1,15 +1,12 @@
-import sys
-import asyncio
 import logging
 import warnings
-import contextlib
 
 import synapse.exc as s_exc
 import synapse.common as s_common
 import synapse.telepath as s_telepath
 
+import synapse.lib.cmd as s_cmd
 import synapse.lib.cmdr as s_cmdr
-import synapse.lib.coro as s_coro
 import synapse.lib.version as s_version
 
 logger = logging.getLogger(__name__)
@@ -52,9 +49,8 @@ async def main(argv):  # pragma: no cover
 
     async with s_telepath.withTeleEnv():
         await _main(argv)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
     return 0
 
 if __name__ == '__main__':  # pragma: no cover
     warnings.filterwarnings("default", category=PendingDeprecationWarning)
-    sys.exit(asyncio.run(main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/cryo/cat.py

@@ -1,44 +1,35 @@
 import sys
 import pprint
-import asyncio
 import argparse
-import logging
 
 import synapse.telepath as s_telepath
 
+import synapse.lib.cmd as s_cmd
 import synapse.lib.json as s_json
 import synapse.lib.output as s_output
 import synapse.lib.msgpack as s_msgpack
 
-logger = logging.getLogger(__name__)
-
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='cryo.cat', description='display data items from a cryo cell')
+    pars = s_cmd.Parser(prog='synapse.tools.cryo.cat', outp=outp, description='display data items from a cryo cell')
     pars.add_argument('cryotank', help='The telepath URL for the remote cryotank.')
     pars.add_argument('--offset', default=0, type=int, help='Begin at offset index')
     pars.add_argument('--size', default=10, type=int, help='How many items to display')
     pars.add_argument('--omit-offset', default=False, action='store_true', help='Output raw items with no offsets.')
-    # TODO: synapse.tools.cryo.list <cryocell>
-    # pars.add_argument('--list', default=False, action='store_true', help='List tanks in the remote cell and return')
     group = pars.add_mutually_exclusive_group()
     group.add_argument('--jsonl', action='store_true', help='Input/Output items in jsonl format')
     group.add_argument('--msgpack', action='store_true', help='Input/Output items in msgpack format')
-    pars.add_argument('--verbose', '-v', default=False, action='store_true', help='Verbose output')
+    pars.add_argument('--verbose', '-v', default=False, action='store_true',
+                      help='Verbose output. This argument is deprecated and no longer has any effect.')
     pars.add_argument('--ingest', '-i', default=False, action='store_true',
                       help='Reverses direction: feeds cryotank from stdin in msgpack or jsonl format')
 
     opts = pars.parse_args(argv)
 
-    if opts.verbose:
-        logger.setLevel(logging.INFO)
-
     if opts.ingest and not opts.jsonl and not opts.msgpack:
         outp.printf('Must specify exactly one of --jsonl or --msgpack if --ingest is specified')
         return 1
 
-    logger.info(f'connecting to: {opts.cryotank}')
-
     async with s_telepath.withTeleEnv():
 
         async with await s_telepath.openurl(opts.cryotank) as tank:
@@ -67,5 +58,4 @@ async def main(argv, outp=s_output.stdout):
     return 0
 
 if __name__ == '__main__':  # pragma: no cover
-    logging.basicConfig()
-    sys.exit(asyncio.run(main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/cryo/list.py

@@ -1,17 +1,11 @@
-import sys
-import logging
-import asyncio
-import argparse
-
 import synapse.telepath as s_telepath
 
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 
-logger = logging.getLogger(__name__)
-
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='cryo.list', description='List tanks within a cryo cell.')
+    pars = s_cmd.Parser(prog='synapse.tools.cryo.list', outp=outp, description='List tanks within a cryo cell.')
     pars.add_argument('cryocell', nargs='+', help='Telepath URLs to cryo cells.')
 
     opts = pars.parse_args(argv)
@@ -30,5 +24,4 @@ async def main(argv, outp=s_output.stdout):
     return 0
 
 if __name__ == '__main__':  # pragma: no cover
-    logging.basicConfig()
-    sys.exit(asyncio.run(main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/csvtool.py

@@ -1,7 +1,4 @@
 import csv
-import sys
-import asyncio
-import contextlib
 
 import synapse.exc as s_exc
 import synapse.cortex as s_cortex
@@ -16,6 +13,44 @@ import synapse.lib.output as s_output
 import synapse.lib.version as s_version
 
 reqver = '>=0.2.0,<3.0.0'
+desc = '''Command line tool for ingesting csv files into a cortex
+
+The storm file is run with the CSV rows specified in the variable "rows" so most
+storm files will use a variable based for loop to create edit nodes.  For example:
+
+for ($fqdn, $ipv4, $tag) in $rows {
+
+    [ inet:dns:a=($fqdn, $ipv4) +#$tag ]
+
+}
+
+More advanced uses may include switch cases to provide different logic based on
+a column value.
+
+for ($type, $valu, $info) in $rows {
+
+    switch $type {
+
+        fqdn: {
+            [ inet:fqdn=$valu ]
+        }
+
+        "person name": {
+            [ ps:name=$valu ]
+        }
+
+        *: {
+            // default case...
+        }
+
+    }
+
+    switch $info {
+        "known malware": { [+#cno.mal] }
+    }
+
+}
+'''
 
 async def runCsvExport(opts, outp, text, stormopts):
     if not opts.cortex:
@@ -174,46 +209,7 @@ async def main(argv, outp=s_output.stdout):
             return await runCsvImport(opts, outp, text, stormopts)
 
 def makeargparser(outp):
-    desc = '''
-    Command line tool for ingesting csv files into a cortex
-
-    The storm file is run with the CSV rows specified in the variable "rows" so most
-    storm files will use a variable based for loop to create edit nodes.  For example:
-
-    for ($fqdn, $ipv4, $tag) in $rows {
-
-        [ inet:dns:a=($fqdn, $ipv4) +#$tag ]
-
-    }
-
-    More advanced uses may include switch cases to provide different logic based on
-    a column value.
-
-    for ($type, $valu, $info) in $rows {
-
-        switch $type {
-
-            fqdn: {
-                [ inet:fqdn=$valu ]
-            }
-
-            "person name": {
-                [ ps:name=$valu ]
-            }
-
-            *: {
-                // default case...
-            }
-
-        }
-
-        switch $info {
-            "known malware": { [+#cno.mal] }
-        }
-
-    }
-    '''
-    pars = s_cmd.Parser('synapse.tools.csvtool', description=desc, outp=outp)
+    pars = s_cmd.Parser(prog='synapse.tools.csvtool', description=desc, outp=outp)
     pars.add_argument('--logfile', help='Set a log file to get JSON lines from the server events.')
     pars.add_argument('--csv-header', default=False, action='store_true',
                       help='Skip the first line from each CSV file.')
@@ -235,10 +231,5 @@ def makeargparser(outp):
     pars.add_argument('csvfiles', nargs='+', help='CSV files to load.')
     return pars
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/demote.py

@@ -1,7 +1,3 @@
-import sys
-import asyncio
-import argparse
-
 import synapse.exc as s_exc
 
 import synapse.telepath as s_telepath
@@ -19,8 +15,7 @@ Example:
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='synapse.tools.demote', description=descr,
-                        formatter_class=argparse.RawDescriptionHelpFormatter)
+    pars = s_cmd.Parser(prog='synapse.tools.demote', outp=outp, description=descr)
 
     pars.add_argument('--url', default='cell:///vertex/storage',
                       help='The telepath URL of the Synapse service.')

synapse/tools/docker/validate.py

@@ -1,4 +1,3 @@
-import os
 import re
 import sys
 import base64

synapse/tools/easycert.py

@@ -1,9 +1,7 @@
-
-import sys
 import argparse
 
-
 import synapse.exc as s_exc
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 import synapse.lib.certdir as s_certdir
 
@@ -11,10 +9,7 @@ descr = '''
 Command line tool to generate simple x509 certs
 '''
 
-def main(argv, outp=None):
-
-    if outp is None:  # pragma: no cover
-        outp = s_output.OutPut()
+def main(argv, outp=s_output.stdout):
 
     pars = argparse.ArgumentParser(prog='easycert', description=descr)
     pars.add_argument('--certdir', default='~/.syn/certs', help='Directory for certs/keys')
@@ -138,4 +133,4 @@ def main(argv, outp=None):
         return 1
 
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(main(sys.argv[1:]))
+    s_cmd.exitmain(main)

synapse/tools/feed.py

@@ -1,17 +1,14 @@
 import os
-import sys
 import time
-import asyncio
 import logging
-import argparse
 
 import synapse.exc as s_exc
 import synapse.common as s_common
 import synapse.cortex as s_cortex
 import synapse.telepath as s_telepath
 
+import synapse.lib.cmd as s_cmd
 import synapse.lib.cmdr as s_cmdr
-import synapse.lib.coro as s_coro
 import synapse.lib.json as s_json
 import synapse.lib.output as s_output
 import synapse.lib.msgpack as s_msgpack
@@ -79,12 +76,9 @@ async def addFeedData(core, outp, feedformat, debug=False, *paths, chunksize=100
     if debug:
         await s_cmdr.runItemCmdr(core, outp, True)
 
-async def main(argv, outp=None):
+async def main(argv, outp=s_output.stdout):
 
-    if outp is None:  # pragma: no cover
-        outp = s_output.OutPut()
-
-    pars = makeargparser()
+    pars = getArgParser(outp)
     opts = pars.parse_args(argv)
 
     if opts.offset:
@@ -124,9 +118,9 @@ async def main(argv, outp=None):
 
     return 0
 
-def makeargparser():
+def getArgParser(outp):
     desc = 'Command line tool for ingesting data into a cortex'
-    pars = argparse.ArgumentParser('synapse.tools.feed', description=desc)
+    pars = s_cmd.Parser(prog='synapse.tools.feed', outp=outp, description=desc)
 
     muxp = pars.add_mutually_exclusive_group(required=True)
     muxp.add_argument('--cortex', '-c', type=str,
@@ -150,11 +144,6 @@ def makeargparser():
 
     return pars
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    s_common.setlogging(logger, 'DEBUG')
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_common.setlogging(logger, 'DEBUG')
+    s_cmd.exitmain(main)

synapse/tools/genpkg.py

@@ -1,10 +1,7 @@
 import io
 import os
-import sys
 import base64
-import asyncio
 import logging
-import argparse
 
 import regex
 
@@ -12,7 +9,7 @@ import synapse.exc as s_exc
 import synapse.common as s_common
 import synapse.telepath as s_telepath
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.json as s_json
 import synapse.lib.output as s_output
 import synapse.lib.certdir as s_certdir
@@ -238,12 +235,11 @@ def loadPkgProto(path, opticdir=None, no_docs=False, readonly=False):
     return pkgdef
 
 
-prog = 'synapse.tools.genpkg'
 desc = 'A tool for generating/pushing storm packages from YAML prototypes.'
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser()
+    pars = s_cmd.Parser(prog='synapse.tools.genpkg', outp=outp, description=desc)
     pars.add_argument('--push', metavar='<url>', help='A telepath URL of a Cortex or PkgRepo.')
     pars.add_argument('--push-verify', default=False, action='store_true',
                       help='Tell the Cortex to verify the package signature.')
@@ -306,10 +302,5 @@ async def main(argv, outp=s_output.stdout):
 
     return 0
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/guid.py

@@ -1,12 +1,10 @@
+import sys
+
 import synapse.common as s_common
 import synapse.lib.output as s_output
 
-def main(argv, outp=None):
-    if outp is None:  # pragma: no cover
-        outp = s_output.OutPut()
-
+def main(argv, outp=s_output.stdout):
     outp.printf(s_common.guid())
 
 if __name__ == '__main__':  # pragma: no cover
-    import sys
-    sys.exit(main(sys.argv))
+    sys.exit(main(sys.argv[1:]))

synapse/tools/healthcheck.py

@@ -1,4 +1,3 @@
-import sys
 import socket
 import asyncio
 
@@ -7,7 +6,6 @@ import synapse.common as s_common
 import synapse.telepath as s_telepath
 
 import synapse.lib.cmd as s_cmd
-import synapse.lib.coro as s_coro
 import synapse.lib.json as s_json
 import synapse.lib.output as s_output
 import synapse.lib.health as s_health
@@ -30,7 +28,7 @@ def format_component(e, mesg: str) -> dict:
     return d
 
 async def main(argv, outp=s_output.stdout):
-    pars = makeargparser()
+    pars = getArgParser(outp)
     try:
         opts = pars.parse_args(argv)
     except s_exc.ParserExit as e:  # pragma: no cover
@@ -96,21 +94,16 @@ async def main(argv, outp=s_output.stdout):
     outp.printf(serialize(ret))
     return retval
 
-def makeargparser():
+def getArgParser(outp):
     desc = '''
     synapse healthcheck tool
     '''
-    pars = s_cmd.Parser('healthcheck', description=desc)
+    pars = s_cmd.Parser(prog='synapse.tools.healthcheck', outp=outp, description=desc)
     pars.add_argument('--cell', '-c', required=True, type=str,
                       help='Telepath path to the cell to check.')
     pars.add_argument('--timeout', '-t', default=10, type=float,
                       help='Connection and call timeout')
     return pars
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/json2mpk.py

@@ -12,11 +12,7 @@ def getArgParser():
     pars.add_argument('paths', nargs='+', help='json files or directories full of json files')
     return pars
 
-def main(argv, outp=None):
-
-    if outp is None:  # pragma: no cover
-        outp = s_output.OutPut()
-
+def main(argv, outp=s_output.stdout):
     pars = getArgParser()
     opts = pars.parse_args(argv)
 

synapse/tools/livebackup.py

@@ -1,10 +1,6 @@
-import sys
-import asyncio
-import argparse
-
 import synapse.telepath as s_telepath
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 
 descr = '''
@@ -19,8 +15,7 @@ Examples:
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='synapse.tools.livebackup', description=descr,
-                        formatter_class=argparse.RawDescriptionHelpFormatter)
+    pars = s_cmd.Parser(prog='synapse.tools.livebackup', outp=outp, description=descr)
 
     pars.add_argument('--url', default='cell:///vertex/storage', help='The telepath URL of the Synapse service.')
     pars.add_argument('--name', default=None, help='Specify a name for the backup.  Defaults to an automatically generated timestamp.')
@@ -35,10 +30,5 @@ async def main(argv, outp=s_output.stdout):
             outp.printf(f'...backup created: {name}')
     return 0
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/modrole.py

@@ -1,11 +1,7 @@
-import sys
-import asyncio
-import argparse
-
 import synapse.common as s_common
 import synapse.telepath as s_telepath
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 
 descr = '''
@@ -30,7 +26,7 @@ def printrole(role, outp):
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='modrole', description=descr)
+    pars = s_cmd.Parser(prog='synapse.tools.modrole', outp=outp, description=descr)
     pars.add_argument('--svcurl', default='cell:///vertex/storage', help='The telepath URL of the Synapse service.')
     pars.add_argument('--add', default=False, action='store_true', help='Add the role if they do not already exist.')
     pars.add_argument('--del', dest='delete', default=False, action='store_true', help='Delete the role if it exists.')
@@ -116,10 +112,5 @@ async def main(argv, outp=s_output.stdout):
                     await cell.addRoleRule(roleiden, (False, perm), indx=0, gateiden=opts.gate)
     return 0
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/moduser.py

@@ -1,11 +1,7 @@
-import sys
-import asyncio
-import argparse
-
 import synapse.common as s_common
 import synapse.telepath as s_telepath
 
-import synapse.lib.coro as s_coro
+import synapse.lib.cmd as s_cmd
 import synapse.lib.output as s_output
 
 descr = '''
@@ -41,7 +37,7 @@ def printuser(user, outp):
 
 async def main(argv, outp=s_output.stdout):
 
-    pars = argparse.ArgumentParser(prog='moduser', description=descr)
+    pars = s_cmd.Parser(prog='synapse.tools.moduser', outp=outp, description=descr)
     pars.add_argument('--svcurl', default='cell:///vertex/storage', help='The telepath URL of the Synapse service.')
     pars.add_argument('--add', default=False, action='store_true', help='Add the user if they do not already exist.')
     pars.add_argument('--del', dest='delete', default=False, action='store_true', help='Delete the user if they exist.')
@@ -187,10 +183,5 @@ async def main(argv, outp=s_output.stdout):
                     await cell.addUserRule(useriden, (False, perm), indx=0, gateiden=opts.gate)
     return 0
 
-async def _main(argv, outp=s_output.stdout):  # pragma: no cover
-    ret = await main(argv, outp=outp)
-    await asyncio.wait_for(s_coro.await_bg_tasks(), timeout=60)
-    return ret
-
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(asyncio.run(_main(sys.argv[1:])))
+    s_cmd.exitmain(main)

synapse/tools/pkgs/gendocs.py

@@ -28,7 +28,7 @@ def hasPandoc():
         return True
     return False
 
-async def buildPkgDocs(outp: s_output.OutPut, pkgpath: str, rst_only: bool =False):
+async def buildPkgDocs(outp, pkgpath: str, rst_only: bool =False):
 
     logger.info(f'Building pkg for {pkgpath}')
     pkgdef = s_common.yamlload(pkgpath)