Adapt EXPORT_PORT, add dc doc

openkfw · Feb 11, 2021 · db9f0cb · db9f0cb
1 parent aca222e
commit db9f0cb
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 4 deletions.
diff --git a/.env_example b/.env_example
@@ -53,3 +53,6 @@ ACCESS_CONTROL_ALLOW_ORIGIN=*
 # Used by frontend
 NODE_ENV=development
 REACT_APP_VERSION=$npm_package_version
+
+# Used by frontend/excel-export
+EXPORT_PORT=8888
diff --git a/doc/installation/Developer-Setup.md b/doc/installation/Developer-Setup.md
@@ -441,11 +441,23 @@ If you want to start this service or simply see more details regarding this feat
 
 ### End-to-end Tests
 
-Before checking in, you should always run the end-to-end test which explores / tests the whole functionality of the application. For end-to-end testing we use the testing framework [Cypress]. More details regarding the environment variables can be found in the [README.md](https://github.com/openkfw/TruBudget/blob/master/e2e-test/README.md) file.
+Before checking in, you should always run the end-to-end test which explores / tests the whole functionality of the application. For end-to-end testing we use the testing framework [Cypress]. If you want to start all e2e-tests to check if your changes are not breaking any stuff we recommend the [Docker-Compose-Setup](#Docker-Compose Setup) More details regarding the environment variables can be found in the [README.md](https://github.com/openkfw/TruBudget/blob/master/e2e-test/README.md) file.
+
+#### Docker-Compose Setup
+
+One way to start the end-to-end tests is starting the e2e-test script. To start them execute following commands from root directory to make sure e2e-test will work:
+
+```bash
+cp .env_example .env
+sed -i 's/ORGANIZATION=.*/ORGANIZATION=KfW/g' .env
+sh scripts/testing/start-e2e-tests.sh
+```
+
+Note that the organization has to be "KfW" because the e2e-test's Organization is still hardcoded.
 
 #### Prerequisits
 
-Before running the tests you should make sure that the application is started (including the [excel export service](#excel-export-optional)) and that you first run the [provisioning](#provisioning-optional). In order for the backup_spec tests to pass you should also start the project with the same configurations (Organization and RPC Password) as the valid backup hardcoded in the `e2e-test/cypress/fixtures` folder. When running the e2e-tests locally, you have to make sure that the password used for authentication as root user in the test matches the one used in the project that is currently running, otherwise some tests can fail because of an "Authentication failed" error.
+Before running the tests you should make sure that the application is started (including the [excel export service](#excel-export-optional)) and that you first run the [provisioning](#provisioning-optional). In order for the backup_spec tests to pass you should also start the project with the same configurations (Organization and RPC Password). When running the e2e-tests locally, you have to make sure that the password used for authentication as root user in the test matches the one used in the project that is currently running, otherwise some tests can fail because of an "Authentication failed" error.
 
 #### Setup
 

diff --git a/docker-compose/testing/run-e2e-tests.yml b/docker-compose/testing/run-e2e-tests.yml
@@ -35,7 +35,7 @@ services:
       PROD_API_PORT: ${API_PORT}
       TEST_API_HOST: api
       TEST_API_PORT: ${API_PORT}
-      EXPORT_PORT: 8888
+      EXPORT_PORT: ${EXPORT_PORT}
       EXPORT_HOST: export
       REACT_APP_EXPORT_SERVICE_ENABLED: "true"
     links:
@@ -58,7 +58,7 @@ services:
       - api
       - master
     command: ["npm", "start"]
-  
+
   export:
     image: trubudget/excel-export:${TAG}
     environment: