Files
cgrates/general_tests/ees_it_test.go
ionutboangiu 49d6b8d565 Ensure CostDetails is of *EventCost type when parsing dynamicDP
CGREventWithEeIDs has also been optimized and properly tested. Comments
have been added explaining the process.

When sending a request to AttributeS from EEs, CostDetails from the reply
will now be overwritten by the original CostDetails to preserve its type.
The downside is that we are assuming that CostDetails was not altered by
AttributeS. We might consider adding a type check against *engine.EventCost
to at least stay backwards compatible with *gob and *internal connections.

general_tests/ees_it_test.go has been updated to ensure changes are working
properly.
2024-03-04 09:49:15 +01:00

308 lines
9.1 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 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 general_tests
import (
"os"
"testing"
"time"
"github.com/cgrates/birpc/context"
"github.com/cgrates/cgrates/config"
"github.com/cgrates/cgrates/engine"
"github.com/cgrates/cgrates/utils"
)
// TestEEsExportEventChanges tests if the event that's about to be exported can be changed from one exporter to
// another through AttributeS. Additionally (unrelated to the case presented in the previous sentence), it also
// checks that *opts.exporterID field is being set correctly.
//
// The test steps are as follows:
// 1. Configure inside ees two event exporters. First one has the *attribute flag, while the second doesn't.
// 2. Set an Attribute without filter that changes the request type to *prepaid.
// 3. Send an event with CGRID and RequestType *rated in a request to EeSv1.ProcessEvent.
// 4. Verify that first export has RequestType *prepaid, while the second one has *rated.
func TestEEsExportEventChanges(t *testing.T) {
switch *dbType {
case utils.MetaInternal:
case utils.MetaMySQL, utils.MetaMongo, utils.MetaPostgres:
t.SkipNow()
default:
t.Fatal("unsupported dbtype value")
}
content := `{
"general": {
"log_level": 7
},
"data_db": {
"db_type": "*internal"
},
"stor_db": {
"db_type": "*internal"
},
"apiers": {
"enabled": true
},
"attributes": {
"enabled": true
},
"ees": {
"enabled": true,
"attributes_conns":["*localhost"],
"exporters": [
{
"id": "exporter1",
"type": "*virt",
"export_path": "/tmp/exports",
"flags": ["*attributes"],
"attempts": 1,
"field_separator": ",",
"synchronous": true,
"fields":[
{"tag": "CGRID", "path": "*uch.CGRID1", "type": "*variable", "value": "~*req.CGRID"},
{"tag": "RequestType", "path": "*uch.RequestType1", "type": "*variable", "value": "~*req.RequestType"},
{"tag": "BalanceID", "path": "*uch.BalanceID", "type": "*variable", "value": "~*req.CostDetails.Charges[0].Increments[0].Accounting.Balance.ID"},
{"tag": "BalanceType", "path": "*uch.BalanceType", "type": "*variable", "value": "~*req.CostDetails.Charges[0].Increments[0].Accounting.Balance.Type"},
{"tag": "BalanceFound", "path": "*uch.BalanceFound", "type": "*variable", "value": "~*req.BalanceFound"},
{"tag": "ExporterID", "path": "*uch.ExporterID1", "type": "*variable", "value": "~*opts.*exporterID"}
],
},
{
"id": "exporter2",
"type": "*virt",
"export_path": "/tmp/exports",
"flags": [],
"attempts": 1,
"field_separator": ",",
"synchronous": true,
"fields":[
{"tag": "CGRID", "path": "*uch.CGRID2", "type": "*variable", "value": "~*req.CGRID"},
{"tag": "RequestType", "path": "*uch.RequestType2", "type": "*variable", "value": "~*req.RequestType"},
{"tag": "ExporterID", "path": "*uch.ExporterID2", "type": "*variable", "value": "~*opts.*exporterID"}
]
}
]
}
}`
exportPath := "/tmp/exports"
err = os.MkdirAll(exportPath, 0755)
if err != nil {
t.Fatalf("could not create folder %s: %v", exportPath, err)
}
defer os.RemoveAll(exportPath)
testEnv := TestEnvironment{
Name: "TestEEsExportEventChanges",
ConfigJSON: content,
}
client, _, shutdown, err := testEnv.Setup(t, *waitRater)
if err != nil {
t.Fatal(err)
}
defer shutdown()
t.Run("SetAttributeProfile", func(t *testing.T) {
attrPrf := &engine.AttributeProfileWithAPIOpts{
AttributeProfile: &engine.AttributeProfile{
Tenant: "cgrates.org",
ID: "ATTR_TEST",
Attributes: []*engine.Attribute{
{
Path: "*req.RequestType",
Value: config.RSRParsers{
&config.RSRParser{
Rules: utils.MetaPrepaid,
},
},
},
{
FilterIDs: []string{
"*string:~*req.CostDetails.Charges[0].Increments[0].Accounting.Balance.ID:BALANCE_TEST",
"*string:~*req.CostDetails.Charges[0].Increments[0].Accounting.Balance.Type:*voice",
},
Path: "*req.BalanceFound",
Type: utils.MetaVariable,
Value: config.RSRParsers{
&config.RSRParser{
Rules: utils.TrueStr,
},
},
},
},
Blocker: false,
Weight: 10,
},
}
attrPrf.Compile()
var result string
if err := client.Call(context.Background(), utils.APIerSv1SetAttributeProfile, attrPrf, &result); err != nil {
t.Error(err)
}
})
t.Run("ExportEvent", func(t *testing.T) {
eventToExport := &engine.CGREventWithEeIDs{
CGREvent: &utils.CGREvent{
Tenant: "cgrates.org",
ID: "voiceEvent",
Time: utils.TimePointer(time.Now()),
Event: map[string]any{
utils.CGRID: "TEST",
utils.RequestType: utils.MetaRated,
utils.CostDetails: &engine.EventCost{
Charges: []*engine.ChargingInterval{
{
Increments: []*engine.ChargingIncrement{
{
AccountingID: "ACCOUNTING_TEST",
},
},
},
},
Accounting: engine.Accounting{
"ACCOUNTING_TEST": &engine.BalanceCharge{
BalanceUUID: "123456",
},
},
AccountSummary: &engine.AccountSummary{
BalanceSummaries: engine.BalanceSummaries{
{
ID: "BALANCE_TEST",
Type: utils.MetaVoice,
UUID: "123456",
},
},
},
},
},
},
}
var reply map[string]map[string]any
if err := client.Call(context.Background(), utils.EeSv1ProcessEvent, eventToExport, &reply); err != nil {
t.Error(err)
}
var requestTypeExport1 any
if err = client.Call(context.Background(), utils.CacheSv1GetItem, &utils.ArgsGetCacheItemWithAPIOpts{
Tenant: "cgrates.org",
ArgsGetCacheItem: utils.ArgsGetCacheItem{
CacheID: utils.CacheUCH,
ItemID: "RequestType1",
},
}, &requestTypeExport1); err != nil {
t.Error(err)
} else if requestTypeExport1 != utils.MetaPrepaid {
t.Errorf("expected %v, received %v", utils.MetaPrepaid, requestTypeExport1)
}
var requestTypeExport2 any
if err = client.Call(context.Background(), utils.CacheSv1GetItem, &utils.ArgsGetCacheItemWithAPIOpts{
Tenant: "cgrates.org",
ArgsGetCacheItem: utils.ArgsGetCacheItem{
CacheID: utils.CacheUCH,
ItemID: "RequestType2",
},
}, &requestTypeExport2); err != nil {
t.Error(err)
} else if requestTypeExport2 != utils.MetaRated {
t.Errorf("expected %v, received %v", utils.MetaRated, requestTypeExport2)
}
})
t.Run("CheckExporterIDs", func(t *testing.T) {
var exporterID1 any
if err = client.Call(context.Background(), utils.CacheSv1GetItem, &utils.ArgsGetCacheItemWithAPIOpts{
Tenant: "cgrates.org",
ArgsGetCacheItem: utils.ArgsGetCacheItem{
CacheID: utils.CacheUCH,
ItemID: "ExporterID1",
},
}, &exporterID1); err != nil {
t.Error(err)
} else if exporterID1 != "exporter1" {
t.Errorf("expected %v, received %v", "exporter1", exporterID1)
}
var exporterID2 any
if err = client.Call(context.Background(), utils.CacheSv1GetItem, &utils.ArgsGetCacheItemWithAPIOpts{
Tenant: "cgrates.org",
ArgsGetCacheItem: utils.ArgsGetCacheItem{
CacheID: utils.CacheUCH,
ItemID: "ExporterID2",
},
}, &exporterID2); err != nil {
t.Error(err)
} else if exporterID2 != "exporter2" {
t.Errorf("expected %v, received %v", "exporter2", exporterID2)
}
})
t.Run("CheckAttributesAlteredFields", func(t *testing.T) {
var balanceID any
if err = client.Call(context.Background(), utils.CacheSv1GetItem, &utils.ArgsGetCacheItemWithAPIOpts{
Tenant: "cgrates.org",
ArgsGetCacheItem: utils.ArgsGetCacheItem{
CacheID: utils.CacheUCH,
ItemID: "BalanceID",
},
}, &balanceID); err != nil {
t.Error(err)
} else if balanceID != "BALANCE_TEST" {
t.Errorf("expected %v, received %v", "BALANCE_TEST", balanceID)
}
var balanceType any
if err = client.Call(context.Background(), utils.CacheSv1GetItem, &utils.ArgsGetCacheItemWithAPIOpts{
Tenant: "cgrates.org",
ArgsGetCacheItem: utils.ArgsGetCacheItem{
CacheID: utils.CacheUCH,
ItemID: "BalanceType",
},
}, &balanceType); err != nil {
t.Error(err)
} else if balanceType != utils.MetaVoice {
t.Errorf("expected %v, received %v", "BALANCE_TEST", balanceType)
}
var balanceFound any
if err = client.Call(context.Background(), utils.CacheSv1GetItem, &utils.ArgsGetCacheItemWithAPIOpts{
Tenant: "cgrates.org",
ArgsGetCacheItem: utils.ArgsGetCacheItem{
CacheID: utils.CacheUCH,
ItemID: "BalanceFound",
},
}, &balanceFound); err != nil {
t.Error(err)
} else if balanceFound != "true" {
t.Errorf("expected %v, received %v", "true", balanceFound)
}
})
}