summaryrefslogtreecommitdiffhomepage
path: root/android/test/benchmark/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'android/test/benchmark/README.md')
-rw-r--r--android/test/benchmark/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/android/test/benchmark/README.md b/android/test/benchmark/README.md
new file mode 100644
index 0000000000..750e27da45
--- /dev/null
+++ b/android/test/benchmark/README.md
@@ -0,0 +1,20 @@
+# Benchmarks
+
+## Setup
+
+Setup the e2e & benchmark properties in your local `gradle.properties`.
+
+Don't forget to specify the IP and port for your target iPerf testing server.
+`mullvad.test.benchmark.target.ip=<IP>`
+`mullvad.test.benchmark.target.port=<PORT>`
+
+## Run tests
+
+Start the test server and is reachable:
+```
+iperf3 -s -p <PORT>
+```
+Make sure the ip and port matches what you've previously configured.
+
+Then start the tests by running the SpeedTests class. The output will be printed in the logs.
+