Add new API: RankingSv1.GetRankingSummary

engine/rankings.go

@@ -513,3 +513,16 @@ func (rkS *RankingS) V1GetSchedule(ctx *context.Context, args *utils.ArgSchedule
 	*schedRankings = scheduledRankings
 	return nil
 }
+
+// V1GetRankingSummary returns a summary of ascending/descending stat of the last updated ranking
+func (rS *RankingS) V1GetRankingSummary(ctx *context.Context, arg utils.TenantIDWithAPIOpts, reply *RankingSummary) (err error) {
+	var rnk *Ranking
+	if rnk, err = rS.dm.GetRanking(arg.Tenant, arg.ID, true, true, utils.NonTransactional); err != nil {
+		return
+	}
+	rnk.rMux.RLock()
+	rnkS := rnk.asRankingSummary()
+	rnk.rMux.RUnlock()
+	*reply = *rnkS
+	return
+}

engine/rankings_test.go

@@ -0,0 +1,99 @@
+/*
+Real-time Online/Offline Charging System (OCS) for Telecom & ISP environments
+Copyright (C) ITsysCOM GmbH
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>
+*/
+
+package engine
+
+import (
+	"testing"
+	"time"
+
+	"github.com/cgrates/cgrates/config"
+)
+
+func TestNewRankingS(t *testing.T) {
+	dm := &DataManager{}
+	connMgr := &ConnManager{}
+	filterS := &FilterS{}
+	cgrcfg := &config.CGRConfig{}
+
+	rankingS := NewRankingS(dm, connMgr, filterS, cgrcfg)
+
+	if rankingS == nil {
+		t.Fatal("Expected RankingS to be non-nil, got nil")
+	}
+
+	if rankingS.dm != dm {
+		t.Errorf("Expected dm to be '%v', got '%v'", dm, rankingS.dm)
+	}
+	if rankingS.connMgr != connMgr {
+		t.Errorf("Expected connMgr to be '%v', got '%v'", connMgr, rankingS.connMgr)
+	}
+	if rankingS.filterS != filterS {
+		t.Errorf("Expected filterS to be '%v', got '%v'", filterS, rankingS.filterS)
+	}
+	if rankingS.cgrcfg != cgrcfg {
+		t.Errorf("Expected cgrcfg to be '%v', got '%v'", cgrcfg, rankingS.cgrcfg)
+	}
+	if rankingS.crn == nil {
+		t.Error("Expected crn to be initialized, got nil")
+	}
+	if rankingS.crnTQsMux == nil {
+		t.Error("Expected crnTQsMux to be initialized, got nil")
+	}
+	if len(rankingS.crnTQs) != 0 {
+		t.Errorf("Expected crnTQs to be empty, got length %d", len(rankingS.crnTQs))
+	}
+	if rankingS.storedRankings == nil {
+		t.Error("Expected storedRankings to be initialized, got nil")
+	}
+	if rankingS.storingStopped == nil {
+		t.Error("Expected storingStopped channel to be initialized, got nil")
+	}
+	if rankingS.rankingStop == nil {
+		t.Error("Expected rankingStop channel to be initialized, got nil")
+	}
+}
+func TestAsRankingSummary(t *testing.T) {
+	lastUpdateTime, err := time.Parse(time.RFC3339, "2024-10-21T00:00:00Z")
+	if err != nil {
+		t.Fatalf("Failed to parse time: %v", err)
+	}
+
+	ranking := &Ranking{
+		Tenant:            "tenant1",
+		ID:                "ranking1",
+		LastUpdate:        lastUpdateTime,
+		SortedStatIDs:     []string{"stat1", "stat2", "stat3"},
+		Metrics:           make(map[string]map[string]float64),
+		Sorting:           "asc",
+		SortingParameters: []string{"param1", "param2"},
+	}
+
+	rkSm := ranking.asRankingSummary()
+
+	if rkSm.Tenant != ranking.Tenant {
+		t.Errorf("Expected Tenant to be '%s', got '%s'", ranking.Tenant, rkSm.Tenant)
+	}
+	if rkSm.ID != ranking.ID {
+		t.Errorf("Expected ID to be '%s', got '%s'", ranking.ID, rkSm.ID)
+	}
+	if rkSm.LastUpdate != ranking.LastUpdate {
+		t.Errorf("Expected LastUpdate to be '%v', got '%v'", ranking.LastUpdate, rkSm.LastUpdate)
+	}
+
+}