chore: Add first unit tests (#124)

* Adding first unit tests

* Run CI on every push

* Suppress unusedresult in the test

* Fixing gofmt error

* Addressing PR comment

.github/workflows/main.yml

@@ -8,8 +8,6 @@ on:
     branches:
       - main
   push:
-    branches:
-      - main
 
 jobs:
   build:

.gitignore

@@ -2,5 +2,9 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+.idea/
+.vscode/
+
+*.log
 
 vendor*

common/events_test.go

@@ -0,0 +1,40 @@
+// Copyright 2024 Canonical Ltd.
+//
+// SPDX-License-Identifier: Apache-2.0
+package common
+
+import (
+	"bytes"
+	"fmt"
+	"testing"
+
+	"github.com/omec-project/gnbsim/logger"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestString_ValidEventTypeReturnsEventTypeString(t *testing.T) {
+	for event_type, event_type_str := range evtStrMap {
+		t.Run(
+			fmt.Sprintf("Testing [%v]", event_type),
+			func(t *testing.T) {
+				out := event_type.String()
+				if out != event_type_str {
+					t.Errorf("Invalid event string %v for %v", out, event_type)
+				}
+			},
+		)
+	}
+}
+
+func TestString_InvalidEventTypeExitsWithLogMsg(t *testing.T) {
+	var INVALID_EVENT EventType = 0x0
+	var logBuf bytes.Buffer
+	assert := assert.New(t)
+	patchedExit := func(int) { panic("Dummy exit function") }
+
+	logger.AppLog.Logger.SetOutput(&logBuf)
+	logger.AppLog.Logger.ExitFunc = patchedExit
+
+	assert.Panics(func() { _ = INVALID_EVENT.String() })
+	assert.Contains(logBuf.String(), "Invalid Event ID: 0x0")
+}

go.mod

@@ -20,6 +20,7 @@ require (
 	github.com/omec-project/ngap v1.1.0
 	github.com/omec-project/openapi v1.1.0
 	github.com/sirupsen/logrus v1.9.3
+	github.com/stretchr/testify v1.8.4
 	github.com/urfave/cli v1.22.14
 	github.com/yerden/go-util v1.1.4
 	golang.org/x/net v0.20.0
@@ -36,6 +37,7 @@ require (
 	github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d // indirect
 	github.com/chenzhuoyu/iasm v0.9.0 // indirect
 	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/gabriel-vasile/mimetype v1.4.2 // indirect
 	github.com/gin-contrib/sse v0.1.0 // indirect
 	github.com/go-playground/locales v0.14.1 // indirect
@@ -61,6 +63,7 @@ require (
 	github.com/omec-project/util_3gpp v1.1.1 // indirect
 	github.com/pelletier/go-toml/v2 v2.1.0 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_golang v1.11.1 // indirect
 	github.com/prometheus/client_model v0.2.0 // indirect
 	github.com/prometheus/common v0.26.0 // indirect