README.md 2.03 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
CoAP Testing Tool:
------------------

This repo conaints all necessary software (and their dependencies) for running a 
CoAP interoperability test session.

This can be run as standalone software and also integrated to f-interop 
architecture.

### TODO
Federico Sismondi's avatar
Federico Sismondi committed
11
- add coap client automated IUT
12
- add feat for handling step by step analysis
Federico Sismondi's avatar
Federico Sismondi committed
13
- add more unit testing of coordinator component
14 15 16 17 18 19 20 21 22 23
- document isntallation of requirements and dependencies

### CoAP Testing tools components

The CoAP testing tool handles the coordination, sniffing, dissection and analysis of CoAP test suite.
It's based on the test scenarios and test cases described in 
[ETSI CoAP test description](http://www.etsi.org/plugtests/CoAP/Document/CoAP_TestDescriptions_v015.pdf)

For description of components please visit: [f-interop doc](doc.f-interop.eu)

Federico Sismondi's avatar
doc++  
Federico Sismondi committed
24 25 26 27 28 29
### Clonning the project
```
git clone --recursive git@gitlab.distantaccess.com:fsismondi/coap_testing_tool.git
cd coap_testing_tool
git submodule update --init --recursive
```
30 31 32 33 34 35 36 37

### Running it as standalone software

for debian based OS & macos:


- installation 

Federico Sismondi's avatar
Federico Sismondi committed
38 39
  - install locally RMQ broker on local machine
    - create RMQ vhost, user, pass on local machine
Federico Sismondi's avatar
Federico Sismondi committed
40
    
Federico Sismondi's avatar
doc++  
Federico Sismondi committed
41 42
    note: on a non-standalone deployment the RMQ broker is provided by f-interop
    
43
  - install supervisor (for spawning and monitoring processes)
Federico Sismondi's avatar
Federico Sismondi committed
44
  
Federico Sismondi's avatar
Federico Sismondi committed
45
- install testing tool requirements:
Federico Sismondi's avatar
Federico Sismondi committed
46 47
	change in anible/main.yml the variable unix_user from f-interop to your
	local unix user, then run ansible script:
Federico Sismondi's avatar
Federico Sismondi committed
48 49 50
    
    ```
    cd coap_testing_tool
51
    ansible-playbook -i ansible/hosts.local ansible/main.yml --ask-become-pass
Federico Sismondi's avatar
Federico Sismondi committed
52
    ```
53

Federico Sismondi's avatar
Federico Sismondi committed
54 55
- export credentials, server, and vhost for local RMQ connection: 
    
56
    ```
Federico Sismondi's avatar
Federico Sismondi committed
57
    export AMQP_URL='amqp://someUser:somePassword@server/amqp_vhost'
Federico Sismondi's avatar
Federico Sismondi committed
58
    export AMQP_EXCHANGE='default'
59 60 61
    ```

- run CoAP testing tool and monitor processes
Federico Sismondi's avatar
Federico Sismondi committed
62
    
63 64
    ```
    cd coap_testing_tool
65
    sudo -E supervisord -c supervisor.conf 
66 67 68
    sudo supervisorctl -c supervisor.conf  

    ```
Federico Sismondi's avatar
doc++  
Federico Sismondi committed
69
	note: use -E when launching supervisor process, it preserves the env vars
70 71 72