test/mocks/datafilecollector-testharness/simulator-group/README.md

   1 ###Introduction
   2 The purpose of the "simulator-group" is to run all containers in one go with specified behavior.
   3 Mainly this is needed for CSIT tests and for auto test but can be used also for manual testing of dfc both as an java-app
   4 or as a manually started container. Instead of running the simulators manually as described below the auto-test cases
   5 can be executed together with a java-app or a manaully started container.
   6
   7 In general these steps are needed to run the simulator group and dfc
   8
   9 1. Build the simulator images
  10 2. Edit simulator env variables (to adapt the behavior of simulators)
  11 3. Configure consul
  12 4. Start the simulator monitor (to view the simulator stats)
  13 5. Start the simulators
  14 6. Start dfc
  15
  16 ###Overview of the simulators.
  17 There are 5 different types of simulators. For futher details, see the README.md in each simulator dir.
  18
  19 1. The MR simulator emits fileready events, upon poll requests, with new and historice file references.
  20 It is possible to configire the change identifier and file prefixes for these identifiers and for which consumer groups
  21 these change identifier shall be generated. It is also possible to configure the number of events and files to generate and
  22 from which ftp servers the files shall be fetched from.
  23 2. The DR simulator handles the publish queries (to check if a file has previously been published) and the
  24 actual publish request (which results in a redirect to the DR REDIR simulator. It keeps a 'db' of published files updated by the DR REDIR simulator.
  25 It is possible to configure 1 or more feeds along with the accepted filename prefixes for each feed. It is also possible
  26 to configure the responses for the publish queries and publish requests.
  27 3. The DR REDIR simulator handles the redirect request for publish from the DR simulator. All accepted files will be stored as and empty
  28 file with a file name concatenated from the published file name + file size + feed id.
  29 It is possible to configure 1 or more feeds along with the accepted filename prefixes for each feed. It is also possible
  30 to configure the responses for the publish requests.
  31 4. The SFTP simulator(s) handles the ftp download requests. 5 of these simulators are always started and in the MR sim it is
  32 possible to configure the distrubution of files over these 5 servers (from 1 up to 5 severs). At start of the server, the server is
  33 populated with files to download.
  34 5. The FTPS simulator(s) is the same as the SFTP except that it using the FTPS protocol.
  35
  36
  37 ### Build the simulator images
  38 Run the script `prepare-images.sh` to build the docker images for MR, DR and FTPS servers.
  39
  40 ###Edit simulator env variables
  41
  42
  43
  44
  45 ###Summary of scripts and files
  46 `consul_config.sh` - Convert a json config file to work with dfc when manually started as java-app or container and then add that json to Consul.
  47
  48 `dfc-internal-stats.sh` - Periodically extract jvm data and dfc internal data and print to console/file.
  49
  50 `docker-compose-setup.sh` - Sets environment variables for the simulators and start the simulators with that settings.
  51
  52 `docker-compose-template.yml` - A docker compose template with environment variables setting. Used for producing a docker-compose file to defined the simulator containers.
  53
  54 `prepare-images.sh` - Script to build all needed simulator images.
  55
  56 `setup-ftp-files-for-image.sh` - Script executed in the ftp server to create files for download.
  57
  58 `sim-monitor-start.sh` - Script to install needed packages and start the simulator monitor.
  59
  60 `sim-monitor.js` - The source file the simulator monitor.
  61
  62 `simulators-kill.sh` - Script to kill all the simulators
  63
  64 `simulators-start.sh` - Script to start all the simulators. All env variables need to be set prior to executing the script.
  65
  66
  67
  68 ###Preparation
  69 Do the manual steps to prepare the simulator images
  70
  71 Build the mr-sim image.
  72
  73 cd ../mr-sim
  74
  75 Run the docker build command to build the image for the MR simulator: 'docker build -t mrsim:latest .'
  76
  77 cd ../dr-sim
  78
  79 Run the docker build command to build the image for the DR simulators: `docker build -t drsim_common:latest .'
  80
  81 cd ../ftps-sftp-server
  82 Check the README.md in ftps-sftp-server dir in case the cert need to be updated.
  83 Run the docker build command to build the image for the DR simulators: `docker build -t ftps_vsftpd:latest -f Dockerfile-ftps .'
  84
  85
  86 ###Execution
  87
  88 Edit the `docker-compose-setup.sh` (or create a copy) to setup the env variables to the desired test behavior for each simulators.
  89 See each simulator to find a description of the available settings (DR_TC, DR_REDIR_TC and MR_TC).
  90 The following env variables shall be set (example values).
  91 Note that NUM_FTPFILES and NUM_PNFS controls the number of ftp files created in the ftp servers.
  92 A total of NUM_FTPFILES * NUM_PNFS ftp files will be created in each ftp server (4 files in the below example).
  93 Large settings will be time consuming at start of the servers.
  94 Note that the number of files must match the number of file references emitted from the MR sim.
  95
  96 DR_TC="--tc normal"           #Normal behavior of the DR sim
  97
  98 DR_REDIR_TC="--tc normal"     #Normal behavior of the DR redirect sim
  99
 100 MR_TC="--tc100"               #One 1 MB file in one event, once.
 101
 102 BC_TC=""                      #Not in use yet
 103
 104 NUM_FTPFILES="2"              #Two file for each PNF
 105
 106 NUM_PNFS="2"                  #Two PNFs
 107
 108 To minimize the number of ftp file creation, the following two variables can be configured in the same file.
 109 FILE_SIZE="1MB"               #File size for FTP file (1KB, 1MB, 5MB, 50MB or ALL)
 110 FTP_TYPE="SFTP"               #Type of FTP files to generate (SFTP, FTPS or ALL)
 111
 112 If `FTP_TYPE` is set to `ALL`, both ftp servers will be populated with the same files. If set to `SFTP` or `FTPS` then only the server serving that protocol will be populated with files.
 113
 114 Run the script `docker-compose-setup.sh`to create a docker-compose with the desired settings. The desired setting
 115 in the script need to be manually adapted to for each specific simulator behavior according to the above. Check each simulator for available
 116 parameters.
 117 All simulators will be started with the generated docker-compose.yml file
 118
 119 To generate ftp url with IP different from localhost, set SFTP_SIM_IP and/or FTPS_SIM_IP env variables to the addreses of the ftp servers before starting.
 120 So farm, this only works when the simulator python script is started from the command line.
 121
 122 Kill all the containers with `simulators-kill.se`
 123
 124 `simulators_start.sh` is for CSIT test and requires the env variables for test setting to be present in the shell.
 125 `setup-ftp-files.for-image.sh` is for CSIT and executed when the ftp servers are started from the docker-compose-setup.sh`.
 126
 127 To make DFC to be able to connect to the simulator containers, DFC need to run in host mode.
 128 Start DFC by the following cmd: `docker run -d --network="host" --name dfc_app <dfc-image> `
 129
 130 `<dfc-image>` could be either the locally built image `onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server`
 131 or the one in nexus `nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server`.
 132
 133
 134
 135 ###Start the simulator monitor
 136 Start the simulator monitor server with `node sim-monitor.js` on the cmd line and the open a browser with the url `localhost:9999/mon`
 137 to see the statisics page with data from DFC(ss), MR sim, DR sim and DR redir sim.
 138 If needed run 'npm install express' first