Add README.md file for several suites

Content grabbed from [1] and converted to markdown as it's more probable
to have it displayed correctly on popular git repo hosting platforms.
Syntax for embedded graphviz taken from [2].

[1] http://git.gnumonks.org/laforge-slides/plain/2018/osmodevcon2018-ttcn3_test_suites/osmodevcon2018-ttcn3_test_suites.adoc
[2] https://github.com/stlehmann/markdown-graphviz

Change-Id: I9aad03e605569e9613665a7585d60bf308bcb54f

8 files changed, 159 insertions, 0 deletions

diff --git a/bsc/README.md b/bsc/README.md
new file mode 100644
index 00000000..6efaa7fe
--- /dev/null
+++ b/bsc/README.md
@@ -0,0 +1,23 @@
+# BSC_Tests.ttcn
+
+* external interfaces
+    * A-bis side: RSL (emulates BTS-side client)
+    * A-side: BSSAP/SCCP/M3UA (emulates MSC-side)
+    * MGW side: MGCP (emulates MGW side)
+
+{% dot bsc_tests.svg
+digraph G {
+  rankdir=LR;
+  { rank=same; BTS; STP; };
+  BSC [label="IUT\nosmo-bsc",shape="box"];
+  ATS [label="ATS\nBSC_Tests.ttcn"];
+  BTS [label="osmo-bts-omldummy\nOML only"];
+
+  BTS -> BSC [label="A-bis OML"];
+  ATS -> BSC [label="A-bis RSL"];
+  ATS -> BSC [label="CTRL"];
+  ATS -> BSC [label="VTY"];
+  ATS -> STP [label="A BSSAP\nSCCP/M3UA"];
+  BSC -> STP [label="A BSSAP\nSCCP/M3UA"];
+}
+%}
diff --git a/bts/README.md b/bts/README.md
new file mode 100644
index 00000000..058e1d25
--- /dev/null
+++ b/bts/README.md
@@ -0,0 +1,26 @@
+# BTS_Tests.ttcn
+
+* external interfaces
+    * A-bis side: RSL (emulates BSC-side server)
+    * Um side: L1CTL to control MS
+    * PCU side: pcu_socket
+
+{% dot bts_tests.svg
+digraph G {
+  rankdir=LR;
+  { rank=same; BTS, BSC};
+  BTS [label="IUT\nosmo-bts-trx",shape="box"];
+  ATS [label="ATS\nBTS_Tests.ttcn"];
+  BSC [label="osmo-bsc\nOML only"];
+  BTS -> fake_trx [label="bursts"];
+  fake_trx -> trxcon [label="bursts"];
+  trxcon -> ATS [label="bursts"];
+
+  BTS -> BSC [label="A-bis OML"];
+  BTS -> ATS [label="A-bis RSL"];
+
+  ATS -> BTS [label="pcu_sock"];
+  ATS -> BSC [label="VTY"];
+  ATS -> BTS [label="CTRL"];
+}
+%}
diff --git a/ggsn_tests/README.md b/ggsn_tests/README.md
new file mode 100644
index 00000000..288018f4
--- /dev/null
+++ b/ggsn_tests/README.md
@@ -0,0 +1,17 @@
+# GGSN_Tests.ttcn
+
+* external interfaces
+    * Gp: GTP (emulates SGSN)
+    * Gi: IP (emulates Internet)
+
+{% dot ggsn_tests.svg
+digraph G {
+  rankdir=LR;
+  GGSN [label="GGSN\nosmo-ggsn",shape="box"];
+  ATS [label="ATS\nGGSN_Tests.ttcn"];
+
+  ATS -> GGSN [label="Gp (GTP)"];
+  GGSN -> ATS [label="Gi (IP)"];
+  ATS -> GGSN [label="VTY"];
+}
+%}
diff --git a/hlr/README.md b/hlr/README.md
new file mode 100644
index 00000000..a08c03f5
--- /dev/null
+++ b/hlr/README.md
@@ -0,0 +1,16 @@
+# HLR_Tests.ttcn
+
+* external interfaces
+    * GSUP (emulates VLR/SGSN side)
+    * VTY
+
+{% dot hlr_tests.svg
+digraph G {
+  rankdir=LR;
+  HLR [label="IUT\nosmo-hlr",shape="box"];
+  ATS [label="ATS\nHLR_Tests.ttcn"];
+
+  ATS -> HLR [label="GSUP"];
+  ATS -> HLR [label="VTY"];
+}
+%}
diff --git a/mgw/README.md b/mgw/README.md
new file mode 100644
index 00000000..8f082624
--- /dev/null
+++ b/mgw/README.md
@@ -0,0 +1,17 @@
+== MGW_Test.ttcn
+
+* external interfaces
+    * MGCP (emulates call agent)
+    * RTP (stream source/sink)
+
+{% dot mgw_tests.svg
+digraph G {
+  rankdir=LR;
+  MGW [label="IUT\nosmo-mgw",shape="box"];
+  ATS [label="ATS\nMGCP_Test.ttcn"];
+
+  ATS -> MGW [label="RTP"];
+  ATS -> MGW [label="MGCP"];
+  MGW -> ATS [label="RTP"];
+}
+%}
diff --git a/msc/README.md b/msc/README.md
new file mode 100644
index 00000000..6be15ce2
--- /dev/null
+++ b/msc/README.md
@@ -0,0 +1,24 @@
+
+# MSC_Tests.ttcn
+
+* external interfaces
+    * A: BSSAP/SCCP/M3UA (emulates BSC-side)
+    * MNCC: MNCC/unix-domain (emulates ext. MNCC side)
+    * MGW: MGCP (emulates MGW side)
+    * GSUP (impllements HLR side)
+
+{% dot msc_tests.svg
+digraph G {
+  rankdir=LR;
+  MSC [label="IUT\nosmo-msc",shape="box"];
+  ATS [label="ATS\nMSC_Tests.ttcn"];
+
+  ATS -> MSC [label="MNCC"];
+  ATS -> MSC [label="SMPP",style="dashed"];
+  ATS -> MSC [label="CTRL"];
+  ATS -> MSC [label="VTY"];
+  MSC -> ATS [label="GSUP"];
+  ATS -> STP [label="A BSSAP\nSCCP/M3UA"];
+  MSC -> STP [label="A BSSAP\nSCCP/M3UA"];
+}
+%}
diff --git a/sgsn/README.md b/sgsn/README.md
new file mode 100644
index 00000000..4ed7ea4a
--- /dev/null
+++ b/sgsn/README.md
@@ -0,0 +1,18 @@
+# SGSN_Tests.ttcn
+
+* external interfaces
+    * Gb (emulates PCU side NS/BSSGP + MS)
+    * GSUP (emulates HLR)
+    * VTY
+
+{% dot sgsn_tests.svg
+digraph G {
+  rankdir=LR;
+  SGSN [label="SGSN\nosmo-sgsn",shape="box"];
+  ATS [label="ATS\nSGSN_Tests.ttcn"];
+
+  ATS -> SGSN [label="Gb"];
+  SGSN-> ATS [label="Gp (GTP)"];
+  ATS -> SGSN [label="VTY"];
+}
+%}
diff --git a/sip/README.md b/sip/README.md
new file mode 100644
index 00000000..ac880dd4
--- /dev/null
+++ b/sip/README.md
@@ -0,0 +1,18 @@
+* SIP_Tests.ttcn
+
+* external interfaces
+    * MNCC (emulates MSC side)
+    * SIP (emulates SIP switch)
+    * VTY
+
+{% dot sip_tests.svg
+digraph G {
+  rankdir=LR;
+  SIP [label="SIP\nosmo-sip-connector",shape="box"];
+  ATS [label="ATS\nSIP_Tests.ttcn"];
+
+  ATS -> SIP [label="MNCC"];
+  ATS -> SIP [label="SIP"];
+  ATS -> SIP [label="VTY"];
+}
+%}