aboutsummaryrefslogtreecommitdiffstats
path: root/k6-tests/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'k6-tests/README.md')
-rw-r--r--k6-tests/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/k6-tests/README.md b/k6-tests/README.md
new file mode 100644
index 000000000..e26b18609
--- /dev/null
+++ b/k6-tests/README.md
@@ -0,0 +1,25 @@
+# k6 tests
+
+[k6](https://k6.io/) is used for performance tests.
+k6 tests are written in JavaScript.
+
+## k6 installation
+Follow the instructions in the [k6 installation guide](https://grafana.com/docs/k6/latest/set-up/install-k6/)
+to get started.
+
+## Running the k6 test suites
+Simply run the main script. (The script assumes k6 and docker-compose have been installed).
+```shell
+./run-k6-tests.sh
+```
+
+## Running k6 tests manually
+Before running tests, ensure CPS/NCMP is running:
+```shell
+docker-compose -f docker-compose/docker-compose.yml --profile dmi-stub up
+```
+
+To run an individual test from command line, use
+```shell
+k6 run ncmp/1-create-cmhandles.js
+```