`trio` subprocs launching #87

goodboy · 2022-12-18T20:47:54Z

Replacement for #55 after going through the slew of merge conflicts.

From that issue verbatim here is the original description:

This is in preparation of a python 3.6+ only 1.0.0.alpha release and replaces all the internal processing launching machinery with the new subprocess support in trio.

This not only gets us cross OS support for free but also gives access to async/await based scenario and agent spawning.

A few interesting notes:

SIPp turns out to be a good fit with trio cancellation semantics since it has a built in cancellation system via SIGUSR1
this now gives us a strictly single threaded implementation
trio gives us deterministic teardown allowing for much finer control over per agent failures and subsequent reporting

TODO:

adjust to the new trio proc spawning APIs and get CI running clean, also see
- process = await nursery.start(run_process, ...) python-trio/trio#1568 -> we need to pin to the appropriate trio version that this was merged to.
- i think we want the process = await nursery.start(trio.run_process, ...) form yah?
write some async spawning tests and examples in the readme
do we need this right away or can we add it in a follow up?
consider playing around with timeout and other cancellation tools such as trio.move_on_after() and trio.fail_after() and figure out how this can interplay with log reporting for interactive use
add the mac os env to CI

I look forward to feedback and thoughts!

goodboy · 2022-12-18T21:35:21Z

Looks like I've broken something using the new spawn api, not sure what.

I don't have the sipp binary installed locally atm so if someone wants to take a shot at repairing this (hint hint @linuxmaniac) please feel free!

linuxmaniac

before the changes I mentioned above:

================================================================================================================================ short test summary info ================================================================================================================================
FAILED tests/test_agent.py::test_failures[ua] - subprocess.CalledProcessError: Command '['/usr/bin/sipp', '-recv_timeout', '5000', '-r', '1', '-l', '1', '-m', '1', '-log_file', '/tmp/None_log_file', '-screen_file', '/tmp/None_screen_file', '-trace_logs', '-trace_screen']' returned non-zero exit status 255.
FAILED tests/test_agent.py::test_failures[uac] - subprocess.CalledProcessError: Command '['/usr/bin/sipp', '-sn', 'uac', '-recv_timeout', '5000', '-r', '1', '-l', '1', '-m', '1', '-log_file', '/tmp/uac_log_file', '-screen_file', '/tmp/uac_screen_file', '-trace_logs', '-trace_screen', '99.99.99.99:5060']' returned non-zero e...
FAILED tests/test_agent.py::test_failures[uas] - subprocess.CalledProcessError: Command '['/usr/bin/sipp', '-sn', 'uas', '-recv_timeout', '5000', '-r', '1', '-l', '1', '-m', '1', '-log_file', '/tmp/uas_log_file', '-screen_file', '/tmp/uas_screen_file', '-trace_logs', '-trace_screen']' died with <Signals.SIGKILL: 9>.
FAILED tests/test_launcher.py::test_agent_fails - subprocess.CalledProcessError: Command '['/usr/bin/sipp', '-i', '99.99.99.99', '-p', '5060', '-sn', 'uas', '-m', '1']' returned non-zero exit status 255.
FAILED tests/test_stack.py::test_async_run - TypeError: arun() got an unexpected keyword argument 'block'
FAILED tests/test_stack.py::test_unreachable_uas[autolocalsocks=True] - subprocess.CalledProcessError: Command '['/usr/bin/sipp', '-i', '127.0.1.1', '-p', '43212', '-rsa', '127.0.1.1:9999', '-mi', '127.0.1.1', '-mp', '33776', '-sn', 'uas', '-recv_timeout', '5000', '-r', '1', '-l', '1', '-m', '1', '-log_file', '/tmp/uas_log_file', '-screen_file', ...
FAILED tests/test_stack.py::test_unreachable_uas[autolocalsocks=False] - subprocess.CalledProcessError: Command '['/usr/bin/sipp', ':9999', '-sn', 'uas', '-recv_timeout', '5000', '-r', '1', '-l', '1', '-m', '1', '-log_file', '/tmp/uas_log_file', '-screen_file', '/tmp/uas_screen_file', '-trace_logs', '-trace_screen']' returned non-zero exit status ...
====================================================================================================================== 7 failed, 52 passed, 18 warnings in 28.35s =======================================================================================================================
ERROR: InvocationError for command /home/vseva/data/projects/pysipp/.tox/py39/bin/pytest tests/ (exited with code 1)
________________________________________________________________________________________________________________________________________ summary ________________________________________________________________________________________________________________________________________
ERROR:   py39: commands failed

after:

================================================================================================================================ short test summary info ================================================================================================================================
FAILED tests/test_stack.py::test_async_run - AttributeError: 'Scenario' object has no attribute 'finalize'
====================================================================================================================== 1 failed, 58 passed, 32 warnings in 37.54s =======================================================================================================================
ERROR: InvocationError for command /home/vseva/data/projects/pysipp/.tox/py39/bin/pytest tests/ (exited with code 1)
________________________________________________________________________________________________________________________________________ summary ________________________________________________________________________________________________________________________________________
ERROR:   py39: commands failed

linuxmaniac · 2022-12-19T19:27:52Z

pysipp/launch.py

+                shlex.split(cmd),
+                stdout=subprocess.DEVNULL,
+                stderr=subprocess.PIPE
+            )


check=False,

I think you need to disable check in order to avoid trio.run_process() to raise subprocess.CalledProcessError

Ah so this will resolve most of the failures then yah?

If you've already patched this please do make a PR onto this one, ow no worries but not sure when i'll get to this next.

linuxmaniac · 2022-12-19T19:29:52Z

pysipp/agent.py

        )
+
+    def __call__(self, *args, **kwargs):
+        # TODO: deprecation warning here


kwargs.pop("block", None)

I had to add this to avoid getting an error

linuxmaniac · 2022-12-19T19:31:08Z

pysipp/launch.py

+        msg = report.err_summary(agents2procs)
+        if msg:
+            # report logs and stderr
+            await report.emit_logfiles(agents2procs)


I had to remove await since report.emit_logfiles() doesn't return anything

linuxmaniac · 2022-12-19T19:32:52Z

tests/test_agent.py

@@ -124,9 +124,16 @@ def test_server():
 )
 def test_failures(ua, retcode, kwargs, exc):
    """Test failure cases for all types of agents"""
+    runner = launch.TrioRunner()


in line 121 you need to change 0 for -9, the new return value in timeout

linuxmaniac · 2022-12-19T19:35:34Z

tests/test_launcher.py

@@ -1,15 +1,22 @@
 """
 Basic agent/scenario launching
+


In line 92... scenarios doesn't have finalize()

Don't really know what to do in this case

linuxmaniac · 2022-12-19T19:48:08Z

BTW, some of the commits don't pass the pre-commit checks.

when rebasing, you should do git rebase -x 'pre-commit run --from HEAD^ --to HEAD' origin/master in order to force the execution of pre-commit checks per commit

goodboy · 2022-12-19T22:18:24Z

@linuxmaniac RE all the little changes you suggest, can you make a PR onto this branch to fix them if you've already gone through it?

linuxmaniac · 2022-12-19T23:14:49Z

@linuxmaniac RE all the little changes you suggest, can you make a PR onto this branch to fix them if you've already gone through it?

There you are #88

trio subprocs: small fixes for #87

goodboy · 2022-12-20T19:05:19Z

@linuxmaniac landed it 🏄🏼

After attempting to find an OS portable way to spawn subprocesses using the stdlib and coming out unsatisfied, I've decided use the new subprocess launching support in `trio`! This will of course require that the project moves to python 3.6+ giving us access to a lot of neat features of modern python including async/await support and adherence to the structured concurrency principles prominent in `trio`. It turns out this is a good fit since SIPp already has a built in cancellation mechanism via the SIGUSR1 signal. There's a lot of "core" changes to go over in this commit: - drop the "run protocol" and "runner creation" related hooks since they really shouldn't be overridden until there's some need for it and it's likely smarter to keep those "machinery" details strictly internal for now - the run "protocol" has now been relegated to an async function: `pysipp.launch.run_all_agents()` - many routines have been converted to async functions particularly at the runner (`pysipp.TrioRunner.run()`, `.get()`) and scenario (`pysipp.Scenario.arun()`) levels allowing us to expose both a sync and async interface for running subprocesses / agents - drop all the epoll/select loop stuff as this is entirely delegated to `trio.open_process()` and it's underlying machinery and APIs Resolves #53

goodboy · 2022-12-20T19:18:31Z

There rebased clean to master.

goodboy mentioned this pull request Dec 18, 2022

Drop py2.7 and add trio support! #55

Closed

This was referenced Dec 19, 2022

remove deprecation warnings #84

Merged

FileNotFoundError raised when sipp binanry not found #77

Open

OS support, Windows and OS X when? #60

Open

linuxmaniac suggested changes Dec 19, 2022

View reviewed changes

goodboy added a commit that referenced this pull request Dec 20, 2022

Merge pull request #88 from linuxmaniac/vseva/trio

6f524e4

trio subprocs: small fixes for #87

goodboy and others added 14 commits December 20, 2022 14:17

Drop runner related hooks

f7abaf1

Adjust tests to match new trio apis

ef1a19b

Drop py2.7 from CI

363ce2f

Prepare setup script for 1.0 release

84e4e12

trio.open_process() isn't released yet

ac24688

Be explicit on dev version

22ba429

Update readme to reflect python version requirement

cd9fd0c

Raise a runtime error when sipp binary can not beinvoked

15aeb38

Use the new trio.Nursery.start(trio.run_process, ..) API

995e805

trio: don't check return value of cmd by trio.run_process

fb73483

trio: remove deprecated block argument at __call__

44dffbd

trio: don't use await for report.emit_logfiles()

8146211

trio: fix test_server(), add new returncode for timeout

2e93c9a

goodboy force-pushed the trio_subprocs branch from 6f524e4 to 2e93c9a Compare December 20, 2022 19:18

goodboy requested a review from linuxmaniac December 20, 2022 19:20

This was referenced Mar 23, 2023

Any chance to get a 0.2.0 version? #90

Open

Can't use select.epoll() on non-linux, need #87 #89

Open

goodboy mentioned this pull request Mar 24, 2023

OS X support #17

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`trio` subprocs launching #87

`trio` subprocs launching #87

goodboy commented Dec 18, 2022 •

edited

Loading

goodboy commented Dec 18, 2022

linuxmaniac left a comment

linuxmaniac Dec 19, 2022

goodboy Dec 19, 2022

linuxmaniac Dec 19, 2022

linuxmaniac Dec 19, 2022

linuxmaniac Dec 19, 2022

linuxmaniac Dec 19, 2022

linuxmaniac Dec 19, 2022

linuxmaniac commented Dec 19, 2022

goodboy commented Dec 19, 2022

linuxmaniac commented Dec 19, 2022

goodboy commented Dec 20, 2022

goodboy commented Dec 20, 2022

trio subprocs launching #87

Are you sure you want to change the base?

trio subprocs launching #87

Conversation

goodboy commented Dec 18, 2022 • edited Loading

goodboy commented Dec 18, 2022

linuxmaniac left a comment

Choose a reason for hiding this comment

linuxmaniac Dec 19, 2022

Choose a reason for hiding this comment

goodboy Dec 19, 2022

Choose a reason for hiding this comment

linuxmaniac Dec 19, 2022

Choose a reason for hiding this comment

linuxmaniac Dec 19, 2022

Choose a reason for hiding this comment

linuxmaniac Dec 19, 2022

Choose a reason for hiding this comment

linuxmaniac Dec 19, 2022

Choose a reason for hiding this comment

linuxmaniac Dec 19, 2022

Choose a reason for hiding this comment

linuxmaniac commented Dec 19, 2022

goodboy commented Dec 19, 2022

linuxmaniac commented Dec 19, 2022

goodboy commented Dec 20, 2022

goodboy commented Dec 20, 2022

`trio` subprocs launching #87

`trio` subprocs launching #87

goodboy commented Dec 18, 2022 •

edited

Loading