Create pfcpiface unit tests' scaffolding

.github/workflows/run-pfcp-agent-unit-test.yml

@@ -0,0 +1,20 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2022-present Open Networking Foundation
+name: Unit tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  unit-test-pfcpiface:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.4.0
+      - uses: actions/setup-go@v2
+
+      - name: Run unit tests for PFCP Agent
+        run: |
+          make test

.gitignore

@@ -1,5 +1,6 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright 2019 Intel Corporation
+.coverage/
 *.pyc
 *.swp
 output

Makefile

@@ -84,6 +84,19 @@ py-pb:
 		.;
 	cp -a output/bess_pb/. ${PTF_PB_DIR}
 
+.coverage:
+	rm -rf $(CURDIR)/.coverage
+	mkdir -p $(CURDIR)/.coverage
+
+test: .coverage
+	docker run --rm -v $(CURDIR):/upf-epc -w /upf-epc golang:latest \
+		go test \
+			-race \
+			-coverprofile=.coverage/coverage-unit.txt \
+			-covermode=atomic \
+			-v \
+			./pfcpiface
+
 fmt:
 	@go fmt ./...
 
@@ -93,4 +106,4 @@ golint:
 check-reuse:
 	@docker run --rm -v $(CURDIR):/upf-epc -w /upf-epc omecproject/reuse-verify:latest reuse lint
 
-.PHONY: docker-build docker-push output pb fmt golint check-reuse test-up4-integration
+.PHONY: docker-build docker-push output pb fmt golint check-reuse test-up4-integration .coverage test

go.mod

@@ -25,5 +25,6 @@ require (
 	google.golang.org/genproto v0.0.0-20201110150050-8816d57aaa9a
 	google.golang.org/grpc v1.43.0
 	google.golang.org/protobuf v1.27.1
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 	gotest.tools/v3 v3.1.0 // indirect
 )

go.sum

@@ -975,8 +975,9 @@ gopkg.in/yaml.v2 v2.2.5/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
+gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gotest.tools v2.2.0+incompatible h1:VsBPFP1AI068pPrMxtb/S8Zkgf9xEmTLJjfM+P5UIEo=
 gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw=
 gotest.tools/v3 v3.0.2/go.mod h1:3SzNCllyD9/Y+b5r9JIKQ474KzkZyqLqEfYqMsX94Bk=

pfcpiface/parse-far_test.go

@@ -0,0 +1,157 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2022-present Open Networking Foundation
+
+package main
+
+import (
+	"net"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"github.com/wmnsk/go-pfcp/ie"
+)
+
+type testCase struct {
+	input       *ie.IE
+	op          operation
+	expected    *far
+	description string
+}
+
+const (
+	defaultGTPProtocolPort = 2152
+)
+
+// TODO use pfcpsim library to create FARs
+
+func TestParseFAR(t *testing.T) {
+	createOp, updateOp := create, update
+
+	var FSEID uint64 = 100
+
+	coreIP := net.ParseIP("10.0.10.1")
+	UEAddressForDownlink := net.ParseIP("10.0.1.1")
+
+	for _, scenario := range []testCase{
+		{
+			op: createOp,
+			input: ie.NewCreateFAR(
+				ie.NewFARID(999),
+				ie.NewApplyAction(ActionDrop),
+				ie.NewForwardingParameters(
+					ie.NewDestinationInterface(core),
+				),
+			),
+			expected: &far{
+				farID:       999,
+				applyAction: ActionDrop,
+				fseID:       FSEID,
+			},
+			description: "Valid Uplink FAR input with create operation",
+		},
+		{
+			op: updateOp,
+			input: ie.NewUpdateFAR(
+				ie.NewFARID(1),
+				ie.NewApplyAction(ActionForward),
+				ie.NewUpdateForwardingParameters(
+					ie.NewDestinationInterface(access),
+					ie.NewOuterHeaderCreation(0x100, 100, UEAddressForDownlink.String(), "", 0, 0, 0),
+				),
+			),
+			expected: &far{
+				farID:        1,
+				fseID:        FSEID,
+				applyAction:  ActionForward,
+				dstIntf:      access,
+				tunnelTEID:   100,
+				tunnelType:   access,
+				tunnelIP4Src: ip2int(coreIP),
+				tunnelIP4Dst: ip2int(UEAddressForDownlink),
+				tunnelPort:   uint16(defaultGTPProtocolPort),
+			},
+			description: "Valid Downlink FAR input with update operation",
+		},
+	} {
+		t.Run(scenario.description, func(t *testing.T) {
+			mockFar := &far{}
+			mockUpf := &upf{
+				accessIP: net.ParseIP("192.168.0.1"),
+				coreIP:   coreIP,
+			}
+
+			err := mockFar.parseFAR(scenario.input, FSEID, mockUpf, scenario.op)
+			require.NoError(t, err)
+
+			assert.Equal(t, mockFar, scenario.expected)
+		})
+	}
+}
+
+func TestParseFARShouldError(t *testing.T) {
+	createOp, updateOp := create, update
+
+	var FSEID uint64 = 101
+
+	for _, scenario := range []testCase{
+		{
+			op: createOp,
+			input: ie.NewCreateFAR(
+				ie.NewFARID(1),
+				ie.NewApplyAction(0),
+				ie.NewForwardingParameters(
+					ie.NewDestinationInterface(ie.DstInterfaceCore),
+				),
+			),
+			expected: &far{
+				farID: 1,
+				fseID: FSEID,
+			},
+			description: "Uplink FAR with invalid action",
+		},
+		{
+			op: updateOp,
+			input: ie.NewUpdateFAR(
+				ie.NewFARID(1),
+				ie.NewApplyAction(0),
+				ie.NewUpdateForwardingParameters(
+					ie.NewDestinationInterface(ie.DstInterfaceAccess),
+					ie.NewOuterHeaderCreation(0x100, 100, "10.0.0.1", "", 0, 0, 0),
+				),
+			),
+			expected: &far{
+				farID: 1,
+				fseID: FSEID,
+			},
+			description: "Downlink FAR with invalid action",
+		},
+		{
+			op: createOp,
+			input: ie.NewCreateFAR(
+				ie.NewApplyAction(ActionDrop),
+				ie.NewUpdateForwardingParameters(
+					ie.NewDestinationInterface(ie.DstInterfaceAccess),
+					ie.NewOuterHeaderCreation(0x100, 100, "10.0.0.1", "", 0, 0, 0),
+				),
+			),
+			expected: &far{
+				fseID: FSEID,
+			},
+			description: "Malformed Downlink FAR with missing FARID",
+		},
+	} {
+		t.Run(scenario.description, func(t *testing.T) {
+			mockFar := &far{}
+			mockUpf := &upf{
+				accessIP: net.ParseIP("192.168.0.1"),
+				coreIP:   net.ParseIP("10.0.0.1"),
+			}
+
+			err := mockFar.parseFAR(scenario.input, 101, mockUpf, scenario.op)
+			require.Error(t, err)
+
+			assert.Equal(t, scenario.expected, mockFar)
+		})
+	}
+}