esds/tests/README.org

#+TITLE: Test Description
#+AUTHOR: Loic Guegan

Tests folders names convention:
 - m senders and n receivers is written "<m>s<n>r" (ex: "1s5r")
 - n nodes is written "<n>n" (ex: "5n")
 - Tests names follow the following format "<title>_<m>s<n>r" or "<title>_<n>n" (ex: "api_send_rcv_1s5r", "ping_pong_2n")
 - Tests that assess elementary API functions must start with the "api" keyword (ex: "api_send_rcv_1s5r")

This file keeps track of the tested features of ESDS.
 
* api_log_5n [1/1]
- [X] Logs are performed in order
* api_read_clock_2n [1/1]
- [X] Read the current simulated time
* api_read_eth0_ncom_2s1r [3/3]
- [X] No communication must means ncom_eth0=0
- [X] Work with 1 communication
- [X] Work with 2 communications
* api_read_order_ncom_1s2r [2/2]
- [X] Order of node instantiation (sender before receiver in simulator.py) must not matter on the results
   if a communication starts while read to the ncom register is performed
- [X] If a communication starts while read to ncom is performed, it must return 0 (deterministic rule)
* api_read_wlan0_ncom_2s1r [1/1]
- [X] Ensure similar behavior wlan0/eth0 for reads of the ncom registers
* api_receivet0_eth0_1s1r [1/1]
- [X] receivet() with a timeout of 0 must be able to receive the data while keeping the simulated time unchange
* api_receivet_eth0_1s1r [3/3]
- [X] If timeout do not expire, receivet() must return the receive data from the queue
- [X] If timeout expire, receivet() must return -1
- [X] If data is received while timeout expire (same simulated time), data must be return by receivet()
* api_send0_eth0_1s1r [1/1]
- [X] Whatever the simulated time, instantaneous send() works as expected
* api_send_4interfaces_1s2r [1/1]
- [X] Perform send with 4 interfaces: 2 wireless + 2 wired
* api_send_eth0_1s1r [3/3]
- [X] Proper duration for 1 communication with 0s latency
- [X] No data received on eth0 when receiver is turned off
- [X] Communications on eth0 is created and performed (simulated time increase) even if receiver is turned off
* api_send_eth0_2s1r [1/1]
- [X] Check that a batch of 2 sends to 2 receivers works
* api_send_eth0_3s1r [5/5]
- [X] 3 senders transmitting to same node get their bandwidth divided by 3
- [X] If 2 of the 3 senders end their communications, the remaining one get its bandwidth divided by 2 to
  send its remaining amount of data
- [X] If 1 of the 3 senders end its communication, the remaining 2 get their bandwidth divided by 2 to
  send their remaining amount of data
- [X] 3 senders get their bandwidth divided by 3, 2 by 2 and 1 get full bandwidth
- [X] Ensure that after all these bandwidth sharing, a single send work as expected (sharing is reset)
* api_sendt_eth0_1s1r [3/3]
- [X] sendt() works if timeout > transmission duration
- [X] sendt() works if timeout = transmission duration
- [X] sendt() do not work if timeout < transmission duration
* api_sendt_wlan0_1s2r [2/2]
- [X] Transmission work if timeout do not expire
- [X] Transmission does not work if timeout expire
* api_send_wlan0_1s2r [3/3]
- [X] All reachable receivers received the data
- [X] If receiver turned off data is not received
- [X] If receiver turned off at least one time during communication it must not receive the data
* api_send_wlan0_2s1r [1/1]
- [X] If 2 receivers send at the same time to the same receiver, interference must happend on the receiver
* api_wait_2n [1/1]
- [X] wait() works as expected on 2 nodes
* api_wait_end_3n [2/2]
- [X] wait() for 0s works as expected
- [X] wait_end() works as expected
* breakpoints_auto_1n [1/1]
- [X] Simulation is interrupted every 3.3s during a transmission
* breakpoints_manual_1n [1/1]
- [X] Simulation breaks at 1,2,3 and 10s
* breakpoints_manual_no_callback_1n [1/1]
- [X] Breakpoints work if no callback is specified
* hidden_node_2s1r [2/2]
- [X] Bandwidth of 0bps between 2 nodes means unreachable
- [X] Interferences occur on the node in between (hidden node problem)
* mobility_eth0_bandwidth_1s1r [1/1]
- [X] Every 0.5s bandwidth get multiply by 2
* mobility_eth0_bandwidth_2s1r [1/1]
- [X] Every 0.5s bandwidth get multiply by 2 with 2 senders sending to the same receiver (bandwidth divided by 2)
* mobility_eth0_latency_1s1r [1/1]
- [X] Every 0.5s latency increases by 0.5s
* mobility_eth0_latency_2s1r [1/1]
- [X] Every 0.5s latency increases by 0.5s with 2 senders sending to the same receiver (bandwidth divided by 2)
* mobility_wlan0_bandwidth_1s1r [1/1]
- [X] Every 0.5s bandwidth get multiply by 2
* mobility_wlan0_latency_1s1r [1/1]
- [X] Every 0.5s latency increases by 0.5s