aboutsummaryrefslogtreecommitdiffstats
path: root/k6-tests/README.md
diff options
context:
space:
mode:
authordanielhanrahan <daniel.hanrahan@est.tech>2024-04-29 16:16:42 +0100
committerdanielhanrahan <daniel.hanrahan@est.tech>2024-05-22 17:09:30 +0100
commitc0b6f3ad5ed529e4f3261cbf6eed44faec3883a4 (patch)
tree5841537492c76fb1ed635177c4c7419435032730 /k6-tests/README.md
parent6d85c1547fad014fbea44af57440e3de1c3ce9ff (diff)
Add k6 performance tests for NCMP
This commit adds K6 tests for NCMP functionalities: - Registration of 20000 CM-handles - Synchronous single CM-handle passthrough read operation - CM-handle and ID searches for no filter, module, and public property - De-registration of 20000 CM-handles - A mixed load test Also includes a README and shell scripts to run all tests. Issue-ID: CPS-2199 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Ia2e59674057ed28f5f9ceed9465133f7c0ce8318
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
+```