add: sensible defaults to e2e db config and document it

iota-uz · Feb 26, 2025 · d39713f · d39713f
1 parent b933e58
commit d39713f
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 5 deletions.
diff --git a/docs/CONTRIBUTING.MD b/docs/CONTRIBUTING.MD
@@ -111,7 +111,7 @@ Before starting, ensure the following tools are installed on your system:
 
 9. **Access the web app**:
 
-   Open your browser and navigate to:  
+   Open your browser and navigate to:
    [http://localhost:8080](http://localhost:8080)
 
    Use the following credentials to log in:
@@ -125,10 +125,27 @@ Before starting, ensure the following tools are installed on your system:
    TestPass123!
    ```
 
-10. **Access the GraphQL Schema**:  
-    Open Postman and connect to:  
+10. **Access the GraphQL Schema**:
+    Open Postman and connect to:
     [http://localhost:3200/query](http://localhost:3200/query)
 
+### Running tests
+
+To run end-to-end Cypress tests you need to have a working, migrated and seeded database and a running back-end on the background. Tests require these environment variables to be able to truncate the database before each test suite:
+
+- `DB_USER`
+- `DB_PASSWORD`
+- `DB_HOST`
+- `DB_PORT`
+- `DB_NAME`
+
+If they are not provided the tests will assume sensible defaults for a local database. To run the tests:
+
+```bash
+cd e2e/
+pnpm cypress run --headed
+```
+
 ### Troubleshooting Windows Setup
 
 1. **If `make` commands fail**:
@@ -156,6 +173,6 @@ Before starting, ensure the following tools are installed on your system:
 
 ### Communication rules
 
-1. The contributer should close the conversation if he considers it's done. It can be reopened by the reviewer if needed. 
+1. The contributer should close the conversation if he considers it's done. It can be reopened by the reviewer if needed.
 
 For additional help, please check our [FAQ](./FAQ.md) or open an issue on GitHub.
diff --git a/e2e/cypress.config.js b/e2e/cypress.config.js
@@ -5,8 +5,15 @@ const { Pool } = require("pg");
 
 const exec = util.promisify(cp.exec);
 const { env } = process;
+const [DB_USER, DB_PASSWORD, DB_HOST, DB_PORT, DB_NAME] = [
+	env.DB_USER ?? "postgres",
+	env.DB_PASSWORD ?? "postgres",
+	env.DB_HOST ?? "localhost",
+	env.DB_PORT ?? 5432,
+	env.DB_NAME ?? "iota_erp",
+];
 const pool = new Pool({
-	connectionString: `postgres://${env.DB_USER}:${env.DB_PASSWORD}@${env.DB_HOST}:${env.DB_PORT}/${env.DB_NAME}`,
+	connectionString: `postgres://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_NAME}`,
 });
 
 async function resetDatabase() {