From 926eeb7127c8d05a6697b2f3c755b4ad47f581af Mon Sep 17 00:00:00 2001
From: Alejandro Mery <amery@jpi.io>
Date: Tue, 28 May 2024 02:36:25 +0000
Subject: [PATCH] rings: DecodeRingZeroAddress() and DecodeRingOneAddress()

Signed-off-by: Alejandro Mery <amery@jpi.io>
---
 pkg/rings/decode.go      | 28 +++++++++++++++++++++
 pkg/rings/decode_test.go | 53 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 81 insertions(+)
 create mode 100644 pkg/rings/decode_test.go

diff --git a/pkg/rings/decode.go b/pkg/rings/decode.go
index 83ba50b..820876d 100644
--- a/pkg/rings/decode.go
+++ b/pkg/rings/decode.go
@@ -60,3 +60,31 @@ func unsafeDecodeAddress(a, b, c, d byte) (Ring, RegionID, ZoneID, uint) {
 		return k, r, z, n
 	}
 }
+
+// DecodeRingZeroAddress attempts to extract region, zone and node identifiers
+// from a given ring 0 address.
+//
+// revive:disable:function-result-limit
+func DecodeRingZeroAddress(addr netip.Addr) (RegionID, ZoneID, NodeID, bool) {
+	// revive:enable:function-result-limit
+	k, r, z, n := DecodeAddress(addr)
+	if k == RingZero {
+		return r, z, NodeID(n), true
+	}
+
+	return 0, 0, 0, false
+}
+
+// DecodeRingOneAddress attempts to extract region, zone and node identifiers
+// from a given ring 1 address.
+//
+// revive:disable:function-result-limit
+func DecodeRingOneAddress(addr netip.Addr) (RegionID, ZoneID, NodeID, bool) {
+	// revive:enable:function-result-limit
+	k, r, z, n := DecodeAddress(addr)
+	if k == RingOne {
+		return r, z, NodeID(n), true
+	}
+
+	return 0, 0, 0, false
+}
diff --git a/pkg/rings/decode_test.go b/pkg/rings/decode_test.go
new file mode 100644
index 0000000..2dff604
--- /dev/null
+++ b/pkg/rings/decode_test.go
@@ -0,0 +1,53 @@
+package rings
+
+import (
+	"fmt"
+	"net/netip"
+	"testing"
+)
+
+func TestDecodeRingZeroAddress(t *testing.T) {
+	RZNDecodeTest(t, "DecodeRingZeroAddress", DecodeRingZeroAddress, []RZNDecodeTestCase{
+		{1, 1, 50, MustParseAddr("10.0.17.50"), true},
+		{1, 2, 50, MustParseAddr("10.0.18.50"), true},
+		{2, 3, 1, MustParseAddr("10.0.35.1"), true},
+	})
+}
+
+func TesDecodetRingOneAddress(t *testing.T) {
+	RZNDecodeTest(t, "DecodeRingOneAddress", DecodeRingOneAddress, []RZNDecodeTestCase{
+		{1, 1, 50, MustParseAddr("10.1.16.50"), true},
+		{1, 2, 50, MustParseAddr("10.1.32.50"), true},
+		{2, 3, 300, MustParseAddr("10.2.49.44"), true},
+	})
+}
+
+type RZNDecodeTestCase struct {
+	region RegionID
+	zone   ZoneID
+	node   NodeID
+	addr   netip.Addr
+	ok     bool
+}
+
+func RZNDecodeTest(t *testing.T,
+	fnName string, fn func(netip.Addr) (RegionID, ZoneID, NodeID, bool),
+	cases []RZNDecodeTestCase) {
+	//
+	for i, tc := range cases {
+		s := fmt.Sprintf("%s(%q)", fnName, tc.addr)
+
+		r, z, n, ok := fn(tc.addr)
+
+		switch {
+		case ok != tc.ok, r != tc.region, z != tc.zone, n != tc.node:
+			t.Errorf("ERROR: [%v/%v]: %s → %v %v %v %v (expected %v %v %v %v)",
+				i, len(cases), s,
+				r, z, n, ok,
+				tc.region, tc.zone, tc.node, tc.ok)
+		default:
+			t.Logf("[%v/%v]: %s → %v %v %v %v", i, len(cases), s,
+				r, z, n, ok)
+		}
+	}
+}