Metadata-Version: 2.1
Name: voiptests
Version: 1.0.0
Summary: VoIP Integrated Tests Suite
Home-page: https://github.com/sippy/voiptests/
Author: Sippy Software, Inc.
Author-email: sobomax@sippysoft.com
License: BSD
Keywords: ci,sip,b2bua,voip,rfc3261,sippy
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
License-File: LICENSE

[![CI](https://github.com/sippy/voiptests/workflows/CI/badge.svg)](https://github.com/sippy/voiptests/actions?query=branch%3Amaster++)

[![No More Travis CI :(](https://github.com/sippy/voiptests/raw/master/no_travisci.png)](https://travis-ci.com/github/sippy/voiptests/builds "Travis CI #NOMORE")

# VoIP Integrated Tests Suite

## Description

This is a "meta-repository" to test interoperability of several popular
open-source VoIP components and their ability to handle basic SIP call
scenarios, both individually and working as a simple VoIP switching system.

The basic test setup looks like the following:

![Alt text](https://docs.google.com/drawings/d/1vGkoxKZxv-acAAs5azTOApArSMWqBz9vIN83TXyIZAM/pub?w=960&h=720 "Test Setup")

In the course of the test, first UA, which we call "Alice", initiates number
of distinct SIP sessions to SSuT, which is configured to forward those
sessions to the second UA ("Bob") and pin the media to the RTPProxy. The Bob
either answers or rejects the specific session (depending on scenario id
passed in the user section of the RURI) and Alice verifies that the particular
scenario has completed in the expected way.

Both Alice and Bob also check that the SSuT rewrites the SDP correctly in
all relevant INVITEs, 183s, 200s and ACKs, replacing original random media
IP/port with the IP/port of the RTPProxy, which signifies proper execution
of the RTPProxy Control Protocol (RTPPC) between the particular SSuT and the
RTPProxy.

Also, upon test completion some basic statistics is pulled from the RTPProxy
to verify that the number of RTPPC requests/replies matches pre-determined
value specific for that SSuT and that there were no errors detected in the
protocol exchange or generated by the RTPProxy internal checkups.

## TODO

- Add more SSuTs (e.g. Asterisk, FreeSWITCH)

- Add more scenarios (e.g. SIP over IPv6, packet loss)

- Test actual media end-to-end via the RTPProxy / SSuT

- You name it :)
