Files
cgrates/apier/v1/caches_it_test.go

479 lines
16 KiB
Go

//go:build integration
// +build integration
/*
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 Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>
*/
package v1
import (
"path"
"reflect"
"testing"
"time"
"github.com/cgrates/birpc"
"github.com/cgrates/birpc/context"
"github.com/cgrates/cgrates/config"
"github.com/cgrates/cgrates/engine"
"github.com/cgrates/cgrates/utils"
"github.com/cgrates/ltcache"
)
var (
chcCfg *config.CGRConfig
chcRPC *birpc.Client
chcCfgPath string
cacheConfigDIR string
sTestsCacheSV1 = []func(t *testing.T){
testCacheSLoadConfig,
testCacheSInitDataDb,
testCacheSInitStorDb,
testCacheSStartEngine,
testCacheSRpcConn,
testCacheSLoadTariffPlanFromFolder,
testCacheSAfterLoadFromFolder,
testCacheSFlush,
testCacheSReload,
testCacheSGetItemIDs,
testCacheSHasItem,
testCacheSGetItemExpiryTime,
testCacheSReloadCache,
testCacheSRemoveItem,
testCacheSRemoveItems,
testCacheSClear,
testCacheSReload,
testCacheSPrecacheStatus,
testCacheSPing,
testCacheSStopEngine,
}
)
// Test start here
func TestCacheSv1IT(t *testing.T) {
switch *utils.DBType {
case utils.MetaInternal:
t.SkipNow()
case utils.MetaMySQL:
cacheConfigDIR = "tutmysql"
case utils.MetaMongo:
cacheConfigDIR = "tutmongo"
case utils.MetaPostgres:
t.SkipNow()
default:
t.Fatal("Unknown Database type")
}
for _, stest := range sTestsCacheSV1 {
t.Run(cacheConfigDIR, stest)
}
}
func testCacheSLoadConfig(t *testing.T) {
var err error
chcCfgPath = path.Join(*utils.DataDir, "conf", "samples", "precache", cacheConfigDIR)
if chcCfg, err = config.NewCGRConfigFromPath(chcCfgPath); err != nil {
t.Error(err)
}
}
func testCacheSInitDataDb(t *testing.T) {
if err := engine.InitDataDB(chcCfg); err != nil {
t.Fatal(err)
}
}
// Empty tables before using them
func testCacheSInitStorDb(t *testing.T) {
if err := engine.InitStorDb(chcCfg); err != nil {
t.Fatal(err)
}
}
// Start engine
func testCacheSStartEngine(t *testing.T) {
if _, err := engine.StopStartEngine(chcCfgPath, *utils.WaitRater); err != nil {
t.Fatal(err)
}
}
func testCacheSRpcConn(t *testing.T) {
var err error
chcRPC, err = newRPCClient(chcCfg.ListenCfg()) // We connect over JSON so we can also troubleshoot if needed
if err != nil {
t.Fatal("Could not connect to RPC: ", err.Error())
}
}
func testCacheSLoadTariffPlanFromFolder(t *testing.T) {
var reply string
attrs := &utils.AttrLoadTpFromFolder{FolderPath: path.Join(*utils.DataDir, "tariffplans", "testtp")}
if err := chcRPC.Call(context.Background(), utils.APIerSv1LoadTariffPlanFromFolder, attrs, &reply); err != nil {
t.Error(err)
}
time.Sleep(time.Duration(*utils.WaitRater) * time.Millisecond)
}
func testCacheSAfterLoadFromFolder(t *testing.T) {
var rcvStats map[string]*ltcache.CacheStats
expStats := engine.GetDefaultEmptyCacheStats()
expStats[utils.CacheActions].Items = 5
expStats[utils.CacheDestinations].Items = 3
expStats[utils.CacheLoadIDs].Items = 20
expStats[utils.CacheRPCConnections].Items = 2
if err := chcRPC.Call(context.Background(), utils.CacheSv1GetCacheStats, &utils.AttrCacheIDsWithAPIOpts{}, &rcvStats); err != nil {
t.Error("Got error on CacheSv1.GetCacheStats: ", err.Error())
} else if !reflect.DeepEqual(expStats, rcvStats) {
t.Errorf("Expecting: %+v, \n received: %+v", utils.ToJSON(expStats), utils.ToJSON(rcvStats))
}
reply := ""
// Simple test that command is executed without errors
if err := chcRPC.Call(context.Background(), utils.CacheSv1LoadCache, utils.NewAttrReloadCacheWithOpts(), &reply); err != nil {
t.Error(err)
} else if reply != utils.OK {
t.Error(reply)
}
expStats[utils.CacheAccountActionPlans].Items = 3
expStats[utils.CacheActionPlans].Items = 7
expStats[utils.CacheActionTriggers].Items = 1
expStats[utils.CacheActions].Items = 13
expStats[utils.CacheAttributeProfiles].Items = 1
expStats[utils.CacheFilters].Items = 15
expStats[utils.CacheRatingPlans].Items = 5
expStats[utils.CacheRatingProfiles].Items = 5
expStats[utils.CacheResourceProfiles].Items = 3
expStats[utils.CacheResources].Items = 3
expStats[utils.CacheReverseDestinations].Items = 5
expStats[utils.CacheStatQueueProfiles].Items = 1
expStats[utils.CacheStatQueues].Items = 1
expStats[utils.CacheRouteProfiles].Items = 2
expStats[utils.CacheThresholdProfiles].Items = 1
expStats[utils.CacheThresholds].Items = 1
expStats[utils.CacheLoadIDs].Items = 38
expStats[utils.CacheTimings].Items = 12
expStats[utils.CacheThresholdFilterIndexes].Items = 5
expStats[utils.CacheThresholdFilterIndexes].Groups = 1
expStats[utils.CacheStatFilterIndexes].Items = 2
expStats[utils.CacheStatFilterIndexes].Groups = 1
expStats[utils.CacheRouteFilterIndexes].Items = 2
expStats[utils.CacheRouteFilterIndexes].Groups = 1
expStats[utils.CacheResourceFilterIndexes].Items = 5
expStats[utils.CacheResourceFilterIndexes].Groups = 1
expStats[utils.CacheAttributeFilterIndexes].Items = 4
expStats[utils.CacheAttributeFilterIndexes].Groups = 1
expStats[utils.CacheReverseFilterIndexes].Items = 10
expStats[utils.CacheReverseFilterIndexes].Groups = 7
expStats[utils.CacheRankingProfiles].Items = 1
expStats[utils.CacheRankings].Items = 1
expStats[utils.CacheTrendProfiles].Items = 1
expStats[utils.CacheTrends].Items = 1
if err := chcRPC.Call(context.Background(), utils.CacheSv1GetCacheStats, &utils.AttrCacheIDsWithAPIOpts{}, &rcvStats); err != nil {
t.Error(err)
} else if !reflect.DeepEqual(expStats, rcvStats) {
t.Errorf("Expecting: %+v,\n received: %+v", utils.ToJSON(expStats), utils.ToJSON(rcvStats))
}
}
func testCacheSFlush(t *testing.T) {
reply := ""
if err := chcRPC.Call(context.Background(), utils.CacheSv1Clear, &utils.AttrCacheIDsWithAPIOpts{
CacheIDs: nil,
}, &reply); err != nil {
t.Error("Got error on CacheSv1.ReloadCache: ", err.Error())
} else if reply != utils.OK {
t.Error("Calling CacheSv1.ReloadCache got reply: ", reply)
}
var rcvStats map[string]*ltcache.CacheStats
expStats := engine.GetDefaultEmptyCacheStats()
if err := chcRPC.Call(context.Background(), utils.CacheSv1GetCacheStats, &utils.AttrCacheIDsWithAPIOpts{}, &rcvStats); err != nil {
t.Error("Got error on CacheSv1.GetCacheStats: ", err.Error())
} else if !reflect.DeepEqual(expStats, rcvStats) {
t.Errorf("Expecting: %+v, received: %+v", utils.ToJSON(expStats), utils.ToJSON(rcvStats))
}
}
func testCacheSReload(t *testing.T) {
var rcvStats map[string]*ltcache.CacheStats
expStats := engine.GetDefaultEmptyCacheStats()
reply := ""
// Simple test that command is executed without errors
if err := chcRPC.Call(context.Background(), utils.CacheSv1LoadCache, utils.NewAttrReloadCacheWithOpts(), &reply); err != nil {
t.Error(err)
} else if reply != utils.OK {
t.Error(reply)
}
expStats[utils.CacheAccountActionPlans].Items = 3
expStats[utils.CacheActionPlans].Items = 7
expStats[utils.CacheActions].Items = 6
expStats[utils.CacheDestinations].Items = 3
expStats[utils.CacheActionTriggers].Items = 1
expStats[utils.CacheActions].Items = 13
expStats[utils.CacheAttributeProfiles].Items = 1
expStats[utils.CacheFilters].Items = 15
expStats[utils.CacheRatingPlans].Items = 5
expStats[utils.CacheRatingProfiles].Items = 5
expStats[utils.CacheResourceProfiles].Items = 3
expStats[utils.CacheResources].Items = 3
expStats[utils.CacheReverseDestinations].Items = 5
expStats[utils.CacheStatQueueProfiles].Items = 1
expStats[utils.CacheStatQueues].Items = 1
expStats[utils.CacheRouteProfiles].Items = 2
expStats[utils.CacheThresholdProfiles].Items = 1
expStats[utils.CacheThresholds].Items = 1
expStats[utils.CacheLoadIDs].Items = 38
expStats[utils.CacheTimings].Items = 12
expStats[utils.CacheThresholdFilterIndexes].Items = 5
expStats[utils.CacheThresholdFilterIndexes].Groups = 1
expStats[utils.CacheStatFilterIndexes].Items = 2
expStats[utils.CacheStatFilterIndexes].Groups = 1
expStats[utils.CacheRouteFilterIndexes].Items = 2
expStats[utils.CacheRouteFilterIndexes].Groups = 1
expStats[utils.CacheResourceFilterIndexes].Items = 5
expStats[utils.CacheResourceFilterIndexes].Groups = 1
expStats[utils.CacheAttributeFilterIndexes].Items = 4
expStats[utils.CacheAttributeFilterIndexes].Groups = 1
expStats[utils.CacheReverseFilterIndexes].Items = 10
expStats[utils.CacheReverseFilterIndexes].Groups = 7
expStats[utils.CacheRankingProfiles].Items = 1
expStats[utils.CacheRankings].Items = 1
expStats[utils.CacheTrends].Items = 1
expStats[utils.CacheTrendProfiles].Items = 1
if err := chcRPC.Call(context.Background(), utils.CacheSv1GetCacheStats, &utils.AttrCacheIDsWithAPIOpts{}, &rcvStats); err != nil {
t.Error(err)
}
rcvStats[utils.MetaAPIBan].Items = 0
if !reflect.DeepEqual(expStats, rcvStats) {
t.Errorf("Expecting: %+v, received: %+v", utils.ToJSON(expStats), utils.ToJSON(rcvStats))
}
}
func testCacheSGetItemIDs(t *testing.T) {
var rcvKeys []string
var expKeys []string
argsAPI := utils.ArgsGetCacheItemIDs{
CacheID: utils.CacheThresholdProfiles,
ItemIDPrefix: "NotExistent",
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1GetItemIDs, argsAPI, &rcvKeys); err == nil || err.Error() != utils.ErrNotFound.Error() {
t.Fatalf("Expected error: %s received error: %s and reply: %v ", utils.ErrNotFound, err.Error(), rcvKeys)
}
expKeys = []string{"cgrates.org:Threshold1"}
argsAPI = utils.ArgsGetCacheItemIDs{
CacheID: utils.CacheThresholdProfiles,
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1GetItemIDs, argsAPI, &rcvKeys); err != nil {
t.Fatalf("Got error on APIerSv1.GetCacheStats: %s ", err.Error())
}
if !reflect.DeepEqual(expKeys, rcvKeys) {
t.Errorf("Expected: %+v, received: %+v", expKeys, rcvKeys)
}
}
func testCacheSHasItem(t *testing.T) {
var reply bool
var expected bool
argsAPI := utils.ArgsGetCacheItem{
CacheID: utils.CacheThresholdProfiles,
ItemID: "NotExistent",
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1HasItem, argsAPI, &reply); err != nil {
t.Error(err)
} else if reply {
t.Errorf("Expected: %v , received:%v", expected, reply)
}
expected = true
argsAPI = utils.ArgsGetCacheItem{
CacheID: utils.CacheThresholdProfiles,
ItemID: "cgrates.org:Threshold1",
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1HasItem, argsAPI, &reply); err != nil {
t.Error(err)
} else if !reply {
t.Errorf("Expected: %v , received:%v", expected, reply)
}
}
func testCacheSGetItemExpiryTime(t *testing.T) {
var reply time.Time
var expected time.Time
argsAPI := utils.ArgsGetCacheItem{
CacheID: utils.CacheThresholdProfiles,
ItemID: "NotExistent",
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1GetItemExpiryTime, argsAPI, &reply); err == nil || err.Error() != utils.ErrNotFound.Error() {
t.Fatalf("Expected error: %s received error: %s and reply: %v ", utils.ErrNotFound, err.Error(), reply)
}
// expected = true
argsAPI = utils.ArgsGetCacheItem{
CacheID: utils.CacheThresholdProfiles,
ItemID: "cgrates.org:Threshold1",
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1GetItemExpiryTime, argsAPI, &reply); err != nil {
t.Error(err)
} else if !reflect.DeepEqual(expected, reply) {
t.Errorf("Expected: %v , received:%v", expected, reply)
}
}
func testCacheSReloadCache(t *testing.T) {
var reply string
if err := chcRPC.Call(context.Background(), utils.CacheSv1ReloadCache, new(utils.AttrReloadCacheWithAPIOpts), &reply); err != nil {
t.Error("Got error on CacheSv1.ReloadCache: ", err.Error())
} else if reply != utils.OK {
t.Error("Calling CacheSv1.ReloadCache got reply: ", reply)
}
}
func testCacheSRemoveItem(t *testing.T) {
var reply bool
argsAPI := utils.ArgsGetCacheItem{
CacheID: utils.CacheThresholdProfiles,
ItemID: "cgrates.org:Threshold1",
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1HasItem, argsAPI, &reply); err != nil {
t.Error(err)
} else if !reply {
t.Errorf("Expected: %v , received:%v", true, reply)
}
var remReply string
if err := chcRPC.Call(context.Background(), utils.CacheSv1RemoveItem, argsAPI, &remReply); err != nil {
t.Error(err)
} else if remReply != utils.OK {
t.Errorf("Expected: %v , received:%v", utils.OK, remReply)
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1HasItem, argsAPI, &reply); err != nil {
t.Error(err)
} else if reply {
t.Errorf("Expected: %v , received:%v", false, reply)
}
}
func testCacheSRemoveItems(t *testing.T) {
// var rcvKeys []string
// expKeys := []string{"cgrates.org:Stats1"}
// argsAPI2 := utils.ArgsGetCacheItemIDs{
// CacheID: utils.CacheStatQueueProfiles,
// }
// if err := chcRPC.Call(context.Background(),utils.CacheSv1GetItemIDs, argsAPI2, &rcvKeys); err != nil {
// t.Fatalf("Got error on APIerSv1.GetCacheStats: %s ", err.Error())
// }
// if !reflect.DeepEqual(expKeys, rcvKeys) {
// t.Errorf("Expected: %+v, received: %+v", expKeys, rcvKeys)
// }
var reply bool
argsAPI := utils.ArgsGetCacheItem{
CacheID: utils.CacheStatQueueProfiles,
ItemID: "cgrates.org:Stats1",
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1HasItem, argsAPI, &reply); err != nil {
t.Error(err)
} else if !reply {
t.Errorf("Expected: %v , received:%v", true, reply)
}
argsAPI = utils.ArgsGetCacheItem{
CacheID: utils.CacheRouteProfiles,
ItemID: "cgrates.org:ROUTE_1",
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1HasItem, argsAPI, &reply); err != nil {
t.Error(err)
} else if !reply {
t.Errorf("Expected: %v , received:%v", true, reply)
}
var remReply string
if err := chcRPC.Call(context.Background(), utils.CacheSv1RemoveItems, &utils.AttrReloadCacheWithAPIOpts{
APIOpts: make(map[string]any),
Tenant: "cgrates.org",
StatsQueueProfileIDs: []string{"cgrates.org:Stats1"},
RouteProfileIDs: []string{"cgrates.org:ROUTE_1"},
}, &remReply); err != nil {
t.Error(err)
} else if remReply != utils.OK {
t.Errorf("Expected: %v , received:%v", utils.OK, remReply)
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1HasItem, argsAPI, &reply); err != nil {
t.Error(err)
} else if reply {
t.Errorf("Expected: %v , received:%v", false, reply)
}
argsAPI = utils.ArgsGetCacheItem{
CacheID: utils.CacheStatQueueProfiles,
ItemID: "cgrates.org:Stats1",
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1HasItem, argsAPI, &reply); err != nil {
t.Error(err)
} else if reply {
t.Errorf("Expected: %v , received:%v", false, reply)
}
}
func testCacheSClear(t *testing.T) {
reply := ""
if err := chcRPC.Call(context.Background(), utils.CacheSv1Clear, &utils.AttrCacheIDsWithAPIOpts{}, &reply); err != nil {
t.Error(err)
} else if reply != utils.OK {
t.Error("Calling CacheSv1.ReloadCache got reply: ", reply)
}
var rcvStats map[string]*ltcache.CacheStats
expStats := engine.GetDefaultEmptyCacheStats()
if err := chcRPC.Call(context.Background(), utils.CacheSv1GetCacheStats, &utils.AttrCacheIDsWithAPIOpts{}, &rcvStats); err != nil {
t.Error("Got error on CacheSv1.GetCacheStats: ", err.Error())
} else if !reflect.DeepEqual(expStats, rcvStats) {
t.Errorf("Expecting: %+v, received: %+v", utils.ToJSON(expStats), utils.ToJSON(rcvStats))
}
}
func testCacheSPrecacheStatus(t *testing.T) {
var reply map[string]string
expected := make(map[string]string)
for k := range utils.CachePartitions {
expected[k] = utils.MetaReady
}
if err := chcRPC.Call(context.Background(), utils.CacheSv1PrecacheStatus, &utils.AttrCacheIDsWithAPIOpts{}, &reply); err != nil {
t.Fatal(err)
}
reply[utils.MetaAPIBan] = utils.MetaReady // do not check the status for this partition
if !reflect.DeepEqual(expected, reply) {
t.Errorf("Expected: %v , received:%v", utils.ToJSON(expected), utils.ToJSON(reply))
}
}
func testCacheSPing(t *testing.T) {
var reply string
expected := utils.Pong
if err := chcRPC.Call(context.Background(), utils.CacheSv1Ping, &utils.CGREvent{}, &reply); err != nil {
t.Error(err)
} else if !reflect.DeepEqual(expected, reply) {
t.Errorf("Expected: %v , received:%v", utils.ToJSON(expected), utils.ToJSON(reply))
}
}
func testCacheSStopEngine(t *testing.T) {
if err := engine.KillEngine(100); err != nil {
t.Error(err)
}
}