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, 30 insertions, 22 deletions

diff --git a/test/mocks/datafilecollector-testharness/common/test_env.sh b/test/mocks/datafilecollector-testharness/common/test_env.sh
index 7ba35ef27..1a97ffc73 100644
--- a/test/mocks/datafilecollector-testharness/common/test_env.sh
+++ b/test/mocks/datafilecollector-testharness/common/test_env.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# This env variable is only needed if the auto test scripts tests are executed in a different folder than 'auto-test' in the integration repo
+# This env variable is only needed if the auto test scripts tests are executed in a different folder than 'auto-test' in the integration repo 
 # Change '<local-path>' to your path to the integration repo. In addition to the auto-test, the 'common' dir is needed if not executed in the
 # integration repo.
 #
@@ -18,33 +18,41 @@ export DFC_LOCAL_IMAGE=onap/org.onap.dcaegen2.collectors.datafile.datafile-app-s
 
 # Common env var for auto-test.
 
-DFC_PORT=8100
-DFC_PORT_SECURE=8433
-DFC_LOGPATH="/var/log/ONAP/application.log"
-DOCKER_SIM_NWNAME="dfcnet"
-CONSUL_HOST="consul-server"
-CONSUL_PORT=8500
-CONFIG_BINDING_SERVICE="config-binding-service"
-MR_PORT=2222
-MR_PORT_SECURE=2223
-DR_PORT=3906
-DR_PORT_SECURE=3907
-DRR_PORT=3908
-DRR_PORT_SECURE=3909
-DFC_APP_BASE="dfc_app"
-DFC_MAX_NUM=5
-DFC_MAX_IDX=$(($DFC_MAX_NUM - 1))
-SFTP_BASE="dfc_sftp-server"
-FTPS_BASE="dfc_ftpes-server-vsftpd"
-FTP_MAX_NUM=5
-FTP_MAX_IDX=$(($FTP_MAX_NUM - 1))
+DFC_PORT=8100                          #Up to five dfc apps can be used, dfc_app0 will be mapped to 8100 on local machine for http, dfc_app1 mapped to 8101 etc
+DFC_PORT_SECURE=8433                   #Up to five dfc apps can be used, dfc_app0 will be mapped to 8433 on local machine for hhtps, dfc_app1 mapped to 8434 etc
+DFC_LOGPATH="/var/log/ONAP/application.log"  #Path the application log in the dfc container
+DOCKER_SIM_NWNAME="dfcnet"             #Name of docker private network
+CONSUL_HOST="consul-server"            #Host name of consul
+CONSUL_PORT=8500                       #Port number of consul
+CONFIG_BINDING_SERVICE="config-binding-service"  #Host name of CBS
+MR_PORT=2222                           #MR simulator port number http
+DR_PORT=3906                           #DR simulator port number http
+DR_PORT_SECURE=3907                    #DR simulator port number for https
+DRR_PORT=3908                          #DR Redirect simulator port number for http
+DRR_PORT_SECURE=3909                   #DR Redirect simulator port number for https
+DFC_APP_BASE="dfc_app"                 #Base name of the dfc containers. Instance 0 will be named dfc_app0, instance 1 will named dfc_app1 etc
+DFC_MAX_NUM=5                          #Max number of dfc containers to run in paralell in auto test
+DFC_MAX_IDX=$(($DFC_MAX_NUM - 1))      #Max index of the dfc containers
+SFTP_BASE="dfc_sftp-server"            #Base name of the dfc_sftp-server containers. Instance 0 will be named dfc_sftp-server0, instance 1 will named dfc_sftp-server1 etc
+FTPS_BASE="dfc_ftpes-server-vsftpd"    #Base name of the dfc_ftpes-server-vsftpd containers. Instance 0 will be named dfc_ftpes-server-vsftpd0, instance 1 will named dfc_ftpes-server-vsftpd1 etc
+FTP_MAX_NUM=5                          #Max number of sftp and ftps containers to run in paralell in auto test
+FTP_MAX_IDX=$(($FTP_MAX_NUM - 1))      #Max index of sftp and ftps containers
+
+#List of sftp server name and port number, used by MR sim to produce file urls. Theses server names and ports are used when running dfc and the simulators in a private docker network
 SFTP_SIMS_CONTAINER="sftp-server0:22,sftp-server1:22,sftp-server2:22,sftp-server3:22,sftp-server4:22"
+
+#List of sftp server name and port number, used by MR sim to produce file urls. Theses server names and ports are used when running dfc and the simulators in a private docker network
 FTPS_SIMS_CONTAINER="ftpes-server-vsftpd0:21,ftpes-server-vsftpd1:21,ftpes-server-vsftpd2:21,ftpes-server-vsftpd3:21,ftpes-server-vsftpd4:21"
+
+#List of sftp server name and port number, used by MR sim to produce file urls. Theses server names and ports are used when running dfc as stand along app and the simulators in a private docker network
 SFTP_SIMS_LOCALHOST="localhost:1022,localhost:1023,localhost:1024,localhost:1025,localhost:1026"
+
+#List of ftps server name and port number, used by MR sim to produce file urls. Theses server names and ports are used when running dfc as stand along app and the simulators in a private docker network
 FTPS_SIMS_LOCALHOST="localhost:1032,localhost:1033,localhost:1034,localhost:1035,localhost:1036"
 
 export SFTP_SIMS=$SFTP_SIMS_CONTAINER   #This env will be set to SFTP_SIMS_LOCALHOST if auto test is executed with 'manual-app'
 export FTPS_SIMS=$FTPS_SIMS_CONTAINER   #This env will be set to FTPS_SIMS_LOCALHOST if auto test is executed with 'manual-app'
 
-export DR_REDIR_SIM="drsim_redir"       #This env will be set to 'localhost' if auto test is executed with 'manual-app'
+#Host name of the DR redirect simulator
+export DR_REDIR_SIM="drsim_redir"       #This env will be set to 'localhost' if auto test is executed with arg 'manual-app'