Files
cgrates/engine/action_trigger_test.go
2025-04-11 13:09:50 +02:00

540 lines
16 KiB
Go

/*
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 (
"bytes"
"encoding/json"
"fmt"
"log"
"os"
"reflect"
"strings"
"testing"
"time"
"github.com/cgrates/cgrates/config"
"github.com/cgrates/cgrates/utils"
"github.com/google/go-cmp/cmp"
)
func TestActionTriggerClone(t *testing.T) {
var at *ActionTrigger
if rcv := at.Clone(); at != nil {
t.Errorf("Expecting : nil, received: %s", utils.ToJSON(rcv))
}
at = &ActionTrigger{}
eOut := &ActionTrigger{}
if rcv := at.Clone(); !reflect.DeepEqual(eOut, rcv) {
t.Errorf("Expecting : %s, received: %s", utils.ToJSON(eOut), utils.ToJSON(rcv))
}
ttime := time.Now()
at = &ActionTrigger{
ID: "testID",
UniqueID: "testUniqueID",
ThresholdType: "testThresholdType",
ThresholdValue: 0.1,
Recurrent: true,
MinSleep: 10,
ExpirationDate: ttime,
ActivationDate: ttime.Add(5),
Weight: 0.1,
ActionsID: "testActionsID",
MinQueuedItems: 7,
Executed: true,
LastExecutionTime: ttime.Add(1),
Balance: &BalanceFilter{
Uuid: utils.StringPointer("testUuid"),
},
}
eOut = &ActionTrigger{
ID: "testID",
UniqueID: "testUniqueID",
ThresholdType: "testThresholdType",
ThresholdValue: 0.1,
Recurrent: true,
MinSleep: 10,
ExpirationDate: ttime,
ActivationDate: ttime.Add(5),
Weight: 0.1,
ActionsID: "testActionsID",
MinQueuedItems: 7,
Executed: true,
LastExecutionTime: ttime.Add(1),
Balance: &BalanceFilter{
Uuid: utils.StringPointer("testUuid"),
},
}
rcv := at.Clone()
if !reflect.DeepEqual(eOut, rcv) {
t.Errorf("Expecting : %s, received: %s", utils.ToJSON(eOut), utils.ToJSON(rcv))
}
rcv.Balance.Uuid = utils.StringPointer("modified")
if at.Balance.Uuid == utils.StringPointer("modified") {
t.Errorf("Expedcting: modified, received %s", utils.ToJSON(at.Balance.Uuid))
}
}
func TestActionTriggersClone(t *testing.T) {
var atpl ActionTriggers
if rcv := atpl.Clone(); rcv != nil {
t.Errorf("Expecting : nil, received: %s", utils.ToJSON(rcv))
}
atpl = make(ActionTriggers, 0)
eOut := make(ActionTriggers, 0)
if rcv := atpl.Clone(); !reflect.DeepEqual(eOut, rcv) {
t.Errorf("Expecting : %s, received: %s", utils.ToJSON(eOut), utils.ToJSON(rcv))
}
atpl = []*ActionTrigger{
{
ID: "test1",
},
{
ID: "test2",
},
}
eOut = []*ActionTrigger{
{
ID: "test1",
},
{
ID: "test2",
},
}
if rcv := atpl.Clone(); !reflect.DeepEqual(eOut, rcv) {
t.Errorf("Expecting : %s, received: %s", utils.ToJSON(eOut), utils.ToJSON(rcv))
}
}
func TestActionTriggerFieldAsInterface(t *testing.T) {
at := &ActionTrigger{}
if _, err := at.FieldAsInterface([]string{}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"test"}); err == nil {
t.Error(err)
}
at = &ActionTrigger{
ID: "id",
UniqueID: "unId",
ThresholdType: "*max_balance_counter",
ThresholdValue: 16.1,
Recurrent: true,
MinSleep: 1 * time.Second,
ExpirationDate: time.Date(2023, 02, 22, 1, 0, 0, 0, time.UTC),
ActivationDate: time.Date(2022, 02, 22, 1, 0, 0, 0, time.UTC),
Balance: &BalanceFilter{},
Weight: 1.02,
ActionsID: "acID",
MinQueuedItems: 5,
Executed: true,
LastExecutionTime: time.Date(2022, 2, 22, 1, 0, 0, 0, time.UTC),
}
if _, err := at.FieldAsInterface([]string{"ID"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"ID", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"UniqueID"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"UniqueID", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"ThresholdType"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"ThresholdType", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"ThresholdValue"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"ThresholdValue", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"Recurrent"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"Recurrent", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"MinSleep"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"MinSleep", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"ExpirationDate"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"ExpirationDate", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"ActivationDate"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"ActivationDate", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"Balance"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"Balance", "test"}); err == nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"Weight"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"Weight", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"ActionsID"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"ActionsID", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"MinQueuedItems"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"MinQueuedItems", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"Executed"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"Executed", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"LastExecutionTime"}); err != nil {
t.Error(err)
} else if _, err = at.FieldAsInterface([]string{"LastExecutionTime", "test"}); err == nil || err != utils.ErrNotFound {
t.Error(err)
}
}
func TestActionTriggerFieldAsString(t *testing.T) {
at := &ActionTrigger{
ThresholdValue: 2.6,
}
if _, err := at.FieldAsString([]string{}); err == nil {
t.Error(err)
} else if val, err := at.FieldAsString([]string{"ThresholdValue"}); err != nil {
t.Error(err)
} else if val != "2.6" {
t.Errorf("received %v", val)
}
}
func TestActionTriggerCreateBalance(t *testing.T) {
at := &ActionTrigger{
UniqueID: "u_id",
Balance: &BalanceFilter{
Uuid: utils.StringPointer("uuid"),
ID: utils.StringPointer("bal_id"),
Type: utils.StringPointer("type"),
Categories: &utils.StringMap{
"category": true,
},
Value: &utils.ValueFormula{
Static: 22.21,
Method: "",
},
ExpirationDate: utils.TimePointer(time.Date(2022, 12, 1, 15, 0, 0, 0, time.UTC)),
DestinationIDs: &utils.StringMap{
"dest_id": true,
},
RatingSubject: utils.StringPointer("rating*"),
},
}
expBal := &Balance{
Uuid: "uuid",
ID: "u_id",
ExpirationDate: time.Date(2022, 12, 1, 15, 0, 0, 0, time.UTC),
RatingSubject: "rating*",
DestinationIDs: utils.StringMap{
"dest_id": true,
},
Value: 22.21,
Categories: utils.StringMap{
"category": true,
},
}
if val := at.CreateBalance(); reflect.DeepEqual(val, expBal) {
t.Errorf("expected %v,received %v", utils.ToJSON(expBal), utils.ToJSON(val))
}
}
func TestATExecute22(t *testing.T) {
cfg := config.NewDefaultCGRConfig()
tmp := Cache
tmpDm := dm
setLogger := func(buf *bytes.Buffer) {
utils.Logger.SetLogLevel(4)
utils.Logger.SetSyslog(nil)
log.SetOutput(buf)
}
removeLogger := func() {
utils.Logger.SetLogLevel(0)
log.SetOutput(os.Stderr)
}
buf := new(bytes.Buffer)
setLogger(buf)
defer func() {
removeLogger()
Cache = tmp
SetDataStorage(tmpDm)
config.SetCgrConfig(config.NewDefaultCGRConfig())
}()
Cache.Clear(nil)
cfg.DataDbCfg().Items = map[string]*config.ItemOpt{
utils.CacheActions: {
Limit: 2,
},
}
db, dErr := NewInternalDB(nil, nil, true, nil, cfg.DataDbCfg().Items)
if dErr != nil {
t.Error(dErr)
}
dm := NewDataManager(db, cfg.CacheCfg(), nil)
at := &ActionTrigger{
ID: "STANDARD_TRIGGER",
ActionsID: "actID",
UniqueID: "st0",
ThresholdType: utils.TriggerMinEventCounter,
ThresholdValue: 10,
Recurrent: true,
}
ub := &Account{
ID: "acc_id",
BalanceMap: map[string]Balances{},
UnitCounters: UnitCounters{},
ActionTriggers: ActionTriggers{},
AllowNegative: false,
UpdateTime: time.Date(2019, 3, 1, 12, 0, 0, 0, time.UTC),
}
db.db.Set(utils.CacheActions, "actID", Actions{
{
Id: "cgrates.org:id1",
ActionType: "VALID_FUNCTION_TYPE",
ExpirationString: "*yearly",
Balance: &BalanceFilter{
Type: utils.StringPointer("test"),
Value: &utils.ValueFormula{Static: 1.1},
},
Filters: []string{
"fltr",
},
},
}, []string{}, true, utils.NonTransactional)
db.db.Set(utils.CacheActions, "actID2", Actions{
{
Id: "cgrates.org:id1",
ActionType: utils.MetaResetStatQueue,
ExpirationString: "*yearly",
Balance: &BalanceFilter{
Type: utils.StringPointer("test"),
Value: &utils.ValueFormula{Static: 1.1},
},
Filters: []string{
"fltr",
},
},
}, []string{}, true, utils.NonTransactional)
fltrNew := &Filter{
ID: "fltr",
Tenant: "cgrates.org",
Rules: []*FilterRule{
{
Type: utils.MetaString,
Element: "~*req.ID",
Values: []string{"acc_id", "acc1", "acc2"},
},
},
}
SetDataStorage(dm)
fltr := NewFilterS(cfg, nil, dm)
db.db.Set(utils.CacheFilters, utils.ConcatenatedKey("cgrates.org", "fltr"),
fltrNew, []string{}, true, utils.NonTransactional)
if err := at.Execute(ub, fltr); err != nil {
t.Error(err)
}
expLog := ` not available, aborting execution!`
if rcvLog := buf.String(); !strings.Contains(rcvLog, expLog) {
t.Errorf("expected %v,received%v", expLog, rcvLog)
}
removeLogger()
buf2 := new(bytes.Buffer)
setLogger(buf2)
at.ActionsID = "actID2"
expLog = `Error executing action`
if err := at.Execute(ub, fltr); err != nil {
t.Error(err)
} else if rcvLog := buf2.String(); !strings.Contains(rcvLog, expLog) {
t.Errorf("Logger %v doesn't contain %v", rcvLog, expLog)
}
ub.Disabled = true
if err := at.Execute(ub, fltr); err == nil || err.Error() != fmt.Sprintf("User %s is disabled and there are triggers in action!", ub.ID) {
t.Error(err)
}
ub.Disabled = false
at.MinSleep = 10 * time.Minute
at.LastExecutionTime = time.Now().Add(-5 * time.Minute)
if err := at.Execute(ub, fltr); err != nil {
t.Error(err)
}
}
func TestEngineActionTriggerEquals(t *testing.T) {
at1 := &ActionTrigger{
ID: "trigger1",
UniqueID: "unique1",
ThresholdType: "threshold1",
ThresholdValue: 10.0,
Recurrent: true,
MinSleep: time.Minute,
ExpirationDate: time.Now().AddDate(0, 0, 1),
ActivationDate: time.Now(),
Weight: 1.0,
ActionsID: "action1",
MinQueuedItems: 5,
Executed: false,
LastExecutionTime: time.Now(),
}
at2 := &ActionTrigger{
ID: "trigger1",
UniqueID: "unique1",
ThresholdType: "threshold1",
ThresholdValue: 10.0,
Recurrent: true,
MinSleep: time.Minute,
ExpirationDate: time.Now().AddDate(0, 0, 1),
ActivationDate: time.Now(),
Weight: 1.0,
ActionsID: "action1",
MinQueuedItems: 5,
Executed: false,
LastExecutionTime: time.Now(),
}
at3 := &ActionTrigger{
ID: "trigger2",
UniqueID: "unique2",
ThresholdType: "threshold2",
ThresholdValue: 20.0,
Recurrent: false,
MinSleep: time.Minute,
ExpirationDate: time.Now().AddDate(0, 0, 1),
ActivationDate: time.Now(),
Weight: 2.0,
ActionsID: "action2",
MinQueuedItems: 10,
Executed: false,
LastExecutionTime: time.Now(),
}
if !at1.Equals(at2) {
t.Errorf("Expected %v to equal %v, but it didn't.", at1, at2)
}
if at1.Equals(at3) {
t.Errorf("Expected %v not to equal %v, but it did.", at1, at3)
}
}
func TestStringToJson(t *testing.T) {
at := &ActionTrigger{
ID: "321",
UniqueID: "122",
ThresholdType: "*min_event_counter",
ThresholdValue: 10.0,
Recurrent: true,
MinSleep: 5 * time.Second,
ExpirationDate: time.Now().AddDate(0, 0, 7),
ActivationDate: time.Now(),
Balance: nil,
Weight: 0.5,
ActionsID: "123",
MinQueuedItems: 100,
Executed: false,
LastExecutionTime: time.Now().Add(-time.Hour),
}
result := at.String()
expected, _ := json.Marshal(at)
if result != string(expected) {
t.Errorf("String method returned unexpected result, got: %s, want: %s", result, string(expected))
}
}
func TestUpdateInitialValue(t *testing.T) {
tests := []struct {
name string
as *AccountSummary
old *AccountSummary
expected *AccountSummary
}{
{
name: "old is nil",
as: &AccountSummary{
BalanceSummaries: BalanceSummaries{
{UUID: "1", Initial: 10, Value: 20},
},
},
old: nil,
expected: &AccountSummary{
BalanceSummaries: BalanceSummaries{
{UUID: "1", Initial: 10, Value: 20},
},
},
},
{
name: "update initial values",
as: &AccountSummary{
BalanceSummaries: BalanceSummaries{
{UUID: "1", Initial: 10, Value: 20},
{UUID: "2", Initial: 15, Value: 25},
},
},
old: &AccountSummary{
BalanceSummaries: BalanceSummaries{
{UUID: "1", Initial: 5, Value: 10},
{UUID: "3", Initial: 20, Value: 30},
},
},
expected: &AccountSummary{
BalanceSummaries: BalanceSummaries{
{UUID: "1", Initial: 5, Value: 20},
{UUID: "2", Initial: 15, Value: 25},
{UUID: "3", Initial: 0, Value: 0},
},
},
},
{
name: "no matching UUIDs",
as: &AccountSummary{
BalanceSummaries: BalanceSummaries{
{UUID: "4", Initial: 10, Value: 20},
},
},
old: &AccountSummary{
BalanceSummaries: BalanceSummaries{
{UUID: "5", Initial: 5, Value: 10},
},
},
expected: &AccountSummary{
BalanceSummaries: BalanceSummaries{
{UUID: "4", Initial: 10, Value: 20},
{UUID: "5", Initial: 0, Value: 0},
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tt.as.UpdateInitialValue(tt.old)
if diff := cmp.Diff(tt.as, tt.expected); diff != "" {
t.Errorf("UpdateInitialValue() mismatch (-want +got):\n%s", diff)
}
})
}
}