Updated README files and adaptation of consul/cbs config

Change-Id: I81494f56978a3d0ff06ec0d66968f33f08114103
Issue-ID: DCAEGEN2-1719
Signed-off-by: maximesson <maxime.bonneau@est.tech>

1 files changed, 80 insertions, 43 deletions

diff --git a/test/mocks/datafilecollector-testharness/mr-sim/README.md b/test/mocks/datafilecollector-testharness/mr-sim/README.md
index 5e6ac6d88..d3ca91c87 100644
--- a/test/mocks/datafilecollector-testharness/mr-sim/README.md
+++ b/test/mocks/datafilecollector-testharness/mr-sim/README.md
@@ -26,10 +26,15 @@ All other configuration is done via envrionment variables.
 The simulator listens to port 2222.
 
 The following envrionment vaiables are used:
+
 **FTPS_SIMS** - A comma-separated list of hostname:port for the FTP servers to generate ftps file urls for. If not set MR sim will assume 'localhost:21'. Minimum 1 and maximum 5 host-port pairs can be given.
+
 **SFTP_SIMS** - A comma-separated list of hostname:port for the FTP servers to generate sftp file urls for. If not set MR sim will assume 'localhost:1022'. Minimum 1 and maximum 5 host-port pairs can be given.
+
 **NUM_FTP_SERVERS** - Number of FTP servers to use out of those specified in the envrioment variables above. The number shall be in the range 1-5.
+
 **MR_GROUPS** - A comma-separated list of consummer-group:changeId[:changeId]*. Defines which change identifier that should be used for each consumer gropu. If not set the MR-sim will assume 'OpenDcae-c12:PM_MEAS_FILES'.
+
 **MR_FILE_PREFIX_MAPPING** - A comma-separated list of changeId:filePrefix. Defines which file prefix to use for each change identifier, needed to distinguish files for each change identifiers. If not set the MR-sim will assume 'PM_MEAS_FILES:A
 
 
@@ -39,77 +44,78 @@ The simulator can be queried for statistics  and  started/stopped (use curl from
 
 `curl localhost:2222` - Just returns 'Hello World'.
 
-`curl localhost:2222/groups` - Return a comma-separated list of configured consumer groups..
+`curl localhost:2222/tc_info` - returns the tc string (as given on the cmd line)
 
-`curl localhost:2222/changeids` - Return a commar-separated list of configured change id sets, where each set is a list of colon-separated change for each configured consumer group.
+`curl localhost:2222/start` - start event delivery (default status).
 
-`curl localhost:2222/fileprefixes` - Return the setting of env var MR_FILE_PREFIX_MAPPING.
+`curl localhost:2222/stop` - stop event delivery.
 
-`curl localhost:2222/ctr_requests`   - return an integer of the number of get request to the event poll path
+`curl localhost:2222/status` - returns the status, started or stopped .
 
-`curl localhost:2222/groups/ctr_requests`   - return an integer of the number of get requests, for all consumer groups, to the event poll path
+`curl localhost:2222/execution_time` - returns the execution time in mm:ss
 
-`curl localhost:2222/ctr_requests/<consumer-group>`   - return an integer of the number of get requests, for the specified consumer group, to the event poll path
+`curl localhost:2222/groups` - returns a comma-separated list of configured consumer groups..
 
+`curl localhost:2222/changeids` - returns a commar-separated list of configured change id sets, where each set is a list of colon-separated change for each configured consumer group.
 
+`curl localhost:2222/fileprefixes` - returns the setting of env var MR_FILE_PREFIX_MAPPING.
 
 
+`curl localhost:2222/ctr_requests`   - returns an integer of the number of get requests, for all groups,  to the event poll path
 
+`curl localhost:2222/groups/ctr_requests`   - returns a list of integers of the number of get requests, for each consumer group, to the event poll path
 
+`curl localhost:2222/ctr_requests/<consumer-group>`   - returns an integer of the number of get requests, for the specified consumer group, to the event poll path
 
-`curl localhost:2222/ctr_responses`  - return an integer of the number of get responses to the event poll path
 
-`curl localhost:2222/ctr_files` - returns an integer or the number files.  
+`curl localhost:2222/ctr_responses`   - returns an integer of the number of get responses, for all groups,  to the event poll path
 
-`curl localhost:2222/ctr_unique_files` - returns an integer or the number of unique files. A unique file is the combination of node+file_sequence_number 
+`curl localhost:2222/groups/ctr_responses`   - returns a list of integers of the number of get responses, for each consumer group, to the event poll path
 
-`curl localhost:2222/tc_info` - returns the tc string (as given on the cmd line)
+`curl localhost:2222/ctr_responses/<consumer-group>`   - returns an integer of the number of get responses, for the specified consumer group, to the event poll path
 
-`curl localhost:2222/ctr_events` - returns the total number of events
 
-`curl localhost:2222/execution_time` - returns the execution time in mm:ss
+`curl localhost:2222/ctr_files` - returns an integer of the number generated files for all groups
 
-`curl localhost:2222/exe_time_first_poll` - returns the execution time in mm:ss from the first poll
+`curl localhost:2222/groups/ctr_files` - returns a list of integers of the number generated files for each group
 
-`curl localhost:2222/ctr_unique_PNFs` - return the number of unique PNFS in alla events.
+`curl localhost:2222/ctr_files/<consumer-group>` - returns an integer or the number generated files for the specified group
 
-`curl localhost:2222/start` - start event delivery (default status).
 
-`curl localhost:2222/stop` - stop event delivery.
+`curl localhost:2222/ctr_unique_files` - returns an integer of the number generated unique files for all groups
 
-`curl localhost:2222/status` - Return the started or stopped status.
+`curl localhost:2222/groups/ctr_unique_files` - returns a list of integers of the number generated unique files for each group
 
+`curl localhost:2222/ctr_unique_files/<consumer-group>` - returns an integer or the number generated unique files for the specified group
 
-#Alternative to running python (as described below) on your machine, use the docker files.
-1. Build docker container with ```docker build -t mrsim:latest .```
-2. Run the container ```docker-compose up```
-The behavior can be changed by argument to the python script in the docker-compose.yml
 
-The simulator can be queried for statistics  and  started/stopped (use curl from cmd line or open in browser, curl used below):
 
-`curl localhost:2222/ctr_requests`   - return an integer of the number of get request to the event poll path
+`curl localhost:2222/ctr_events` - returns the total number of events for all groups
 
-`curl localhost:2222/ctr_responses`  - return an integer of the number of get responses to the event poll path
+`curl localhost:2222/groups/ctr_events` - returns a list the integer of the total number of events for each group
 
-`curl localhost:2222/ctr_files` - returns an integer or the number files.  
+`curl localhost:2222/ctr_events/<consumer-group>` - returns the total number of events for a specified group
 
-`curl localhost:2222/ctr_unique_files` - returns an integer or the number of unique files. A unique file is the combination of node+file_sequence_number 
 
-`curl localhost:2222/tc_info` - returns the tc string (as given on the cmd line)
+`curl localhost:2222/exe_time_first_poll` - returns the execution time in mm:ss from the first poll
 
-`curl localhost:2222/ctr_events` - returns the total number of events
+`curl localhost:2222/groups/exe_time_first_poll` - returns a list of the execution time in mm:ss from the first poll for each group
 
-`curl localhost:2222/execution_time` - returns the execution time in mm:ss
+`curl localhost:2222/exe_time_first_poll/<consumer-group>` - returns the execution time in mm:ss from the first poll for the specified group
 
-`curl localhost:2222/exe_time_first_poll` - returns the execution time in mm:ss from the first poll
 
-`curl localhost:2222/ctr_unique_PNFs` - return the number of unique PNFS in alla events.
+`curl localhost:2222/ctr_unique_PNFs` - returns the number of unique PNFS in all events.
 
-`curl localhost:2222/start` - start event delivery (default status).
+`curl localhost:2222/groups/ctr_unique_PNFs` - returns a list of the number of unique PNFS in all events for each group.
 
-`curl localhost:2222/stop` - stop event delivery.
+`curl localhost:2222/ctr_unique_PNFs/<consumer-group>` - returns the number of unique PNFS in all events for the specified group.
+
+
+#Alternative to running python (as described below) on your machine, use the docker files.
+1. Build docker container with ```docker build -t mrsim:latest .```
+2. Run the container ```docker-compose up```
+The behavior can be changed by argument to the python script in the docker-compose.yml
 
-`curl localhost:2222/status` - Return the started or stopped status.
 
 ##Common TC info
 File names for 1MB, 5MB and 50MB files
@@ -117,8 +123,8 @@ Files in the format: <size-in-mb>MB_<sequence-number>.tar.gz    Ex. for 5MB file
 The sequence numbers are stepped so that all files have unique names
 Missing files (files that are not expected to be found in the ftp server. Format: MissingFile_<sequence-number>.tar.gz
 
-Limited event streams
-When the number of events are exhausted, empty replies are returned '[]'
+When the number of events are exhausted, empty replies are returned '[]', for the limited test cases. For endless tc no empty replies will be given.
+Test cases are limited unless noted as 'endless'.
 
 TC100 - One ME, SFTP, 1 1MB file, 1 event
 
@@ -139,25 +145,56 @@ TC120 - One ME, SFTP, 1MB files, 100 files per event, 100 events, 1 event per po
 
 TC121 - One ME, SFTP, 1MB files, 100 files per event, 100 events, 1 event per poll. 10% missing files
 
-TC122 - One ME, SFTP, 1MB files, 100 files per event, 100 events. 1 event per poll. All files with identical name. 
+TC122 - One ME, SFTP, 1MB files, 100 files per event, 100 events. 1 event per poll. All files with identical name.
 
-TC510 - 700 MEs, SFTP, 1MB files, 1 file per event, 3500 events, 700 event per poll.
+TC500 - 700 MEs, SFTP, 1MB files, 2 new files per event, 700 events, all event in one poll
 
-TC200-TC202 same as TC100-TC102 but with FTPS
+TC501 - 700 MEs, SFTP, 5MB files, 2 new files per event, 700 events, all event in one poll
 
-TC210-TC213 same as TC110-TC113 but with FTPS
+TC502 - 700 MEs, SFTP, 50MB files, 2 new files per event, 700 events, all event in one poll
 
-TC2000-TC2001 same as TC1000-TC1001 but with FTPS
+TC510 - 700 MEs, SFTP, 1MB files, 1 file per event, 3500 events, 700 event per poll.
 
-TC610 same as TC510 but with FTPS
+TC511 - 700 MEs, SFTP, 1KB files, 1 file per event, 3500 events, 700 event per poll
 
+TC550 - 700 MEs, SFTP, 50MB files, 1 file per event, 3500 events, 700 event per poll
 
-Endless event streams
+TC710 - 700 MEs, SFTP, 1MB files, 100 files per event, 3500 events, 35 event per poll
 
 TC1000 - One ME, SFTP, 1MB files, 100 files per event, endless number of events, 1 event per poll
 
 TC1001 - One ME, SFTP, 5MB files, 100 files per event, endless number of events, 1 event per poll
 
+TC1100 - 700 ME, SFTP, 1MB files, 100 files per event, endless number of events, 35 event per poll
+
+TC1101 - 700 ME, SFTP, 5MB files, 100 files per event, endless number of events, 35 event per poll
+
+TC1102 - 700 ME, SFTP, 50MB files, 100 files per event, endless number of events, 35 event per poll
+
+TC1200 - 700 ME, SFTP, 1MB files, 100 new files per event, endless number of events, 35 event per poll
+
+TC1201 - 700 ME, SFTP, 5MB files, 100 new files per event, endless number of events, 35 event per poll
+
+TC1202 - 700 ME, SFTP, 50MB files, 100 new files per event, endless number of events, 35 event per poll
+
+TC1300 - 700 ME, SFTP, 1MB files, 100 files per event, endless number of events, 35 event per poll, 20 event polls every 15min
+
+TC1301 - 700 ME, SFTP, 5MB files, 100 files per event, endless number of events, 35 event per poll, 20 event polls every 15min
+
+TC1302 - 700 ME, SFTP, 50MB files, 100 files per event, endless number of events, 35 event per poll, 20 event polls every 15min
+
+TC1500 - 700 ME, SFTP, 1MB files, 100 files per event, 35 events per poll, simulating 25h backlog of decreasing number of outdated files and then 20 event polls every 15min for 1h
+
+Changing the first digit in tc number will change the test case to run FTPS instead. Eg. TC201 is FTPS version of TC101.
+
+TC2XX is same as TC1XX but with FTPS
+
+TC6XX is same as TC5XX but with FTPS
+
+TC8XX is same as TC7XX but with FTPS
+
+TC2XXX is same as TC1XXX but with FTPS
+
 
 ## Developer workflow