ngcp-csc-ui/TESTDATA.md

CONVERSATIONS MODULE

IMPORTANT: This document is meant for internal use at Sipwise, as it requires a vagrant-ngcp environment to be able to generate the test data.

Here are both details on how to, for the /api/conversations endpoint that the conversations module is consuming, both manually and via database dump, create/import test data.

DATABASE DUMP

1. Spin up a fresh vagrant ngcp-csc environment
2. Download the test data database, available in this WF task under Documents: https://sipwise.attask-ondemand.com/task/view?ID=59ef06f4006d6e70b643d3599cd20655
3. Extract the test data database archive and add to shared vagrant volume, for example: cd ~/Downloads tar -xzvf conversations_dump.sql.tgz cp root/conversations_dump.sql.tgz ~/Sipwise/mr/
4. SSH in to the vagrant box and become root
5. Backup the existing database: mysqldump --extended-insert --complete-insert --add-drop-database --databases accounting billing carrier fileshare kamailio ldap prosody provisioning rtcengine > ~/backup_before_conversations_dump.sql
6. Import the test data database from your shared vagrant volume folder, for example: cd /usr/local/devel mysql < ./conversations_dump.sql

PBX

1. Before doing the individual test data creation steps below, make sure pbx is enabled
2. First SSH in to the vagrant box, become root and edit /etc/ngcp-config/config.yml vim /etc/ngcp-config/config.yml
3. Search for the "pbx:" section, and set "enable:" to yes
4. Then do ngcpcfg apply 'commit msg'

VOICEMAIL

1. Go to Settings > Subscribers > Details > Master Data, and set "Primary Number"/E164 to the desired number (for example 43993007)
2. Go to Settings > Subscribers > Details > Preferences, and under "Call Forwards" create a call forward destination under "Call Forward Unconditional" to voicemail
3. Initiate a call from another subscriber to the subscriber you just set call forward for, and leave a voicemail

See calls section for information on how to initiate calls.

SMS

1. SSH in to the vagrant box, become root, and edit config.yml, set sms: enable: yes, and enter sms credentials for all affected fields: https://wiki.sipwise.com/wiki/index.php/SMS
2. ngcpcfg apply 'commit msg'
3. Go to Settings > Subscribers, find subscriber you want to use, and click "Details"
4. Copy one of the numbers from wiki (link in step 1 above) and add to E164 Number field
5. Send sms from a mobile phone to E164 number
6. To troubleshoot you can check log: tail -f /var/log/kannel/sms*

For outgoing you need to use the api (also with E 164 number set to sms number from wiki). According to gjungwirth pretty simple with POST request containing the destination number and the content. 

FAX

1. Install exim package, so we can send the fax via mail. SSH in to vagrant box, become root, and then execute: dpkg-reconfigure exim4-config
2. Follow the install prompt by first choosing 'mail sent by smarthost; no local mail'
3. Then press enter for default sp1 selection, until you get asked for "IP address or host name of the outgoing smarthost:". There you enter mail.sipwise.com and press enter
4. For the rest of the prompts, press enter to choose the defaults
5. Go to Settings > Subscribers, find subscriber you want to use as caller, and click "Details"
6. Under "Master Data" click edit, and enter subscribers number also in the E164 field
7. Then go to "Preferences", and set "Fax2Mail and Sendfax" to active
8. Repeat the two steps above, this time for the callee
9. For the callee, you also need to add your internal sipwise email address as "Destination" under "Fax2Mail and Sendfax", and also under "Call Forwards" configure a "Call Forward Unconditional" to "Fax2Mail"
10. SSH in to the vagrant box, become root, and execute the following command to send a fax from one subscriber to another echo "Test Fax!" | ngcp-fax --caller 43993006 --callee 43993007
11. To troubleshoot you can check logs: tail -f /var/log/ngcp/faxserver.log tail -f /var/log/ngcp/kamailio-proxy.log

CALLS

Can be created by calling from one subscriber to another using the ngcp-csc-ui call (rtc:engine) feature.

Another option is to use a soft phone client such as linphone for desktop and mobile. Simply enter the subscriber username and password, and in the domain field enter the ip of the vagrant box you're using.

XMPP CHAT

Should be created using an xmpp client authenticating as subscribers, but have not been able to verify this.

MOCK DATA

You can also use mock data in src/api/conversations.js, replacing the jsonBody variable with this:

let jsonBody = getJsonBody( { "_embedded": { "ngcp:conversations": [ { "_links": { }, "call_id": "SZ8e64JkCq", "call_type": "call", "callee": "43993006", "caller": "43993007", "direction": "out", "duration": "0:00:08.592", "id": 3, "rating_status": "ok", "start_time": "2017-11-07 14:19:00.526", "status": "ok", "type": "call" }, { "_links": { }, "callee": "43993006", "caller": "43993007", "filename": "2cfb4c14-1958-472e-87a4-731ce5233514.tif", "id": 1, "pages": 0, "start_time": "2017-11-07 10:46:11", "status": "FAILED", "subscriber_id": 235, "type": "fax" }, { "_links": { }, "callee": "43993006", "caller": "43993007", "filename": "264ba55c-e23c-4d41-8493-f096bb98add9.tif", "id": 3, "pages": 0, "start_time": "2017-11-07 10:49:23", "status": "FAILED", "subscriber_id": 235, "type": "fax" }, { "_links": { }, "call_type": "cfu", "callee": "43993007", "caller": "vmu43993006@voicebox.local", "direction": "out", "duration": "0:00:06.854", "id": 4, "rating_status": "ok", "start_time": "2017-11-07 15:21:55", "status": "ok", "type": "call" }, ] }, "_links": { "curies": { "href": "http://purl.org/sipwise/ngcp-api/#rel-{rel}", "name": "ngcp", "templated": true }, "ngcp:conversations": [ { "href": "/api/conversations/4?type=call" }, { "href": "/api/conversations/1?type=fax" }, { "href": "/api/conversations/4?type=fax" } ], "profile": { "href": "http://purl.org/sipwise/ngcp-api/" }, "self": { "href": "/api/conversations/?page=1&rows=10" } }, "total_count": 4 } )