Get random socket address

.gitignore

@@ -42,6 +42,7 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *,cover
+.pytest_cache
 
 # Translations
 *.mo
@@ -55,3 +56,6 @@ docs/_build/
 
 # PyBuilder
 target/
+
+# PyCharm
+.idea/

.travis.yml

@@ -1,6 +1,4 @@
 language: python
-sudo: false
-dist: precise
 
 cache:
   - bundler
@@ -10,8 +8,9 @@ python:
   - 2.7
   - 3.5
   - 3.6
+  # - 3.7
   - nightly
-  - pypy
+  # - pypy
   # - pypy3
 
 addons:
@@ -29,9 +28,11 @@ install:
   - pip list
 
 before_script:
-  - git clone https://github.com/SIPp/sipp.git
-  - cd sipp
-  - ./build.sh
+  - wget https://github.com/SIPp/sipp/releases/download/v3.5.2/sipp-3.5.2.tar.gz
+  - tar -xvzf sipp-3.5.2.tar.gz
+  - cd sipp-3.5.2
+  - ./configure
+  - make
   - export PATH="$PWD:$PATH"
   - cd ..
 

README.md

@@ -20,7 +20,8 @@ Python configuring and launching the infamous
 ## It doesn't try to
 
 - Auto-generate SIPp XML scripts like [sippy_cup](https://github.com/mojolingo/sippy_cup)
-  * we believe this is the wrong way to work around the problem of SIPp's shitty XML control language
+  * `pysipp` in no way tries to work around the problem of SIPp's awful
+    XML control language; your current scenario scripts are compatible!
 
 
 ## Basic Usage
@@ -41,6 +42,15 @@ uas(block=False)  # returns a `pysipp.launch.PopenRunner` instance by default
 uac()  # run client synchronously
 ```
 
+## Authentication
+When using the `[authentication]` [sipp keyword](https://sipp.readthedocs.io/en/latest/scenarios/keywords.html#authentication)
+in scenarios, providing the credentials can be done with the
+`auth_username` and `auth_password` arguments, for example:
+
+```python
+pysipp.client(auth_username='sipp', auth_password='sipp-pass')
+```
+
 ## Multiple Agents
 For multi-UA orchestrations we can use a `pysipp.scenario`.
 The scenario from above is the default agent configuration:
@@ -73,6 +83,15 @@ scen = pysipp.scenario(dirpath='path/to/test_scenario/',
 scen()
 ```
 
+**pysipp** by default uses `-screen_file` SIPp argument to redirect output,
+ but this argument is only available in SIPp version >= [3.5.0](https://sourceforge.net/p/sipp/mailman/message/34041962/),
+ for lower versions to run properly, this argument must be
+  disable setting `enable_screen_file` to `False`:
+
+```python
+scen = pysipp.scenario(enable_screen_file=False)
+```
+
 If you've got multiple such scenario directories you can iterate over
 them:
 
@@ -157,7 +176,8 @@ pysipp.utils.log_to_stderr("DEBUG")
 ### Applying default settings
 For now see [#4](https://github.com/SIPp/pysipp/issues/4)
 
-More to come...
+## More to come?
+- document attributes / flags
 - writing plugins
 - using a `pysipp_conf.py`
 - remote execution

pysipp/__init__.py

@@ -109,10 +109,10 @@ def scenario(dirpath=None, proxyaddr=None, autolocalsocks=True,
                 scenkwargs=scenkwargs
             )
 
-            if proxyaddr:
-                assert isinstance(
-                    proxyaddr, tuple), 'proxyaddr must be a (addr, port) tuple'
-                scen.clientdefaults.proxyaddr = proxyaddr
+    if proxyaddr:
+        assert isinstance(
+            proxyaddr, tuple), 'proxyaddr must be a (addr, port) tuple'
+        scen.clientdefaults.proxyaddr = proxyaddr
 
     return scen
 

pysipp/agent.py

@@ -16,7 +16,6 @@
 
 
 def tuple_property(attrs):
-
     def getter(self):
         tup = tuple(getattr(self, attr) for attr in attrs)
         if all(tup):
@@ -77,10 +76,11 @@ def is_client(self):
     def is_server(self):
         return 'uas' in self.name.lower()
 
-    def iter_logfile_items(self, types_attr='_log_types'):
+    def iter_logfile_items(self, types_attr='_log_types', enable_screen_file=True):
         for name in getattr(self, types_attr):
-            attr_name = name + '_file'
-            yield attr_name, getattr(self, attr_name)
+            if name != 'screen' or enable_screen_file:
+                attr_name = name + '_file'
+                yield attr_name, getattr(self, attr_name)
 
     def iter_toconsole_items(self):
         yield 'screen_file', self.screen_file
@@ -118,11 +118,11 @@ def enable_tracing(self):
             attr_name = 'trace_' + name
             setattr(self, attr_name, True)
 
-    def enable_logging(self, logdir=None, debug=False):
+    def enable_logging(self, logdir=None, debug=False, enable_screen_file=True):
         """Enable agent logging by appending appropriately named log file
         arguments to the underlying command.
         """
-        logattrs = self.iter_logfile_items()
+        logattrs = self.iter_logfile_items(enable_screen_file=enable_screen_file)
         if debug:
             logattrs = itertools.chain(
                 logattrs,
@@ -233,8 +233,9 @@ class ScenarioType(object):
 
     If called it will invoke the standard run hooks.
     """
+
     def __init__(self, agents, defaults, clientdefaults=None,
-                 serverdefaults=None, confpy=None):
+                 serverdefaults=None, confpy=None, logs=True, enable_screen_file=True):
         # agents iterable in launch-order
         self._agents = agents
         ua_attrs = UserAgent.keys()
@@ -253,6 +254,8 @@ def __init__(self, agents, defaults, clientdefaults=None,
 
         # hook module
         self.mod = confpy
+        self.enable_screen_file = enable_screen_file
+        self.logs = logs
 
     @property
     def agents(self):
@@ -330,6 +333,7 @@ def prepare_agent(self, agent):
         """Return a new agent with all default settings applied from this
         scenario
         """
+
         def merge(dicts):
             """Merge dicts without clobbering up to 1 level deep's worth of
             sub-dicts
@@ -359,12 +363,15 @@ def merge(dicts):
         # apply defaults
         ordered = [self._defaults, secondary, agent.todict()]
         for name, defs in zip(['defaults', dname, 'agent.todict()'], ordered):
-            log.debug("'{}' contents:\n{}".format(name, defs))
+            log.debug("{} '{}' contents:\n{}".format(agent.name, name, defs))
 
         params = merge(ordered)
-        log.debug("merged contents:\n{}".format(params))
+        log.debug("{} merged contents:\n{}".format(agent.name, params))
         ua = UserAgent(defaults=params)
-        ua.enable_logging()
+
+        ua.enable_logging(enable_screen_file=self.enable_screen_file)
+        if self.logs:
+            ua.enable_logging()
 
         # call post defaults hook
         plugin.mng.hook.pysipp_post_ua_defaults(ua=ua)

pysipp/command.py

@@ -188,8 +188,6 @@ def todict(self):
     # contact info
     '{prefix} ',
     '{bin_path} ',
-    ('{remote_host}', AddrField),  # NOTE: no space
-    ':{remote_port} ',
     ('-i {local_host} ', AddrField),
     '-p {local_port} ',
     '-s {uri_username} ',
@@ -214,6 +212,7 @@ def todict(self):
     # SIP vars
     '-cid_str {cid_str} ',
     '-base_cseq {base_cseq} ',
+    '-au {auth_username} ',
     '-ap {auth_password} ',
     # load settings
     '-r {rate} ',
@@ -244,6 +243,8 @@ def todict(self):
     ('-trace_logs {trace_log}', BoolField),
     ('-trace_screen {trace_screen}', BoolField),
     ('-error_overwrite {error_overwrite}', BoolField),
+    ('{remote_host}', AddrField),  # NOTE: no space
+    ':{remote_port}',
 ]
 
 

pysipp/launch.py

@@ -32,12 +32,12 @@ def __init__(
         self,
         subprocmod=subprocess,
         osmod=os,
-        poller=select.epoll,
+        select=select.select,
     ):
         # these could optionally be rpyc proxy objs
         self.spm = subprocmod
         self.osm = osmod
-        self.poller = poller()
+        self.select = select
         # collector thread placeholder
         self._waiter = None
         # store proc results
@@ -67,11 +67,9 @@ def __call__(self, cmds, block=True, rate=300, **kwargs):
                 stderr=sp.PIPE
             )
             fd = proc.stderr.fileno()
-            log.debug("registering fd '{}' for pid '{}'".format(
-                fd, proc.pid))
+            log.debug("registering fd '{}' for pid '{}'".format(fd, proc.pid))
             fds2procs[fd] = self._procs[cmd] = proc
-            # register for stderr hangup events
-            self.poller.register(proc.stderr.fileno(), select.EPOLLHUP)
+
             # limit launch rate
             time.sleep(1. / rate)
 
@@ -87,15 +85,39 @@ def _wait(self, fds2procs):
         signalled = None
         left = len(fds2procs)
         collected = 0
+        p2fd = {p: p.stderr for p in fds2procs.values()}
+        stderrs = {p: [] for p in fds2procs.values()}
+
+        # wait on stderr hangup events
         while collected < left:
-            pairs = self.poller.poll()  # wait on hangup events
-            log.debug("received hangup for pairs '{}'".format(pairs))
-            for fd, status in pairs:
+            try:
+                fds, _, _ = self.select(list(p2fd.values()), [], [])
+            except ValueError:
+                # all fds are now closed
+                hungup = p2fd.keys()
+            else:
+                hungup = []
+                for proc in (fds2procs[fd.fileno()] for fd in fds):
+                    data = proc.stderr.read()
+                    if data != '':
+                        stderrs[proc].append(data)  # append stderr
+                        continue
+
+                    p2fd.pop(proc)
+                    hungup.append(proc)
+
+                if not hungup:
+                    continue
+
+            for proc in hungup:
+                log.debug("received hangup for pid '{}'".format(proc.pid))
                 collected += 1
-                proc = fds2procs[fd]
                 # attach streams so they can be read more then once
                 log.debug("collecting streams for {}".format(proc))
-                proc.streams = Streams(*proc.communicate())  # timeout=2))
+                proc.streams = Streams(
+                    stdout=proc.communicate()[0],
+                    stderr=''.join(stderrs[proc]),
+                )  # timeout=2))
                 if proc.returncode != 0 and not signalled:
                     # stop all other agents if there is a failure
                     signalled = self.stop()

pysipp/netplug.py

@@ -10,12 +10,12 @@ def getsockaddr(host, family=socket.AF_INET, port=0, sockmod=socket):
     binding to an ip, acquiring a random port and then
     closing the socket and returning that address.
 
-    ..warning:: Obviously this is not guarateed to be an unused address
+    ..warning:: Obviously this is not guaranteed to be an unused address
         since we don't actually keep it bound, so there may be a race with
         other processes acquiring the addr before our SIPp process re-binds.
     """
     for fam, stype, proto, _, sa in socket.getaddrinfo(
-        host, port, family, socket.SOCK_DGRAM, 0, socket.AI_PASSIVE,
+            host if host else '127.0.0.1', port, family, socket.SOCK_DGRAM, 0, socket.AI_PASSIVE,
     ):
         s = socket.socket(family, stype, proto)
         s.bind(sa)

setup.py

@@ -36,7 +36,7 @@
     url='https://github.com/SIPp/pysipp',
     platforms=['linux'],
     packages=['pysipp', 'pysipp.cli'],
-    install_requires=['pluggy==0.3.1'],
+    install_requires=['pluggy==0.11.0'],
     tests_require=['pytest'],
     entry_points={
         'console_scripts': [

tests/test_launcher.py

@@ -29,12 +29,12 @@ def test_agent_fails():
     assert uasproc.streams.stderr
     assert uasproc.returncode == 255, uasproc.streams.stderr
 
-    # killed by signal
+    # times out (can't do by signal - SIPp issue #176)
     uacproc = runner.get(timeout=0)[uac.render()]
     # assert not uacproc.streams.stderr  # sometimes this has a log msg?
     ret = uacproc.returncode
-    # killed by SIGUSR1 or terminates before it starts (racy)
-    assert ret == -10 or ret == 0
+    # timed out or terminates before it starts (racy)
+    assert ret == -10 or ret == 0 or ret == 1
 
 
 def test_default_scen(default_agents):

tests/test_stack.py

@@ -52,6 +52,25 @@ def test_confpy_hooks(scendir):
         assert agent.uri_username == 'doggy'
 
 
+def test_proxyaddr_with_scendir(scendir):
+    """When building a scenario from a xml file directory the
+    `proxyaddr` kwarg should be assigned.
+    """
+    remoteaddr = ('9.9.9.9', 80)
+    scen = pysipp.scenario(
+        dirpath=scendir + '/default_with_confpy',
+        proxyaddr=remoteaddr
+    )
+
+    assert scen.clientdefaults.proxyaddr == remoteaddr
+    for name, cmd in scen.cmditems():
+        if name == 'uac':
+            assert "-rsa '{}':'{}'".format(*remoteaddr) in cmd
+            assert "'{}':'{}'".format(*scen.clientdefaults.destaddr) in cmd
+        elif name == 'uas':
+            assert "-rsa '{}':'{}'".format(*remoteaddr) not in cmd
+
+
 def test_sync_run(scenwalk):
     """Ensure all scenarios in the test run to completion in synchronous mode
     """