Merge pull request #277 from faisalill/better-readme

Updated Documentation.

CONTRIBUTING.md

@@ -69,6 +69,80 @@ This is also important for the Utopia-php lead developers to be able to give tec
 
 You can follow our [Adding new Database Adapter](docs/add-new-adapter.md) tutorial to add new database support in this library.
 
+## Tests
+
+To run tests, you first need to bring up the example Docker stack with the following command:
+
+```bash
+docker compose up -d --build
+```
+
+To run all unit tests, use the following Docker command:
+
+```bash
+docker compose exec tests vendor/bin/phpunit --configuration phpunit.xml tests
+```
+
+To run tests for a single file, use the following Docker command structure:
+
+```bash
+docker compose exec tests vendor/bin/phpunit --configuration phpunit.xml tests/Database/[FILE_PATH]
+```
+
+To run static code analysis, use the following phpstan command:
+
+```bash
+composer check
+```
+
+### Load testing
+
+Three commands have been added to `bin/` to fill, index, and query the DB to test changes:
+
+- `bin/load` invokes `bin/tasks/load.php`
+- `bin/index` invokes `bin/tasks/index.php`
+- `bin/query` invokes `bin/tasks/query.php`
+
+To test your DB changes under load:
+
+#### Load the database
+
+```bash
+docker compose exec tests bin/load --adapter=[adapter] --limit=[limit] [--name=[name]]
+
+# [adapter]: either 'mongodb' or 'mariadb', no quotes
+# [limit]: integer of total documents to generate
+# [name]: (optional) name for new database
+```
+
+#### Create indexes
+
+```bash
+docker compose exec tests bin/index --adapter=[adapter] --name=[name]
+
+# [adapter]: either 'mongodb' or 'mariadb', no quotes
+# [name]: name of filled database by bin/load
+```
+
+#### Run Query Suite
+
+```bash
+docker compose exec tests bin/query --adapter=[adapter] --limit=[limit] --name=[name]
+
+# [adapter]: either 'mongodb' or 'mariadb', no quotes
+# [limit]: integer of query limit (default 25)
+# [name]: name of filled database by bin/load
+```
+
+#### Visualize Query Results
+
+```bash
+docker compose exec tests bin/compare
+```
+
+Navigate to `localhost:8708` to visualize query results.
+
+
 ## Other Ways to Help
 
 Pull requests are great, but there are many other areas where you can help Utopia-php.