blob: 19a24841c53f28dfbe239ff95c8f4a3e6395e8c7 [file] [log] [blame]
Ankur Upadhyaya678a3652021-12-08 11:56:25 +05301TestPod
ajay60fd69f2021-11-23 22:38:10 -08002========
3
Ankur Upadhyayad8605312021-12-03 12:38:35 +05304Description
5-----------
6Testpod is developer tool to simulate 5G NFs and control NF behaviour as
7per test case requirement. Currently, it simulates AMF, NRF, PCF, UDM and UPF.
8While all other NFs run virtually on single pod, SMF runs on actual image on another pod.
9
10The Testpod can be run locally on any environment having miniKube via helm test package
11file present in repository OR locally as in binary mode.
12
Ankur Upadhyaya678a3652021-12-08 11:56:25 +053013How to use TestPod
ajay60fd69f2021-11-23 22:38:10 -080014------------------
Ankur Upadhyayad8605312021-12-03 12:38:35 +053015
Ankur Upadhyaya678a3652021-12-08 11:56:25 +053016* Repository
17 * `https://github.com/omec-project/testpod5G.git`
Ankur Upadhyayad8605312021-12-03 12:38:35 +053018
Ankur Upadhyaya678a3652021-12-08 11:56:25 +053019* Execution
20 * Binary mode
21 * SMF (NF to be tested)
22 * Make SMF clone (`git clone --branch onf-release3.0.5 https://github.com/omec-project/smf.git --recursive`)
23 * Change SMF PFCP port to 8806 (lib/pfcp/pfcpUdp/udp.go PFCP_PORT = 8806)
24 * Compile SMF (go build)
25 * Run SMF image(./smf -smfcfg ../../config/smfcfg.yaml -uerouting ../../config/uerouting.yaml)
26 * UPF (Only PFCP layer)
27 * Make UPF clone (`git clone https://github.com/badhrinathpa/upf-epc.git`)
28 * git checkout "sim_fast_path" branch
29 * cd pfcpiface and do "go build"
30 * Run UPF pfcp image (./pfcpiface -config ../conf/upf.json)
31 * TestPod App
32 * Make Testpod clone (`git clone https://github.com/omec-project/testpod5G.git`)
33 * Compile Testpod image(go build)
34 * Run Testpod image as AMF to test SMF ( ./testpod amf )
35 * Update local DNS table as following (/etc/hosts)
36 * # Testpod specific
37 * 127.0.0.1 upf
38 * 127.0.0.1 smf
39 * 127.0.0.1 nrf
40 * 127.0.0.1 pcf
41 * 127.0.0.1 amf
42 * 127.0.0.1 udm
43
44 * Minikube mode
45 * Install minikube using Homebrew (brew install minikube)
46 * Make Testpod clone (`git clone https://github.com/omec-project/testpod5G.git`)
47 * To test SMF(precondition- UPF should be running)
48 * helm install smftest ./helm/smf/