osmith has uploaded this change for review.
ggsn: README: document how to run with testenv
It is possible to run the GGSN testsuite in a lot of ways (as it was
ported from docker-playground, which had the same variations but with a
less consistent way of running them).
Document how it is typically run for development / in jenkins. This
should make it easier for users, in addition to testenv already telling
which configs are available if trying to run the ggsn testsuite without
the -c argument, and to the general help output in "./testenv.py run -h".
$ ./testenv.py run ggsn
[testenv] Using testsuite ggsn_tests (via alias ggsn)
[testenv] Found multiple testenv.cfg files:
[testenv] * testenv_open5gs.cfg
[testenv] * testenv_osmo_ggsn_all.cfg
[testenv] * testenv_osmo_ggsn_v4_only.cfg
[testenv] * testenv_osmo_ggsn_v4v6_only.cfg
[testenv] * testenv_osmo_ggsn_v6_only.cfg
[testenv] Select a specific config (e.g. '-c open5gs') or all ('-c all')
Change-Id: I49421151b199fa6536da784b6c412b03f3fdbd05
---
M ggsn_tests/README.md
1 file changed, 72 insertions(+), 4 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-ttcn3-hacks refs/changes/58/38458/1
diff --git a/ggsn_tests/README.md b/ggsn_tests/README.md
index 71468d5..f40c4b0 100644
--- a/ggsn_tests/README.md
+++ b/ggsn_tests/README.md
@@ -1,9 +1,10 @@
# GGSN_Tests.ttcn
-* external interfaces
- * Gp: GTP (emulates SGSN)
- * Gi: IP (emulates Internet)
- * VTY
+## External interfaces
+
+* Gp: GTP (emulates SGSN)
+* Gi: IP (emulates Internet)
+* VTY
{% dot ggsn_tests.svg
digraph G {
@@ -16,3 +17,70 @@
ATS -> GGSN [label="VTY"];
}
%}
+
+## How to run
+
+### osmo-ggsn
+
+osmo-ggsn with APN config [all](osmo-ggsn/osmo-ggsn-all.confmerge):
+```
+$ ./testenv.py run ggsn -c osmo_ggsn_all
+```
+
+osmo-ggsn with APN config [v4_only](osmo-ggsn/osmo-ggsn-v4_only.confmerge):
+```
+$ ./testenv.py run ggsn -c osmo_ggsn_v4_only
+```
+
+osmo-ggsn with APN configs
+[all](osmo-ggsn/osmo-ggsn-all.confmerge),
+[v4_only](osmo-ggsn/osmo-ggsn-v4_only.confmerge),
+[v6_only](osmo-ggsn/osmo-ggsn-v6_only.confmerge) and
+[v4v6_only](osmo-ggsn/osmo-ggsn-v4v6_only.confmerge):
+```
+$ ./testenv.py run ggsn -c 'osmo_ggsn_*'
+```
+
+### osmo-ggsn + kernel GTP-U
+
+osmo-ggsn with APN config [v4_only](osmo-ggsn/osmo-ggsn-v4_only.confmerge)
+and kernel GTP-U with a custom kernel:
+```
+$ wget -O .linux https://jenkins.osmocom.org/jenkins/job/build-kernel-net-next/lastSuccessfulBuild/artifact/output/linux
+$ ./testenv.py run ggsn -c osmo_ggsn_v4_only -C
+```
+
+osmo-ggsn with APN config [v4_only](osmo-ggsn/osmo-ggsn-v4_only.confmerge)
+and kernel GTP-U with Debian kernel:
+```
+$ ./testenv.py run ggsn -c osmo_ggsn_v4_only --podman -D
+```
+
+osmo-ggsn with APN configs
+[v4_only](osmo-ggsn/osmo-ggsn-v4_only.confmerge),
+[v6_only](osmo-ggsn/osmo-ggsn-v6_only.confmerge) and
+[v4v6_only](osmo-ggsn/osmo-ggsn-v4v6_only.confmerge)
+and kernel GTP-U with Debian kernel:
+```
+$ ./testenv.py run ggsn -c 'osmo_ggsn_v*_only' --podman -D
+```
+
+### open5gs
+
+```
+$ ./testenv.py run ggsn -c open5gs
+```
+
+## Related Jenkins jobs
+
+The jenkins jobs have the testenv arguments they use in their description.
+
+* [ttcn3-ggsn-test](https://jenkins.osmocom.org/jenkins/job/ttcn3-ggsn-test/)
+* [ttcn3-ggsn-test-latest](https://jenkins.osmocom.org/jenkins/job/ttcn3-ggsn-test-latest/)
+* [ttcn3-ggsn-test-kernel](https://jenkins.osmocom.org/jenkins/job/ttcn3-ggsn-test-kernel/)
+* [ttcn3-ggsn-test-kernel-latest](https://jenkins.osmocom.org/jenkins/job/ttcn3-ggsn-test-kernel-latest/)
+* [ttcn3-ggsn-test-kernel-net-next](https://jenkins.osmocom.org/jenkins/job/ttcn3-ggsn-test-kernel-net-next/)
+* [ttcn3-ggsn-test-kernel-latest-net-next](https://jenkins.osmocom.org/jenkins/job/ttcn3-ggsn-test-kernel-latest-net-next/)
+* [ttcn3-ggsn-test-kernel-torvalds](https://jenkins.osmocom.org/jenkins/job/ttcn3-ggsn-test-kernel-torvalds/)
+* [ttcn3-ggsn-test-kernel-latest-torvalds](https://jenkins.osmocom.org/jenkins/job/ttcn3-ggsn-test-kernel-latest-torvalds/)
+* [ttcn3-ggsn-test-ogs](https://jenkins.osmocom.org/jenkins/job/ttcn3-ggsn-test-ogs/)
To view, visit change 38458. To unsubscribe, or for help writing mail filters, visit settings.