From b2a3e2f97c2396dd577dd890fa371b85035cb917 Mon Sep 17 00:00:00 2001
From: Eduardo Silva <eduardosilva@disroot.org>
Date: Fri, 1 Nov 2024 22:42:33 +0000
Subject: [PATCH] Added a unittest for the header parsing

---
 Makefile                 |  3 +++
 headers_whitebox_test.go | 51 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 Makefile
 create mode 100644 headers_whitebox_test.go

diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..7d09a83
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,3 @@
+test:
+	go test -coverprofile=coverage.out ./... -cover -bench=
+	go tool cover -html=coverage.out -o coverage.html
diff --git a/headers_whitebox_test.go b/headers_whitebox_test.go
new file mode 100644
index 0000000..0cdef96
--- /dev/null
+++ b/headers_whitebox_test.go
@@ -0,0 +1,51 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+)
+
+// TestParseTelemetryHeader_WithGoodBuffer
+// Given a well structured buffer it will output the expected
+// TelemetryHeaders struct
+func TestParseTelemetryHeader_WithGoodBuffer(t *testing.T) {
+  // Arrange
+  header := [112]byte{
+    0x02, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x05, 0x3f, 0x00, 0x00, 0x90, 0x99, 0x00, 0x00,
+    0x10, 0x01, 0x00, 0x00, 0x90, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00,
+    0x1d, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x60, 0x2b, 0x00, 0x00, 0x95, 0xd8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00,
+  }
+
+  expectedHeader := TelemetryHeaders{
+    Version: 2,
+    Status: 1,
+    TickRate: 60,
+    SessionInfoUpdate: 0,
+    SessionInfoLength: 16133,
+    SessionInfoOffset: 39312,
+    NumVars: 272,
+    VarHeaderOffset: 144,
+    NumBuf: 1,
+    BufLen: 1053,
+    BufOffset: 55445,
+  }
+
+  // Act
+  headers, err := parseTelemetryHeader(header)
+
+  // Assert
+  if err != nil {
+    t.Fatalf("Error parsing buffer: %v", err)
+  }
+  if cmp.Equal(expectedHeader, headers) {
+    t.Fatalf("Expected:\n%#v\nGot:\n%#v\n", expectedHeader, headers)
+  }
+}