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 but can be used also for local testing.
   4
   5
   6 ###Preparation
   7 Build the mr-sim image.
   8
   9 cd ../mr-sim
  10
  11 Run the docker build command to build the image for the MR simulator: 'docker build -t mrsim:latest .
  12
  13 cd ../dr-sim
  14
  15 Run the docker build command to build the image for the DR simulators: `docker build -t drsim_common:latest .
  16
  17
  18 cd ../simulator-group
  19
  20 Copy the 'configuration' and 'tls' catalogues from the ftps-sftp-server dir.
  21
  22 Check the README.md in ftps-sftp-server dir in case the cert need to be updated.
  23
  24 cp -r ./ftps-sftp-server/configuration .
  25
  26 cp -r ../ftps-sftp-server/tls .
  27
  28
  29 ###Execution
  30
  31 Edit the `docker-compose-setup.sh` to setup the env variables to the desired test behavior for each simulators.
  32 See each simulator to find a description of the available settings.
  33
  34 Run the script `docker-compose-setup.sh`to create a docker-compose with the desired settings. All simulators
  35 will be started with the generated docker-compose.yml file
  36
  37 Kill all the containers with `simulators-kill.se`
  38
  39 `simulators_start.sh` is for CSIT test and requires the env variables for test setting to be present in the shell.
  40 `setup-ftp-files.for-image.sh` is for CSIT and executed when the ftp servers are started from the docker-compose-setup.sh`.
  41