cgrates/ees/em_it_test.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 ees

import (
	"bytes"
	"fmt"
	"os"
	"path/filepath"
	"testing"
	"time"

	"github.com/cgrates/birpc"
	"github.com/cgrates/birpc/context"
	"github.com/cgrates/cgrates/utils"

	"github.com/cgrates/cgrates/engine"
)

func TestExporterMetricsIT(t *testing.T) {
	t.Skip("takes too long - better to analyze manually")
	switch *utils.DBType {
	case utils.MetaInternal:
	case utils.MetaMySQL, utils.MetaMongo, utils.MetaPostgres:
		t.SkipNow()
	default:
		t.Fatal("unsupported dbtype value")
	}

	exportPath := t.TempDir()
	jsonCfg := fmt.Sprintf(`{
"ees": {
"enabled": true,
"cache": {
  "*file_csv": { "limit": -1, "ttl": "2s", "static_ttl": false }
},
"exporters": [
  {
	"id": "csv_exporter",
	"type": "*file_csv",
	"export_path": "%s",
	"synchronous": true,
	"metrics_reset_schedule": "@every 5s",
	"fields": [
	  { "tag": "Number", "path": "*exp.Number", "type": "*variable", "value": "~*em.NumberOfEvents" },
	  { "tag": "CGRID", "path": "*exp.CGRID", "type": "*variable", "value": "~*req.CGRID" },
	  { "tag": "ToR", "path": "*exp.ToR", "type": "*constant", "value": "*sms" },
	  { "tag": "Account", "path": "*exp.Account", "type": "*variable", "value": "~*req.Account" },
	  { "tag": "Destination", "path": "*exp.Destination", "type": "*variable", "value": "~*req.Destination" },
	  { "tag": "AnswerTime", "path": "*exp.AnswerTime", "type": "*variable", "value": "*now", },
	  { "tag": "Usage", "path": "*exp.Usage", "type": "*variable", "value": "~*req.Usage" },
	  { "tag": "Cost", "path": "*exp.Cost", "type": "*variable", "value": "~*req.Cost{*round:4}" },

	  { "tag": "NumberOfEvents", "path": "*trl.NumberOfEvents", "type": "*variable", "value": "~*em.NumberOfEvents" },
	  { "tag": "TotalDuration", "path": "*trl.TotalDuration", "type": "*variable", "value": "~*em.TotalDuration" },
	  { "tag": "TotalSMSUsage", "path": "*trl.TotalSMSUsage", "type": "*variable", "value": "~*em.TotalSMSUsage" },
	  { "tag": "TotalCost", "path": "*trl.TotalCost", "type": "*variable", "value": "~*em.TotalCost{*round:4}" }
	]
  }
]
}
}`, exportPath)

	ng := engine.TestEngine{
		ConfigJSON: jsonCfg,
		DBCfg:      engine.InternalDBCfg,
		LogBuffer:  &bytes.Buffer{},
	}
	defer fmt.Println(ng.LogBuffer)
	client, _ := ng.Run(t)

	for i := range 7 {
		exportCsvEvent(t, client, i)
		time.Sleep(time.Second)
		if i == 3 {
			resetExporterMetrics(t, client, true)
		}
	}
	time.Sleep(2 * time.Second)
	checkExportedFile(t, exportPath)

	for i := range 7 {
		exportCsvEvent(t, client, i)
		time.Sleep(time.Second)
		if i == 3 {
			resetExporterMetrics(t, client, false)
		}
	}
	time.Sleep(2 * time.Second)
	checkExportedFile(t, exportPath)
}

func exportCsvEvent(t *testing.T, client *birpc.Client, i int) {
	t.Helper()
	var reply map[string]map[string]any
	if err := client.Call(context.Background(), utils.EeSv1ProcessEvent,
		&engine.CGREventWithEeIDs{
			CGREvent: &utils.CGREvent{
				Tenant: "cgrates.org",
				Event: map[string]any{
					utils.CGRID:        fmt.Sprintf("cgr%d", i),
					utils.AccountField: "1001",
					utils.Destination:  "1002",
					utils.Usage:        time.Duration(i) * time.Second,
					utils.Cost:         i,
				},
				APIOpts: map[string]any{
					utils.OptsEEsVerbose: true,
				},
			},
		}, &reply); err != nil {
		t.Fatal(err)
	}
	fmt.Println(utils.ToJSON(reply))
}

func checkExportedFile(t *testing.T, path string) {
	t.Helper()
	files, err := os.ReadDir(path)
	if err != nil {
		t.Fatal(err)
	}
	for _, file := range files {
		fmt.Printf("file %s\n==========\n", file.Name())
		b, err := os.ReadFile(filepath.Join(path, file.Name()))
		if err != nil {
			t.Fatal(err)
		}
		fmt.Println(string(b))
	}
}

func resetExporterMetrics(t *testing.T, client *birpc.Client, verbose bool) {
	t.Helper()
	args := V1ResetExporterMetricsParams{
		ExporterID: "csv_exporter",
	}
	if verbose {
		args.APIOpts = map[string]any{
			utils.OptsEEsVerbose: true,
		}
	}
	var reply string
	if err := client.Call(context.Background(), utils.EeSv1ResetExporterMetrics,
		args, &reply); err != nil {
		t.Fatal(err)
	}
}