uppal/cgrates
1
0
Fork 1
mirror of https://github.com/cgrates/cgrates.git synced 2026-02-11 18:16:24 +05:00
Code Issues Packages Projects Releases Wiki Activity
Files
0d38bf85510d9dbce2e787d7a857f536db1c68f9
cgrates/general_tests/tutorial_calls_test.go
ionutboangiu 47af22c724 Update rpcclient library to latest version 
`ClientConnector` is no longer defined within `rpcclient` in its latest
version. It has been changed to be obtained from the `cgrates/birpc`
library instead.

Replaced `net/rpc` with `cgrates/birpc` and `net/rpc/jsonrpc` with
`cgrates/birpc/jsonrpc` libraries.

The implementations of `CallBiRPC()` and `Handlers()` were removed,
along with the methods associated with them.

The `rpcclient.BIRPCConector` and the methods prefixed with `BiRPC` were
removed from the `BiRPClient` interface.

The `BiRPClient` interface was renamed to `BIRPCClient`, although not
sure if needed (seems useful just to test if the structure is correct).

`rpcclient.BiRPCConector` has been replaced with `context.ClientConnector`,
which is now passed alongside `context.Context` within the same struct
(`cgrates/birpc/context.Context`). Consequently, functions that were
previously relying on it are now receiving the context instead. The
changes were made in the following functions:

    - `engine/connmanager.go` - `*ConnManager.Call`
    - `engine/connmanager.go` - `*ConnManager.getConn`
    - `engine/connmanager.go` - `*ConnManager.getConnWithConfig`
    - `engine/libengine.go` - `NewRPCPool`
    - `engine/libengine.go` - `NewRPCConnection`
    - `agents/libagents.go` - `processRequest`

Compilation errors related to the `rpcclient.NewRPCClient` function were
resolved by adding the missing `context`, `max_reconnect_interval`, and
`delayFunc` parameters. Additionally, context was added to all calls made
by the client. An effort was made to avoid passing hardcoded values as
much as possible, and extra flags were added where necessary for cgr
binaries.

The `max_reconnect_interval` parameter is now passed from parent
functions, which required adjustments to the function signature.

A new context field was added to all agent objects to ensure access to
it before sending it to the `connmanager's Call`, effectively replacing
`birpcclient`. Although an alternative would have been to create the
new service and add it to the context right before passing it to the
handlers, the chosen approach is definitely more comfortable.

With the addition of a context field for the SIP servers agents, an
additional error needed to be handled, coming from the creation of the
service. Agent constructors within the services package log errors as
they occur and return. Alternate solutions considered were either
shutting down the engine instead of returning, or just logging the
occurrence as a warning, particularly when the `ctx.Client` isn't
required, especially in cases where bidirectional connections are not
needed. For the latter option, it's crucial to return the object with
the error rather than nil or to make the error nil immediately after
logging.

Context has been integrated into all internal Call implementations to
ensure the objects conform to the `birpc.ClientConnector` interface.
These implementations will be removed in the near future as all service
objects are being wrapped in a `birpc.Service` type that satisfies the
`birpc.ClientConnector` interface. Currently, they are being retained
as a reference in case of any unexpected issues that arise.

Ensured that the `birpc.Service` wrapped service objects are passed to
the internal channel getters rather than the objects themselves.

Add context.TODO() to all \*ConnManager.Call function calls. To be
replaced with the context passed to the Method, when available.

For all `*ConnManager.Call` function calls, `context.TODO()` has been
added. This will be replaced with the context passed to the method when
it becomes available.

The value returned by StringGetOpts is now passed directly to the
FirstNonEmpty function, instead of being assigned to a variable
first.

The implementation of the `*AnalyzerService.GetInternalBiRPCCodec`
function has been removed from the services package. Additionally,
the AnalyzerBiRPCConnector type definition and its associated methods
have been removed.

The codec implementation has been revised to include the following
changes:

    - `rpc.ServerCodec` -> `birpc.ServerCodec`;
    - `rpc2.ServerCodec` -> `birpc.BirpcCodec`;
    - `rpc2.Request` -> `birpc.Request`;
    - `rpc2.Response` -> `birpc.Response`;
    - The constructors for json and gob birpc codecs in `cenkalti/rpc`
    have been replaced with ones from the `birpc/jsonrpc` library;
    - The gob codec implementation has been removed in favor of the
    version already implemented in the birpc external library.

The server implementation has been updated with the following changes:

    - A field that represents a simple RPC server has been added to the
    Server struct;
    - Both the simple and bidirectional RPC servers are now initialized
    inside the Server constructor, eliminating the need for nil checks;
    - Usage of `net/rpc` and `cenkalti/rpc2` has been replaced with
    `cgrates/birpc`;
    - Additional `(Bi)RPCUnregisterName` methods have been added;
    - The implementations for (bi)json/gob servers have been somewhat
    simplified.

Before deleting the Call functions and using the `birpc.NewService`
method to register the methods for all cgrates components, update the
Call functions to satisfy the `birpc.ClientConnector` interface. This
way it will be a bit safer. Had to be done for SessionS though.

The `BiRPCCall` method has been removed from coreutils.go. The
`RPCCall` and `APIerRPCCall` methods are also to be removed in the
future.

Ensured that all methods for `SessionSv1` and `SessionS` have the
correct function signature with context. The same adjustments were made
for the session dispatcher methods and for the `SessionSv1Interface`.
Also removed sessionsbirpc.go and smgbirpc.go files.

Implemented the following methods to help with the registration of
methods across all subsystems:

    - `NewServiceWithName`;
    - `NewDispatcherService` for all dispatcher methods;
    - `NewService` for the remaining methods that are already named
    correctly.

Compared to the constructor from the external library, these also make
sure that the naming of the methods is consistent with our constants.

Added context to the Call methods for the mock client connectors (used
in tests).

Removed unused rpc fields from inside the following services:

    - EeS
    - LoaderS
    - ResourceS
    - RouteS
    - StatS
    - ThresholdS
    - SessionS
    - CoreS

Updated the methods implementing the logic for API methods to align
with the latest changes, ensuring consistency and correctness. The
modifications include:

    - Adjusting the function signature to the new format
    (ctx, args, reply).
    - Prefixing names with 'V*' to indicate that they are utilized by
    or registered as APIs.
    - Containing the complete logic within the methods, enabling APIs
    to call them and return their reply directly.

The subsystems affected by these changes are detailed as follows:

    - CoreS: Additional methods were implementing utilizing the
    existing ones. Though modifying them directly was possible, certain
    methods (e.g., StopCPUProfiling()) were used elsewhere and not as
    RPC requests.
    - CDRs: Renamed V1CountCDRs to V1GetCDRsCount.
    - StatS: V1GetQueueFloatMetrics, V1GetQueueStringMetrics,
    V1GetStatQueue accept different arguments compared to API functions
    (opted to register StatSv1 instead).
    - ResourceS: Renamed V1ResourcesForEvent to V1GetResourcesForEvent
    to align with API naming.
    - DispatcherS: Renamed V1GetProfilesForEvent to
    DispatcherSv1GetProfilesForEvent.
    - For the rest, adding context to the function signature was enough.

In the unit tests, wrapping the object within a biprc.Service is now
ensured before passing it to the internal connections map under the
corresponding key.

Some tests that are covering error cases, are also checking the other
return value besides the error. That check has been removed since it
is redundant.

Revised the RPC/BiRPC clients' constructors (for use in tests)

A different approach has been chosen for the handling of ping methods
within subsystems. Instead of defining the same structure in every file,
the ping methods were added inside the Service constructor function.
Though the existing Ping methods were left as they were, they will be
removed in the future.

An additional method has been implemented to register the Ping method
from outside of the engine package.

Implemented Sleep and CapsError methods for SessionS (before they were
exclusively for bidirectional use, I believe).

A specific issue has been fixed within the CapsError SessionSv1 API
implementation, which is designed to overwrite methods that cannot be
allocated due to the threshold limit being reached. Previously, it was
deallocating when writing the response, even when a spot hadn't been
allocated in the first place (due to the cap being hit). The reason
behind this, especially why the test was passing before, still needs
to be looked into, as the problem should have occurred from before.

Implement `*SessionSv1.RegisterInternalBiJSONConn` method in apier.

All agent methods have been registered under the SessionSv1 name. For
the correct method names, the leading "V1" prefix has been trimmed
using the `birpc.NewServiceWithMethodsRename` function.

Revise the RegisterRpcParams function to populate the parameters
while relying on the `*birpc.Service` type instead. This will
automatically also deal with the validation. At the moment,
any error encountered is logged without being returned. Might
be changed in the future.

Inside the cgrRPCAction function, `mapstructure.Decode`'s output parameter
is now guaranteed to always be a pointer.

Updated go.mod and go.sum.

Fixed some typos.
2023-09-01 11:23:54 +02:00

857 lines
29 KiB
Go
Raw Blame History

//go:build call
// +build call
/*
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 (
"flag"
"os"
"path"
"reflect"
"sort"
"strings"
"testing"
"time"
"github.com/cgrates/birpc"
"github.com/cgrates/birpc/context"
"github.com/cgrates/birpc/jsonrpc"
"github.com/cgrates/cgrates/config"
"github.com/cgrates/cgrates/engine"
"github.com/cgrates/cgrates/sessions"
"github.com/cgrates/cgrates/utils"
)
var tutorialCallsCfg *config.CGRConfig
var tutorialCallsRpc *birpc.Client
var tutorialCallsPjSuaListener *os.File
var fsConfig = flag.String("fsConfig", "/usr/share/cgrates/tutorial_tests/fs_evsock", "FreeSwitch tutorial folder")
var kamConfig = flag.String("kamConfig", "/usr/share/cgrates/tutorial_tests/kamevapi", "Kamailio tutorial folder")
var oSipsConfig = flag.String("osConfig", "/usr/share/cgrates/tutorial_tests/osips", "OpenSips tutorial folder")
var ariConf = flag.String("ariConf", "/usr/share/cgrates/tutorial_tests/asterisk_ari", "Asterisk tutorial folder")
var optConf string
var sTestsCalls = []func(t *testing.T){
testCallInitCfg,
testCallResetDataDb,
testCallResetStorDb,
testCallStartFS,
testCallStartEngine,
testCallRestartFS,
testCallRpcConn,
testCallLoadTariffPlanFromFolder,
testCallAccountsBefore,
testCallStatMetricsBefore,
testCallCheckResourceBeforeAllocation,
testCallCheckThreshold1001Before,
testCallCheckThreshold1002Before,
testCallStartPjsuaListener,
testCallCall1001To1002,
testCallGetActiveSessions,
testCallCall1002To1001,
testCallCall1001To1003,
testCallCall1003To1001,
testCallCall1003To1001SecondTime,
testCallCheckResourceAllocation,
testCallAccount1001,
testCall1001Cdrs,
testCall1002Cdrs,
testCall1003Cdrs,
testCallStatMetrics,
testCallCheckResourceRelease,
testCallCheckThreshold1001After,
testCallCheckThreshold1002After,
testCallSyncSessions,
testCallStopPjsuaListener,
testCallStopCgrEngine,
testCallStopFS,
}
// Test start here
func TestFreeswitchCalls(t *testing.T) {
optConf = utils.Freeswitch
for _, stest := range sTestsCalls {
t.Run("", stest)
}
}
func TestKamailioCalls(t *testing.T) {
optConf = utils.Kamailio
for _, stest := range sTestsCalls {
t.Run("", stest)
}
}
func TestOpensipsCalls(t *testing.T) {
optConf = utils.Opensips
for _, stest := range sTestsCalls {
t.Run("", stest)
}
}
func TestAsteriskCalls(t *testing.T) {
optConf = utils.Asterisk
for _, stest := range sTestsCalls {
t.Run("", stest)
}
}
func testCallInitCfg(t *testing.T) {
// Init config first
var err error
switch optConf {
case utils.Freeswitch:
tutorialCallsCfg, err = config.NewCGRConfigFromPath(path.Join(*fsConfig, "cgrates", "etc", "cgrates"))
if err != nil {
t.Error(err)
}
case utils.Kamailio:
tutorialCallsCfg, err = config.NewCGRConfigFromPath(path.Join(*kamConfig, "cgrates", "etc", "cgrates"))
if err != nil {
t.Error(err)
}
case utils.Opensips:
tutorialCallsCfg, err = config.NewCGRConfigFromPath(path.Join(*oSipsConfig, "cgrates", "etc", "cgrates"))
if err != nil {
t.Error(err)
}
case utils.Asterisk:
tutorialCallsCfg, err = config.NewCGRConfigFromPath(path.Join(*ariConf, "cgrates", "etc", "cgrates"))
if err != nil {
t.Error(err)
}
default:
t.Error("Invalid option")
}
tutorialCallsCfg.DataFolderPath = *dataDir // Share DataFolderPath through config towards StoreDb for Flush()
config.SetCgrConfig(tutorialCallsCfg)
}
// Remove data in both rating and accounting db
func testCallResetDataDb(t *testing.T) {
if err := engine.InitDataDb(tutorialCallsCfg); err != nil {
t.Fatal(err)
}
}
// Wipe out the cdr database
func testCallResetStorDb(t *testing.T) {
if err := engine.InitStorDb(tutorialCallsCfg); err != nil {
t.Fatal(err)
}
}
// start FS server
func testCallStartFS(t *testing.T) {
switch optConf {
case utils.Freeswitch:
engine.KillProcName(utils.Freeswitch, 5000)
if err := engine.CallScript(path.Join(*fsConfig, "freeswitch", "etc", "init.d", "freeswitch"), "start", 3000); err != nil {
t.Fatal(err)
}
case utils.Kamailio:
engine.KillProcName(utils.Kamailio, 5000)
if err := engine.CallScript(path.Join(*kamConfig, "kamailio", "etc", "init.d", "kamailio"), "start", 3000); err != nil {
t.Fatal(err)
}
case utils.Opensips:
engine.KillProcName(utils.Kamailio, 5000)
if err := engine.CallScript(path.Join(*oSipsConfig, "opensips", "etc", "init.d", "opensips"), "start", 3000); err != nil {
t.Fatal(err)
}
case utils.Asterisk:
engine.KillProcName(utils.Asterisk, 5000)
if err := engine.CallScript(path.Join(*ariConf, "asterisk", "etc", "init.d", "asterisk"), "start", 3000); err != nil {
t.Fatal(err)
}
default:
t.Error("Invalid option")
}
}
// Start CGR Engine
func testCallStartEngine(t *testing.T) {
engine.KillProcName("cgr-engine", *waitRater)
switch optConf {
case utils.Freeswitch:
if err := engine.CallScript(path.Join(*fsConfig, "cgrates", "etc", "init.d", "cgrates"), "start", 100); err != nil {
t.Fatal(err)
}
case utils.Kamailio:
if err := engine.CallScript(path.Join(*kamConfig, "cgrates", "etc", "init.d", "cgrates"), "start", 100); err != nil {
t.Fatal(err)
}
case utils.Opensips:
if err := engine.CallScript(path.Join(*oSipsConfig, "cgrates", "etc", "init.d", "cgrates"), "start", 100); err != nil {
t.Fatal(err)
}
case utils.Asterisk:
if err := engine.CallScript(path.Join(*ariConf, "cgrates", "etc", "init.d", "cgrates"), "start", 100); err != nil {
t.Fatal(err)
}
default:
t.Error("invalid option")
}
}
// Restart FS so we make sure reconnects are working
func testCallRestartFS(t *testing.T) {
switch optConf {
case utils.Freeswitch:
engine.KillProcName(utils.Freeswitch, 5000)
if err := engine.CallScript(path.Join(*fsConfig, "freeswitch", "etc", "init.d", "freeswitch"), "restart", 3000); err != nil {
t.Fatal(err)
}
case utils.Kamailio:
engine.KillProcName(utils.Kamailio, 5000)
if err := engine.CallScript(path.Join(*kamConfig, "kamailio", "etc", "init.d", "kamailio"), "restart", 3000); err != nil {
t.Fatal(err)
}
case utils.Opensips:
engine.KillProcName(utils.Kamailio, 5000)
if err := engine.CallScript(path.Join(*oSipsConfig, "opensips", "etc", "init.d", "opensips"), "restart", 3000); err != nil {
t.Fatal(err)
}
case utils.Asterisk:
engine.KillProcName(utils.Asterisk, 5000)
if err := engine.CallScript(path.Join(*ariConf, "asterisk", "etc", "init.d", "asterisk"), "restart", 3000); err != nil {
t.Fatal(err)
}
default:
t.Error("Invalid option")
}
}
// Connect rpc client to rater
func testCallRpcConn(t *testing.T) {
var err error
tutorialCallsRpc, err = jsonrpc.Dial(utils.TCP, tutorialCallsCfg.ListenCfg().RPCJSONListen) // We connect over JSON so we can also troubleshoot if needed
if err != nil {
t.Fatal(err)
}
}
// Load the tariff plan, creating accounts and their balances
func testCallLoadTariffPlanFromFolder(t *testing.T) {
var reply string
attrs := &utils.AttrLoadTpFromFolder{FolderPath: path.Join(*dataDir, "tariffplans", "tutorial")}
if err := tutorialCallsRpc.Call(context.Background(), utils.APIerSv1LoadTariffPlanFromFolder, attrs, &reply); err != nil {
t.Error(err)
}
time.Sleep(time.Duration(*waitRater) * time.Millisecond) // Give time for scheduler to execute topups
}
// Make sure account was debited properly
func testCallAccountsBefore(t *testing.T) {
var reply *engine.Account
attrs := &utils.AttrGetAccount{Tenant: "cgrates.org", Account: "1001"}
if err := tutorialCallsRpc.Call(context.Background(), utils.APIerSv2GetAccount, attrs, &reply); err != nil {
t.Error("Got error on APIerSv2.GetAccount: ", err.Error())
} else if reply.BalanceMap[utils.MetaMonetary].GetTotalValue() != 10.0 {
t.Errorf("Calling APIerSv1.GetBalance received: %f", reply.BalanceMap[utils.MetaMonetary].GetTotalValue())
}
var reply2 *engine.Account
attrs2 := &utils.AttrGetAccount{Tenant: "cgrates.org", Account: "1002"}
if err := tutorialCallsRpc.Call(context.Background(), utils.APIerSv2GetAccount, attrs2, &reply2); err != nil {
t.Error("Got error on APIerSv2.GetAccount: ", err.Error())
} else if reply2.BalanceMap[utils.MetaMonetary].GetTotalValue() != 10.0 {
t.Errorf("Calling APIerSv1.GetBalance received: %f", reply2.BalanceMap[utils.MetaMonetary].GetTotalValue())
}
var reply3 *engine.Account
attrs3 := &utils.AttrGetAccount{Tenant: "cgrates.org", Account: "1003"}
if err := tutorialCallsRpc.Call(context.Background(), utils.APIerSv2GetAccount, attrs3, &reply3); err != nil {
t.Error("Got error on APIerSv2.GetAccount: ", err.Error())
} else if reply3.BalanceMap[utils.MetaMonetary].GetTotalValue() != 10.0 {
t.Errorf("Calling APIerSv1.GetBalance received: %f", reply3.BalanceMap[utils.MetaMonetary].GetTotalValue())
}
}
func testCallStatMetricsBefore(t *testing.T) {
var metrics map[string]string
expectedMetrics := map[string]string{
utils.MetaTCC: utils.NotAvailable,
utils.MetaTCD: utils.NotAvailable,
}
if err := tutorialCallsRpc.Call(context.Background(), utils.StatSv1GetQueueStringMetrics,
&utils.TenantID{Tenant: "cgrates.org", ID: "Stats2"}, &metrics); err != nil {
t.Error(err)
} else if !reflect.DeepEqual(expectedMetrics, metrics) {
t.Errorf("expecting: %+v, received reply: %s", expectedMetrics, metrics)
}
if err := tutorialCallsRpc.Call(context.Background(), utils.StatSv1GetQueueStringMetrics,
&utils.TenantID{Tenant: "cgrates.org", ID: "Stats2_1"}, &metrics); err != nil {
t.Error(err)
} else if !reflect.DeepEqual(expectedMetrics, metrics) {
t.Errorf("expecting: %+v, received reply: %s", expectedMetrics, metrics)
}
}
func testCallCheckResourceBeforeAllocation(t *testing.T) {
var rs *engine.Resources
args := &utils.CGREvent{
Tenant: "cgrates.org",
ID: "ResourceEvent",
Event: map[string]any{
utils.AccountField: "1001",
utils.Subject: "1001",
utils.Destination: "1002",
},
APIOpts: map[string]any{
utils.OptsResourcesUsageID: "OriginID",
},
}
if err := tutorialCallsRpc.Call(context.Background(), utils.ResourceSv1GetResourcesForEvent, args, &rs); err != nil {
t.Fatal(err)
} else if len(*rs) != 1 {
t.Fatalf("Resources: %+v", utils.ToJSON(rs))
}
for _, r := range *rs {
if r.ID == "ResGroup1" &&
(len(r.Usages) != 0 || len(r.TTLIdx) != 0) {
t.Errorf("Unexpected resource: %+v", utils.ToJSON(r))
}
}
}
func testCallCheckThreshold1001Before(t *testing.T) {
var td engine.Threshold
eTd := engine.Threshold{Tenant: "cgrates.org", ID: "THD_ACNT_1001", Hits: 0}
if err := tutorialCallsRpc.Call(context.Background(), utils.ThresholdSv1GetThreshold,
&utils.TenantID{Tenant: "cgrates.org", ID: "THD_ACNT_1001"}, &td); err != nil {
t.Error(err)
} else if !reflect.DeepEqual(eTd, td) {
t.Errorf("expecting: %+v, received: %+v", eTd, td)
}
}
func testCallCheckThreshold1002Before(t *testing.T) {
var td engine.Threshold
eTd := engine.Threshold{Tenant: "cgrates.org", ID: "THD_ACNT_1002", Hits: 0}
if err := tutorialCallsRpc.Call(context.Background(), utils.ThresholdSv1GetThreshold,
&utils.TenantID{Tenant: "cgrates.org", ID: "THD_ACNT_1002"}, &td); err != nil {
t.Error(err)
} else if !reflect.DeepEqual(eTd, td) {
t.Errorf("expecting: %+v, received: %+v", eTd, td)
}
}
// Start Pjsua as listener and register it to receive calls
func testCallStartPjsuaListener(t *testing.T) {
var err error
acnts := []*engine.PjsuaAccount{
{Id: "sip:1001@127.0.0.1",
Username: "1001", Password: "CGRateS.org", Realm: "*", Registrar: "sip:127.0.0.1:5080"},
{Id: "sip:1002@127.0.0.1",
Username: "1002", Password: "CGRateS.org", Realm: "*", Registrar: "sip:127.0.0.1:5080"},
{Id: "sip:1003@127.0.0.1",
Username: "1003", Password: "CGRateS.org", Realm: "*", Registrar: "sip:127.0.0.1:5080"},
}
if tutorialCallsPjSuaListener, err = engine.StartPjsuaListener(
acnts, 5070, time.Duration(*waitRater)*time.Millisecond); err != nil {
t.Fatal(err)
}
time.Sleep(3 * time.Second)
}
// Call from 1001 (prepaid) to 1002
func testCallCall1001To1002(t *testing.T) {
if err := engine.PjsuaCallUri(
&engine.PjsuaAccount{Id: "sip:1001@127.0.0.1", Username: "1001", Password: "CGRateS.org", Realm: "*"},
"sip:1002@127.0.0.1", "sip:127.0.0.1:5080", 67*time.Second, 5071); err != nil {
t.Fatal(err)
}
// give time to session to start so we can check it
time.Sleep(time.Second)
}
// GetActiveSessions
func testCallGetActiveSessions(t *testing.T) {
var reply *[]*sessions.ExternalSession
expected := &[]*sessions.ExternalSession{
{
RequestType: "*prepaid",
Tenant: "cgrates.org",
Category: "call",
Account: "1001",
Subject: "1001",
Destination: "1002",
},
}
if err := tutorialCallsRpc.Call(context.Background(), utils.SessionSv1GetActiveSessions,
nil, &reply); err != nil {
t.Error("Got error on SessionSv1.GetActiveSessions: ", err.Error())
} else {
if len(*reply) == 2 {
sort.Slice(*reply, func(i, j int) bool {
return strings.Compare((*reply)[i].RequestType, (*reply)[j].RequestType) > 0
})
}
// compare some fields (eg. CGRId is generated)
if !reflect.DeepEqual((*expected)[0].RequestType, (*reply)[0].RequestType) {
t.Errorf("Expected: %s, received: %s", (*expected)[0].RequestType, (*reply)[0].RequestType)
} else if !reflect.DeepEqual((*expected)[0].Account, (*reply)[0].Account) {
t.Errorf("Expected: %s, received: %s", (*expected)[0].Account, (*reply)[0].Account)
} else if !reflect.DeepEqual((*expected)[0].Destination, (*reply)[0].Destination) {
t.Errorf("Expected: %s, received: %s", (*expected)[0].Destination, (*reply)[0].Destination)
}
}
}
// Call from 1002 (postpaid) to 1001
func testCallCall1002To1001(t *testing.T) {
if err := engine.PjsuaCallUri(
&engine.PjsuaAccount{Id: "sip:1002@127.0.0.1", Username: "1002", Password: "CGRateS.org", Realm: "*"},
"sip:1001@127.0.0.1", "sip:127.0.0.1:5080", 65*time.Second, 5072); err != nil {
t.Fatal(err)
}
}
// Call from 1001 (prepaid) to 1003 limit to 12 seconds
func testCallCall1001To1003(t *testing.T) {
if err := engine.PjsuaCallUri(
&engine.PjsuaAccount{Id: "sip:1001@127.0.0.1", Username: "1001", Password: "CGRateS.org", Realm: "*"},
"sip:1003@127.0.0.1", "sip:127.0.0.1:5080", 60*time.Second, 5073); err != nil {
t.Fatal(err)
}
}
// Call from 1003 (prepaid) to 1001 for 20 seconds
func testCallCall1003To1001(t *testing.T) {
if err := engine.PjsuaCallUri(
&engine.PjsuaAccount{Id: "sip:1003@127.0.0.1", Username: "1003", Password: "CGRateS.org", Realm: "*"},
"sip:1001@127.0.0.1", "sip:127.0.0.1:5080", 20*time.Second, 5074); err != nil {
t.Fatal(err)
}
// after this call from 1001 to 1003 and call from 1003 to 1001 should be done
}
// Call from 1003 (prepaid) to 1001 for 15 seconds
func testCallCall1003To1001SecondTime(t *testing.T) {
time.Sleep(22 * time.Second)
if err := engine.PjsuaCallUri(
&engine.PjsuaAccount{Id: "sip:1003@127.0.0.1", Username: "1003", Password: "CGRateS.org", Realm: "*"},
"sip:1001@127.0.0.1", "sip:127.0.0.1:5080", 15*time.Second, 5075); err != nil {
t.Fatal(err)
}
time.Sleep(time.Second)
}
// Check if the resource was Allocated
func testCallCheckResourceAllocation(t *testing.T) {
var rs *engine.Resources
args := &utils.CGREvent{
Tenant: "cgrates.org",
ID: "ResourceAllocation",
Event: map[string]any{
utils.AccountField: "1001",
utils.Subject: "1001",
utils.Destination: "1002",
},
APIOpts: map[string]any{
utils.OptsResourcesUsageID: "OriginID1",
},
}
if err := tutorialCallsRpc.Call(context.Background(), utils.ResourceSv1GetResourcesForEvent, args, &rs); err != nil {
t.Fatal(err)
} else if len(*rs) != 1 {
t.Fatalf("Resources: %+v", utils.ToJSON(rs))
}
for _, r := range *rs {
if r.ID == "ResGroup1" && len(r.Usages) != 3 {
t.Errorf("Unexpected resource: %+v", utils.ToJSON(r))
}
}
// Allow calls to finish before start querying the results
time.Sleep(50 * time.Second)
}
// Make sure account was debited properly
func testCallAccount1001(t *testing.T) {
var reply *engine.Account
attrs := &utils.AttrGetAccount{Tenant: "cgrates.org", Account: "1001"}
if err := tutorialCallsRpc.Call(context.Background(), utils.APIerSv2GetAccount, attrs, &reply); err != nil {
t.Error(err.Error())
} else if reply.BalanceMap[utils.MetaMonetary].GetTotalValue() == 10.0 { // Make sure we debitted
t.Errorf("Expected: 10, received: %+v", reply.BalanceMap[utils.MetaMonetary].GetTotalValue())
} else if reply.Disabled == true {
t.Error("Account disabled")
}
}
// Make sure account was debited properly
func testCall1001Cdrs(t *testing.T) {
var reply []*engine.ExternalCDR
req := utils.RPCCDRsFilter{RunIDs: []string{utils.MetaDefault}, Accounts: []string{"1001"}}
if err := tutorialCallsRpc.Call(context.Background(), utils.APIerSv2GetCDRs, &req, &reply); err != nil {
t.Error("Unexpected error: ", err.Error())
} else if len(reply) != 2 {
t.Error("Unexpected number of CDRs returned: ", len(reply))
} else {
for _, cdr := range reply {
if cdr.RequestType != utils.MetaPrepaid {
t.Errorf("Unexpected RequestType for CDR: %+v", cdr.RequestType)
}
if cdr.Destination == "1002" {
// in case of Asterisk take the integer part from usage
if optConf == utils.Asterisk {
cdr.Usage = strings.Split(cdr.Usage, ".")[0] + "s"
}
if cdr.Usage != "1m7s" && cdr.Usage != "1m8s" { // Usage as seconds
t.Errorf("Unexpected Usage for CDR: %+v", cdr.Usage)
}
if cdr.CostSource != utils.MetaSessionS {
t.Errorf("Unexpected CostSource for CDR: %+v", cdr.CostSource)
}
} else if cdr.Destination == "1003" {
// in case of Asterisk take the integer part from usage
if optConf == utils.Asterisk {
cdr.Usage = strings.Split(cdr.Usage, ".")[0] + "s"
}
if cdr.Usage != "12s" && cdr.Usage != "13s" { // Usage as seconds
t.Errorf("Unexpected Usage for CDR: %+v", cdr.Usage)
}
if cdr.CostSource != utils.MetaSessionS {
t.Errorf("Unexpected CostSource for CDR: %+v", cdr.CostSource)
}
}
}
}
}
// Make sure account was debited properly
func testCall1002Cdrs(t *testing.T) {
var reply []*engine.ExternalCDR
req := utils.RPCCDRsFilter{RunIDs: []string{utils.MetaDefault},
Accounts: []string{"1002"}, DestinationPrefixes: []string{"1001"}}
if err := tutorialCallsRpc.Call(context.Background(), utils.APIerSv2GetCDRs, &req, &reply); err != nil {
t.Error("Unexpected error: ", err.Error())
} else if len(reply) != 1 {
t.Error("Unexpected number of CDRs returned: ", len(reply))
} else {
if reply[0].RequestType != utils.MetaPostpaid {
t.Errorf("Unexpected RequestType for CDR: %+v", reply[0].RequestType)
}
// in case of Asterisk take the integer part from usage
if optConf == utils.Asterisk {
reply[0].Usage = strings.Split(reply[0].Usage, ".")[0] + "s"
}
if reply[0].Usage != "1m5s" && reply[0].Usage != "1m6s" { // Usage as seconds
t.Errorf("Unexpected Usage for CDR: %+v", reply[0].Usage)
}
if reply[0].CostSource != utils.MetaCDRs {
t.Errorf("Unexpected CostSource for CDR: %+v", reply[0].CostSource)
}
}
}
// Make sure account was debited properly
func testCall1003Cdrs(t *testing.T) {
var reply []*engine.ExternalCDR
req := utils.RPCCDRsFilter{RunIDs: []string{utils.MetaDefault},
Accounts: []string{"1003"}, DestinationPrefixes: []string{"1001"}}
if err := tutorialCallsRpc.Call(context.Background(), utils.APIerSv2GetCDRs, &req, &reply); err != nil {
t.Error("Unexpected error: ", err.Error())
} else if len(reply) != 2 {
t.Error("Unexpected number of CDRs returned: ", len(reply))
} else {
for _, cdr := range reply {
if cdr.RequestType != utils.MetaPrepaid {
t.Errorf("Unexpected RequestType for CDR: %+v", cdr.RequestType)
}
// in case of Asterisk take the integer part from usage
if optConf == utils.Asterisk {
cdr.Usage = strings.Split(cdr.Usage, ".")[0] + "s"
}
if cdr.Usage != "15s" && cdr.Usage != "16s" &&
cdr.Usage != "20s" && cdr.Usage != "21s" { // Usage as seconds
t.Errorf("Unexpected Usage for CDR: %+v", cdr.Usage)
}
if cdr.CostSource != utils.MetaSessionS {
t.Errorf("Unexpected CostSource for CDR: %+v", cdr.CostSource)
}
}
}
}
func testCallStatMetrics(t *testing.T) {
var metrics map[string]string
firstStatMetrics1 := map[string]string{
utils.MetaTCC: "1.35346",
utils.MetaTCD: "2m27s",
}
firstStatMetrics2 := map[string]string{
utils.MetaTCC: "1.35009",
utils.MetaTCD: "2m25s",
}
firstStatMetrics3 := map[string]string{
utils.MetaTCC: "1.34009",
utils.MetaTCD: "2m24s",
}
firstStatMetrics4 := map[string]string{
utils.MetaTCC: "1.35346",
utils.MetaTCD: "2m24s",
}
secondStatMetrics1 := map[string]string{
utils.MetaTCC: "0.6",
utils.MetaTCD: "35s",
}
secondStatMetrics2 := map[string]string{
utils.MetaTCC: "0.6",
utils.MetaTCD: "37s",
}
if err := tutorialCallsRpc.Call(context.Background(), utils.StatSv1GetQueueStringMetrics,
&utils.TenantID{Tenant: "cgrates.org", ID: "Stats2"}, &metrics); err != nil {
t.Fatal(err)
}
if optConf == utils.Asterisk {
metrics[utils.MetaTCD] = strings.Split(metrics[utils.MetaTCD], ".")[0] + "s"
}
if !reflect.DeepEqual(firstStatMetrics1, metrics) &&
!reflect.DeepEqual(firstStatMetrics2, metrics) &&
!reflect.DeepEqual(firstStatMetrics3, metrics) &&
!reflect.DeepEqual(firstStatMetrics4, metrics) {
t.Errorf("expecting: %+v, received reply: %s", firstStatMetrics1, metrics)
}
if err := tutorialCallsRpc.Call(context.Background(), utils.StatSv1GetQueueStringMetrics,
&utils.TenantID{Tenant: "cgrates.org", ID: "Stats2_1"}, &metrics); err != nil {
t.Error(err)
}
if optConf == utils.Asterisk {
metrics[utils.MetaTCD] = strings.Split(metrics[utils.MetaTCD], ".")[0] + "s"
}
if !reflect.DeepEqual(secondStatMetrics1, metrics) &&
!reflect.DeepEqual(secondStatMetrics2, metrics) {
t.Errorf("expecting: %+v, received reply: %s", secondStatMetrics1, metrics)
}
}
func testCallCheckResourceRelease(t *testing.T) {
var rs *engine.Resources
args := &utils.CGREvent{
Tenant: "cgrates.org",
ID: "ResourceRelease",
Event: map[string]any{
utils.AccountField: "1001",
utils.Subject: "1001",
utils.Destination: "1002",
},
APIOpts: map[string]any{
utils.OptsResourcesUsageID: "OriginID2",
},
}
if err := tutorialCallsRpc.Call(context.Background(), utils.ResourceSv1GetResourcesForEvent, args, &rs); err != nil {
t.Fatal(err)
} else if len(*rs) != 1 {
t.Fatalf("Resources: %+v", rs)
}
for _, r := range *rs {
if r.ID == "ResGroup1" && len(r.Usages) != 0 {
t.Errorf("Unexpected resource: %+v", utils.ToJSON(r))
}
}
}
func testCallCheckThreshold1001After(t *testing.T) {
var td engine.Threshold
if err := tutorialCallsRpc.Call(context.Background(), utils.ThresholdSv1GetThreshold,
&utils.TenantID{Tenant: "cgrates.org", ID: "THD_ACNT_1001"}, &td); err != nil &&
err.Error() != utils.ErrNotFound.Error() {
t.Error(err)
}
}
func testCallCheckThreshold1002After(t *testing.T) {
var td engine.Threshold
eTd := engine.Threshold{Tenant: "cgrates.org", ID: "THD_ACNT_1002", Hits: 4}
if err := tutorialCallsRpc.Call(context.Background(), utils.ThresholdSv1GetThreshold,
&utils.TenantID{Tenant: "cgrates.org", ID: "THD_ACNT_1002"}, &td); err != nil {
t.Error(err)
} else if !reflect.DeepEqual(eTd.Tenant, td.Tenant) {
t.Errorf("expecting: %+v, received: %+v", eTd.Tenant, td.Tenant)
} else if !reflect.DeepEqual(eTd.ID, td.ID) {
t.Errorf("expecting: %+v, received: %+v", eTd.ID, td.ID)
} else if !reflect.DeepEqual(eTd.Hits, td.Hits) {
t.Errorf("expecting: %+v, received: %+v", eTd.Hits, td.Hits)
}
}
func testCallSyncSessions(t *testing.T) {
var reply *[]*sessions.ExternalSession
// activeSessions shouldn't be active
if err := tutorialCallsRpc.Call(context.Background(), utils.SessionSv1GetActiveSessions,
nil, &reply); err == nil || err.Error() != utils.ErrNotFound.Error() {
t.Error("Got error on SessionSv1.GetActiveSessions: ", err)
}
// 1001 call 1002 stop the call after 12 seconds
if err := engine.PjsuaCallUri(
&engine.PjsuaAccount{Id: "sip:1001@127.0.0.1", Username: "1001", Password: "CGRateS.org", Realm: "*"},
"sip:1002@127.0.0.1", "sip:127.0.0.1:5080", 120*time.Second, 5076); err != nil {
t.Fatal(err)
}
// 1001 call 1003 stop the call after 11 seconds
if err := engine.PjsuaCallUri(
&engine.PjsuaAccount{Id: "sip:1001@127.0.0.1", Username: "1001", Password: "CGRateS.org", Realm: "*"},
"sip:1003@127.0.0.1", "sip:127.0.0.1:5080", 120*time.Second, 5077); err != nil {
t.Fatal(err)
}
time.Sleep(time.Second)
// get active sessions
if err := tutorialCallsRpc.Call(context.Background(), utils.SessionSv1GetActiveSessions,
nil, &reply); err != nil {
t.Error("Got error on SessionSv1.GetActiveSessions: ", err.Error())
} else if len(*reply) != 4 { // expect to have 4 sessions ( two for 1001 to 1003 *raw and *default and two from 1001 to 1002 *raw and *default)
t.Errorf("expecting 4 active sessions, received: %+v", utils.ToJSON(reply))
}
//check if resource was allocated for 2 calls(1001->1002;1001->1003)
var rs *engine.Resources
args := &utils.CGREvent{
Tenant: "cgrates.org",
ID: "AllocateResource",
Event: map[string]any{
utils.AccountField: "1001",
utils.Subject: "1001",
utils.Destination: "1002",
},
APIOpts: map[string]any{
utils.OptsResourcesUsageID: "OriginID3",
},
}
if err := tutorialCallsRpc.Call(context.Background(), utils.ResourceSv1GetResourcesForEvent, args, &rs); err != nil {
t.Fatal(err)
} else if len(*rs) != 1 {
t.Fatalf("Resources: %+v", utils.ToJSON(rs))
}
for _, r := range *rs {
if r.ID == "ResGroup1" && len(r.Usages) != 2 {
t.Errorf("Unexpected resource: %+v", utils.ToJSON(r))
}
}
time.Sleep(3 * time.Second)
//stop the FS
switch optConf {
case utils.Freeswitch:
engine.ForceKillProcName(utils.Freeswitch,
int(tutorialCallsCfg.SessionSCfg().ChannelSyncInterval.Nanoseconds()/1e6))
case utils.Kamailio:
engine.ForceKillProcName(utils.Kamailio,
int(tutorialCallsCfg.SessionSCfg().ChannelSyncInterval.Nanoseconds()/1e6))
case utils.Opensips:
engine.ForceKillProcName(utils.Opensips,
int(tutorialCallsCfg.SessionSCfg().ChannelSyncInterval.Nanoseconds()/1e6))
case utils.Asterisk:
engine.ForceKillProcName(utils.Asterisk,
int(tutorialCallsCfg.SessionSCfg().ChannelSyncInterval.Nanoseconds()/1e6))
default:
t.Errorf("unsupported format")
}
time.Sleep(2 * time.Second)
// activeSessions shouldn't be active
if err := tutorialCallsRpc.Call(context.Background(), utils.SessionSv1GetActiveSessions,
nil, &reply); err == nil || err.Error() != utils.ErrNotFound.Error() {
t.Errorf("Got error on SessionSv1.GetActiveSessions: %v and reply: %s", err, utils.ToJSON(reply))
}
var sourceForCDR string
numberOfCDR := 3
switch optConf {
case utils.Freeswitch:
sourceForCDR = "FS_CHANNEL_ANSWER"
case utils.Kamailio:
sourceForCDR = utils.KamailioAgent
case utils.Asterisk:
sourceForCDR = utils.AsteriskAgent
case utils.Opensips:
sourceForCDR = utils.Opensips
}
// verify cdr
var rplCdrs []*engine.ExternalCDR
req := utils.RPCCDRsFilter{
Sources: []string{sourceForCDR},
MaxUsage: "20s",
RunIDs: []string{utils.MetaDefault},
Accounts: []string{"1001"},
}
if err := tutorialCallsRpc.Call(context.Background(), utils.APIerSv2GetCDRs, &req, &rplCdrs); err != nil {
t.Error("Unexpected error: ", err.Error())
} else if len(rplCdrs) != numberOfCDR { // cdr from sync session + cdr from before
t.Fatal("Unexpected number of CDRs returned: ", len(rplCdrs), utils.ToJSON(rplCdrs))
} else if time1, err := utils.ParseDurationWithSecs(rplCdrs[0].Usage); err != nil {
t.Error(err)
} else if time1 > 15*time.Second {
t.Error("Unexpected time duration : ", time1)
} else if time1, err := utils.ParseDurationWithSecs(rplCdrs[1].Usage); err != nil {
t.Error(err)
} else if time1 > 15*time.Second {
t.Error("Unexpected time duration : ", time1)
} else if numberOfCDR == 3 {
if time1, err := utils.ParseDurationWithSecs(rplCdrs[2].Usage); err != nil {
t.Error(err)
} else if time1 > 15*time.Second {
t.Error("Unexpected time duration : ", time1)
}
}
//check if resource was released
var rsAfter *engine.Resources
if err := tutorialCallsRpc.Call(context.Background(), utils.ResourceSv1GetResourcesForEvent, args, &rsAfter); err != nil {
t.Fatal(err)
} else if len(*rsAfter) != 1 {
t.Fatalf("Resources: %+v", rsAfter)
}
for _, r := range *rsAfter {
if r.ID == "ResGroup1" && len(r.Usages) != 0 {
t.Errorf("Unexpected resource: %+v", utils.ToJSON(r))
}
}
}
func testCallStopPjsuaListener(t *testing.T) {
tutorialCallsPjSuaListener.Write([]byte("q\n")) // Close pjsua
time.Sleep(time.Second) // Allow pjsua to finish it's tasks, eg un-REGISTER
}
func testCallStopCgrEngine(t *testing.T) {
if err := engine.KillEngine(100); err != nil {
t.Error(err)
}
}
func testCallStopFS(t *testing.T) {
switch optConf {
case utils.Freeswitch:
engine.ForceKillProcName(utils.Freeswitch, 1000)
case utils.Kamailio:
engine.ForceKillProcName(utils.Kamailio, 1000)
case utils.Opensips:
engine.ForceKillProcName(utils.Opensips, 1000)
case utils.Asterisk:
engine.ForceKillProcName(utils.Asterisk, 1000)
default:
t.Errorf("unsupported format")
}
}
Reference in New Issue View Git Blame Copy Permalink