Add documentation about how to run integration tests localy

Author: Nicoretti

docs/src/SUMMARY.md

@@ -18,5 +18,5 @@
 - [The josh UI]()
 # Contributing
 - [Testing](./contributing/testing.md)
-- [Development tools]()
+- [Development tools](./contributing/dev-tools.md)
 - [Tracing]()

docs/src/contributing/dev-tools.md

@@ -1,7 +1,5 @@
 # Dev-Tools
 
-* Nix-Shell
-  - curl
-  - brew trunk
-* Cram
-* Cargo/Rustup
+* [Nix Shell](https://nixos.org/manual/nix/unstable/command-ref/nix-shell.html)
+* [Rust](https://rustup.rs/)
+* [Cargo](https://rustup.rs/)

docs/src/contributing/testing.md

@@ -1,33 +1,65 @@
-# Dev Tools
+# Testing
+Currently the Josh project mainly uses integration tests for it's verification, so make sure you will be able
+to run and check them.
 
-## Nix-Shell
-* [Nix Shell](https://nixos.org/manual/nix/stable/#chap-installation)
+The following sections will describe how to run the different kind's of tests used for the verification
+of the Josh project.
 
+## UnitTests & DocTests
+```shell
+cargo test --all
+```
 
-# Testing
+## Integration Tests
+
+### 1. Setup the test environment
+Due to the fact that the integration tests need additional tools and a more complex
+environment and due to the fact that the integration test are done using [cram](https://pypi.org/project/cram/).
+you will need to crate an extra environment to run these tests. To simplify the
+setup of the integration testing we have setup a [Nix Shell](https://nixos.org/manual/nix/stable/#chap-installation) environment which
+you can start by using the following command if you have installed the [Nix Shell](https://nixos.org/manual/nix/stable/#chap-installation).
+
+**Attention:**
+Currently it is still necessary to install the following tools in your host system.
+* curl
+* hyper_cgi
+    ```shell
+    cargo install hyper_cgi --features=test-server
+    ```
+
+#### Setup the Nix Shell
+**Attention:**
+When running this command the first time, this command will take quite a bit to
+finish. You also will need internet access while executing this command.
+Depending on performance of your connection the command will take more or less time.
 
-1. Install Nix-Shell
-2. Setup Nix-Shell for testing
 ```shell
 nix-shell shell.nix
 ```
-3. build 
-   * filter
-   * proxy
-   * trunk build in ui
+Once the command is finished you will be prompted with the nix-shell which will
+provide the needed shell environment to execute the integration tests.
 
 
-## Unit Tests
+### 2. Verify you have built all necessary binaries
 ```shell
-cargo test --all
+cargo build
+cargo build --bin josh-filter
+cargo build --manifest-path josh-proxy/Cargo.toml
+cargo build --manifest-path josh-ui/Cargo.toml
 ```
 
-## Integration Tests
-* Build all targets
-* run integration tests
+### 3. Setup static files for the josh-ui
+```shell
+cd josh-ui 
+trunk build 
+cd ..
+```
+
+### 4. Run the integration tests
+**Attention:** Be aware that all tests except the once in experimental should be green.
 ```shell
-sh run-tests.sh tests/
+sh run-tests.sh -v tests/
 ```
 
 ## UI Tests
-TBD
+TBD: Currently disabled, stabilize, enable and document process.

shell.nix

@@ -18,6 +18,7 @@ in
        pkgs.tree
        pkgs.cargo
        pkgs.rustc
+       pkgs.trunk
        pkgs.rustfmt
        pkgs.libiconv
        pkgs.openssl.dev
@@ -26,3 +27,4 @@ in
      ] ++ extra_deps;
      RUST_BACKTRACE = 1;
    }
+