Merge pull request #13 from sipcapture/feature/sipstress-style-summary

Feature/sipstress style summary

Author: adubovikov

README.md

@@ -25,9 +25,10 @@ The current MVP implements:
 - TLS transports `l1` and `ln` (UAC or UAS; same codes as for TCP, plus TLS files as needed)
 - Global and per-user variable scopes
 - SIPp-style auth credentials via `-au` / `-ap` for challenged `401` / `407` request retries, inline `[authentication username=... password=...]`, and server-side `verifyauth`
+- Optional SIP identity for built-in UAC / `invite_media`: `-sip_from` (From before `;tag=`), `-sip_pai`, `-sip_provider`, repeatable `-sip_extra_header` (see `docs/compatibility.md` `[trunk_*]` keywords)
 - Concurrent call generation with rate limiting
 - Interactive terminal UI via `gossipper tui` / `gossipper -interactive` for launch presets and live runtime control
-- Basic statistics and JSON summary export
+- Basic statistics and JSON summary export (`-summary_json`), optional standalone **HTML** report (`-summary_html` or `gossipper report-html -in … -out …`; see `docs/summary-json.md`)
 - Named per-step RTD timers via `start_rtd` / `rtd`, aggregated into summary JSON
 - XML `counter` / `display` attributes aggregated into summary JSON as execution counts
 - Exported stats now include failure-class counters such as `timeout`, `unexpected_sip`, `transport_error`, `parse_error`, `scenario_error`, and `cancelled`

cmd/gossip/main.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"flag"
 	"fmt"
@@ -11,18 +12,25 @@ import (
 	"os/signal"
 	"runtime"
 	"runtime/pprof"
+	"strings"
 	"syscall"
 
 	"github.com/sipcapture/gossipper/internal/cli"
 	"github.com/sipcapture/gossipper/internal/launcher"
 	"github.com/sipcapture/gossipper/internal/pcap2scenario"
+	"github.com/sipcapture/gossipper/internal/reporthtml"
 	"github.com/sipcapture/gossipper/internal/shell"
+	"github.com/sipcapture/gossipper/internal/stats"
 	templ "github.com/sipcapture/gossipper/internal/template"
 	"github.com/sipcapture/gossipper/internal/tui"
 )
 
 func main() {
 	if err := run(os.Args[1:]); err != nil {
+		if errors.Is(err, launcher.ErrHealthCheckFailed) {
+			fmt.Fprintln(os.Stderr, err)
+			os.Exit(2)
+		}
 		fmt.Fprintln(os.Stderr, err)
 		os.Exit(1)
 	}
@@ -39,6 +47,9 @@ func run(args []string) error {
 	if len(args) > 0 && args[0] == "pcap2scenario" {
 		return runPCAP2Scenario(args[1:])
 	}
+	if len(args) > 0 && args[0] == "report-html" {
+		return runReportHTML(args[1:])
+	}
 	if len(args) > 0 && (args[0] == "shell" || args[0] == "cli") {
 		return shell.Run(os.Stdin, os.Stdout, os.Stderr)
 	}
@@ -53,6 +64,8 @@ func run(args []string) error {
 		}
 		return err
 	}
+	cfg.ToolVersion = GetShortVersionString()
+
 	if cfg.InfIndexFile != "" {
 		indexPath, entries, err := templ.GenerateCSVIndex("", cfg.InfIndexFile, cfg.InfIndexField)
 		if err != nil {
@@ -167,3 +180,32 @@ func runPCAP2Scenario(args []string) error {
 
 	return pcap2scenario.Run(fs.Arg(0), *outDir, *sipPort, *pcapLink)
 }
+
+func runReportHTML(args []string) error {
+	fs := flag.NewFlagSet("report-html", flag.ContinueOnError)
+	inPath := fs.String("in", "", "input summary JSON (from gossipper -summary_json)")
+	outPath := fs.String("out", "", "output HTML file path")
+	fs.Usage = func() {
+		fmt.Fprintf(fs.Output(), "usage: gossipper report-html -in summary.json -out report.html\n")
+		fs.PrintDefaults()
+	}
+	if err := fs.Parse(args); err != nil {
+		return err
+	}
+	if strings.TrimSpace(*inPath) == "" || strings.TrimSpace(*outPath) == "" {
+		fs.Usage()
+		return fmt.Errorf("report-html: -in and -out are required")
+	}
+	raw, err := os.ReadFile(*inPath)
+	if err != nil {
+		return fmt.Errorf("report-html: read -in: %w", err)
+	}
+	var s stats.Summary
+	if err := json.Unmarshal(raw, &s); err != nil {
+		return fmt.Errorf("report-html: parse JSON: %w", err)
+	}
+	if err := reporthtml.WriteFile(strings.TrimSpace(*outPath), s); err != nil {
+		return fmt.Errorf("report-html: write -out: %w", err)
+	}
+	return nil
+}

docs/compatibility.md

@@ -117,6 +117,10 @@ into no-ops or empty strings.
 | `[$n]` / `[$name]` | supported | Action and string variables |
 | `[dynamic_id]` | supported | Atomic per-message counter with `INT32` wraparound to mirror SIPp; supports `+/-offset` |
 | `[routes]` | supported | When a `recv` command uses `rrs="true"`, captured `Record-Route` headers are replayed as `Route` headers (reverse order) in subsequent rendered messages |
+| `[trunk_from]` | supported | Built-in UAC / `invite_media`: value before `;tag=` in `From`; default `gossip <sip:gossip@local_bind:port>`; CLI `-sip_from` |
+| `[trunk_pai]` | supported | Optional full header line `P-Asserted-Identity: …` plus CRLF; empty when `-sip_pai` unset |
+| `[trunk_provider]` | supported | Optional `X-provider: …` plus CRLF; empty when `-sip_provider` unset |
+| `[trunk_extra]` | supported | Optional extra headers after `Via` (each line ends with CRLF); repeatable CLI `-sip_extra_header` |
 | `[clock_tick]` | supported | Milliseconds elapsed since engine start; supports `+/-offset` |
 | `[sipp_version]` | supported | Renders runtime version string (defaults to `Gossipper` when not explicitly provided) |
 | `[tdmmap]` | partial | Stub: renders `0.0.0/0`; `-tdmmap` CLI flag is not parsed and per-call slot allocation is deferred |

docs/summary-json.md

@@ -0,0 +1,34 @@
+# Summary JSON (`-summary_json`)
+
+## Schema version
+
+The `schema_version` field is set to `gossipper_summary_v1` when writing the file via `-summary_json`. Consumers should treat unknown schema versions as incompatible.
+
+## Tool version
+
+`tool_version` is populated from the running binary (same string as `gossipper -version` short line).
+
+## Media QoS (RTCP)
+
+When RTCP Receiver Reports are received during RTP sessions, the summary may include:
+
+- `media.rtcp_reception_reports` — count of RFC 3550 reception report blocks.
+- `media.rtcp_max_fraction_lost` — maximum observed loss fraction in `0..1`.
+- `media.rtcp_max_jitter_ts` / `media.rtcp_avg_jitter_ts` — jitter in RTP timestamp units (not milliseconds).
+
+## Health checks (CI)
+
+Optional flags (evaluated when **`-summary_json`**, **`-summary_html`**, or any health threshold is set — the run finalizes a summary in that case):
+
+- `-health_min_success_ratio` — fail if `success_ratio` is below this value (e.g. `0.99`).
+- `-health_max_failed_calls` — fail if `failed_calls` exceed this value; `0` means any failure fails the run. Default `-1` disables.
+- `-health_max_timeouts` — fail if `timeouts` exceed this value. Default `-1` disables.
+
+On failure the process exits with code **2** (other errors use **1**). The JSON file still contains `health` and `findings` with failure reasons.
+
+## HTML report
+
+- **`-summary_html PATH`**: after a SIP run, writes the same finalized summary as a **standalone** UTF-8 HTML file (no CDN, works offline). Can be used **without** `-summary_json`.
+- **`gossipper report-html -in summary.json -out report.html`**: rebuild HTML from an existing summary JSON file.
+
+See implementation in `internal/reporthtml`.

internal/cli/config.go

@@ -28,34 +28,40 @@ const (
 )
 
 type Config struct {
-	ScenarioFile            string
-	ScenarioName            string
-	Service                 string
-	Transport               string
-	LocalIP                 string
-	LocalPort               int
-	RemoteHost              string
-	RemotePort              int
-	AuthUsername            string
-	AuthPassword            string
-	Rate                    float64
-	RateScale               float64
-	RateIncrease            float64
-	RateIncreaseStep        time.Duration
-	RateMax                 float64
-	MaxReconnect            int
-	ReconnectSleep          time.Duration
-	ReconnectClose          bool
-	BaseCSeq                int
-	TotalCalls              int
-	MaxConcurrent           int
-	MaxSockets              int
-	Users                   int
-	DefaultPause            time.Duration
-	DefaultRecvTO           time.Duration
-	RecvBYEFloorTO          time.Duration // minimum mandatory recv BYE when scenario timeout omitted; 0=off
-	GlobalTimeout           time.Duration
-	SummaryJSON             string
+	ScenarioFile     string
+	ScenarioName     string
+	Service          string
+	Transport        string
+	LocalIP          string
+	LocalPort        int
+	RemoteHost       string
+	RemotePort       int
+	AuthUsername     string
+	AuthPassword     string
+	Rate             float64
+	RateScale        float64
+	RateIncrease     float64
+	RateIncreaseStep time.Duration
+	RateMax          float64
+	MaxReconnect     int
+	ReconnectSleep   time.Duration
+	ReconnectClose   bool
+	BaseCSeq         int
+	TotalCalls       int
+	MaxConcurrent    int
+	MaxSockets       int
+	Users            int
+	DefaultPause     time.Duration
+	DefaultRecvTO    time.Duration
+	RecvBYEFloorTO   time.Duration // minimum mandatory recv BYE when scenario timeout omitted; 0=off
+	GlobalTimeout    time.Duration
+	SummaryJSON      string
+	SummaryHTML      string
+	// ToolVersion is set by the main package (not a CLI flag) for JSON export.
+	ToolVersion             string
+	HealthMinSuccessRatio   float64
+	HealthMaxFailedCalls    int
+	HealthMaxTimeouts       int
 	TraceMessages           bool
 	TraceShortMsg           bool
 	TraceCounts             bool
@@ -119,33 +125,41 @@ type Config struct {
 
 	// PCAPLinkLayer selects PCAP datalink decoding for play_pcap_* (-pcap-link).
 	PCAPLinkLayer string
+
+	// SipFrom / SipPAI / SipProvider / SipExtraHeaders drive [trunk_*] keywords in built-in scenarios (see docs/compatibility.md).
+	SipFrom         string
+	SipPAI          string
+	SipProvider     string
+	SipExtraHeaders []string
 }
 
 func DefaultConfig() Config {
 	return Config{
-		ScenarioName:     "uac",
-		Service:          "service",
-		Transport:        DefaultTransport,
-		LocalIP:          "0.0.0.0",
-		AuthPassword:     "password",
-		Rate:             DefaultRate,
-		RateScale:        1.0,
-		BaseCSeq:         1,
-		TotalCalls:       DefaultTotalCalls,
-		MaxConcurrent:    DefaultMaxConcurrent,
-		Users:            1,
-		DefaultPause:     DefaultPauseDurationMS * time.Millisecond,
-		DefaultRecvTO:    DefaultRecvTimeout,
-		StatsDumpPeriod:  time.Second,
-		RTTDumpFrequency: 200,
-		TLSSkipVerify:    true,
-		IPField:          -1,
-		RTPCodec:         "PCMU/8000",
-		RTPFreqMs:        20,
-		RTPChannels:      1,
-		LogOTELProto:     "grpc",
-		LogBufferSize:    16384,
-		LogLevel:         "info",
+		ScenarioName:         "uac",
+		Service:              "service",
+		Transport:            DefaultTransport,
+		LocalIP:              "0.0.0.0",
+		AuthPassword:         "password",
+		Rate:                 DefaultRate,
+		RateScale:            1.0,
+		BaseCSeq:             1,
+		TotalCalls:           DefaultTotalCalls,
+		MaxConcurrent:        DefaultMaxConcurrent,
+		Users:                1,
+		DefaultPause:         DefaultPauseDurationMS * time.Millisecond,
+		DefaultRecvTO:        DefaultRecvTimeout,
+		StatsDumpPeriod:      time.Second,
+		RTTDumpFrequency:     200,
+		TLSSkipVerify:        true,
+		IPField:              -1,
+		RTPCodec:             "PCMU/8000",
+		RTPFreqMs:            20,
+		RTPChannels:          1,
+		LogOTELProto:         "grpc",
+		LogBufferSize:        16384,
+		LogLevel:             "info",
+		HealthMaxFailedCalls: -1,
+		HealthMaxTimeouts:    -1,
 	}
 }
 
@@ -197,7 +211,7 @@ func Parse(args []string) (Config, error) {
 		fs.PrintDefaults()
 	}
 	fs.StringVar(&cfg.ScenarioFile, "sf", cfg.ScenarioFile, "path to XML scenario file")
-	fs.StringVar(&cfg.ScenarioName, "sn", cfg.ScenarioName, "built-in scenario name (uac, uas)")
+	fs.StringVar(&cfg.ScenarioName, "sn", cfg.ScenarioName, "built-in scenario name (uac, uas, invite_media)")
 	fs.StringVar(&cfg.Service, "s", cfg.Service, "service name used in templates")
 	fs.StringVar(&cfg.Transport, "t", cfg.Transport, "transport: u1/un/ui, t1/tn, l1/ln; client TLS aliases cl/cln; server UDP s1/sn; server TLS sl")
 	fs.StringVar(&cfg.LocalIP, "i", cfg.LocalIP, "local IP address")
@@ -207,6 +221,13 @@ func Parse(args []string) (Config, error) {
 	fs.IntVar(&cfg.IPField, "ipfield", cfg.IPField, "alias for -ip_field (SIPp-compatible)")
 	fs.StringVar(&cfg.AuthUsername, "au", cfg.AuthUsername, "authorization username for authentication challenges")
 	fs.StringVar(&cfg.AuthPassword, "ap", cfg.AuthPassword, "authorization password for authentication challenges")
+	fs.StringVar(&cfg.SipFrom, "sip_from", cfg.SipFrom, "SIP From value before ;tag= in built-in UAC scenarios (name-addr or URI); empty = gossip <sip:gossip@local_ip:local_port>")
+	fs.StringVar(&cfg.SipPAI, "sip_pai", cfg.SipPAI, "P-Asserted-Identity value only (no header name); empty omits the header")
+	fs.StringVar(&cfg.SipProvider, "sip_provider", cfg.SipProvider, "sets X-provider to this token; empty omits")
+	fs.Func("sip_extra_header", "repeatable: one extra SIP header line \"Name: value\" after Via on first in-dialog requests in built-in UAC scenarios", func(s string) error {
+		cfg.SipExtraHeaders = append(cfg.SipExtraHeaders, strings.TrimSpace(s))
+		return nil
+	})
 	fs.Float64Var(&cfg.Rate, "r", cfg.Rate, "calls per second")
 	fs.Float64Var(&cfg.RateScale, "rate_scale", cfg.RateScale, "interactive rate control step scale (SIPp-compatible)")
 	fs.Float64Var(&cfg.RateIncrease, "rate_increase", 0, "change target cps by this amount every -rate_interval milliseconds")
@@ -222,6 +243,10 @@ func Parse(args []string) (Config, error) {
 	fs.IntVar(&cfg.TotalCalls, "m", cfg.TotalCalls, "total calls to place (0 = unlimited until SIGINT or -timeout_global; stress/long-run)")
 	fs.IntVar(&cfg.Users, "users", cfg.Users, "number of logical users for user-scoped variables")
 	fs.StringVar(&cfg.SummaryJSON, "summary_json", cfg.SummaryJSON, "write final stats to JSON file")
+	fs.StringVar(&cfg.SummaryHTML, "summary_html", cfg.SummaryHTML, "write final stats to a standalone HTML report (same data as -summary_json; can be used without JSON)")
+	fs.Float64Var(&cfg.HealthMinSuccessRatio, "health_min_success_ratio", 0, "when >0 with -summary_json or -summary_html, fail run if success_ratio is lower (e.g. 0.95); exit code 2")
+	fs.IntVar(&cfg.HealthMaxFailedCalls, "health_max_failed_calls", -1, "when >=0 with -summary_json or -summary_html, fail if failed_calls exceed this (0 means any failure fails); exit code 2")
+	fs.IntVar(&cfg.HealthMaxTimeouts, "health_max_timeouts", -1, "when >=0 with -summary_json or -summary_html, fail if timeouts exceed this; exit code 2")
 	fs.BoolVar(&cfg.TraceMessages, "trace_msg", cfg.TraceMessages, "trace sent and received SIP messages")
 	fs.BoolVar(&cfg.TraceShortMsg, "trace_shortmsg", false, "trace sent and received messages as compact CSV")
 	fs.BoolVar(&cfg.TraceCounts, "trace_counts", false, "write periodic SIP message counters as CSV")
@@ -729,6 +754,7 @@ func writeHelpPreamble(w io.Writer) {
 	fmt.Fprintln(w, "  gossipper tui                full-screen launcher / runtime UI")
 	fmt.Fprintln(w, "  gossipper -interactive       same as tui")
 	fmt.Fprintln(w, "  gossipper pcap2scenario ...  PCAP → XML scenarios")
+	fmt.Fprintln(w, "  gossipper report-html ...  summary JSON → standalone HTML report")
 	fmt.Fprintln(w)
 	fmt.Fprintln(w, "See also: docs/interactive-shell.md, docs/tui.md")
 	fmt.Fprintln(w)

internal/cli/run_profile.go

@@ -45,6 +45,11 @@ type runSpec struct {
 	HEPHomerLakeRTCP *bool    `json:"hep_homer_lake_rtcp,omitempty"`
 	SendMediaReport  *bool    `json:"send_media_report,omitempty"`
 	SummaryJSON      *string  `json:"summary_json,omitempty"`
+	SummaryHTML      *string  `json:"summary_html,omitempty"`
+	SipFrom          *string  `json:"sip_from,omitempty"`
+	SipPAI           *string  `json:"sip_pai,omitempty"`
+	SipProvider      *string  `json:"sip_provider,omitempty"`
+	SipExtraHeaders  []string `json:"sip_extra_headers,omitempty"`
 	TraceMessages    *bool    `json:"trace_msg,omitempty"`
 	StatPrintPeriod  *string  `json:"stat_period,omitempty"`
 	InjectionFile    *string  `json:"injection_file,omitempty"`
@@ -217,6 +222,21 @@ func applyRunSpec(cfg *Config, spec *runSpec, configDir string) error {
 	if spec.SummaryJSON != nil {
 		cfg.SummaryJSON = strings.TrimSpace(*spec.SummaryJSON)
 	}
+	if spec.SummaryHTML != nil {
+		cfg.SummaryHTML = strings.TrimSpace(*spec.SummaryHTML)
+	}
+	if spec.SipFrom != nil {
+		cfg.SipFrom = strings.TrimSpace(*spec.SipFrom)
+	}
+	if spec.SipPAI != nil {
+		cfg.SipPAI = strings.TrimSpace(*spec.SipPAI)
+	}
+	if spec.SipProvider != nil {
+		cfg.SipProvider = strings.TrimSpace(*spec.SipProvider)
+	}
+	if len(spec.SipExtraHeaders) > 0 {
+		cfg.SipExtraHeaders = append([]string(nil), spec.SipExtraHeaders...)
+	}
 	if spec.TraceMessages != nil {
 		cfg.TraceMessages = *spec.TraceMessages
 	}

internal/engine/engine.go

@@ -115,6 +115,15 @@ type Config struct {
 	// PCAPLinkLayer selects the PCAP datalink decoder for play_pcap_* replay (and mirrors CLI -pcap-link).
 	// Empty means auto (uses file DLT; LINUX_SLL2 is detected from the global header).
 	PCAPLinkLayer string
+
+	// SipFrom is the SIP From header value before ";tag=" (name-addr or URI). Empty uses gossip@local.
+	SipFrom string
+	// SipPAI is the P-Asserted-Identity header value (without the header name).
+	SipPAI string
+	// SipProvider sets X-provider to this token (empty omits the header).
+	SipProvider string
+	// SipExtraHeaders are full header lines "Name: value" appended after Via on the first request (repeatable -sip_extra_header).
+	SipExtraHeaders []string
 }
 
 type Engine struct {
@@ -1452,6 +1461,7 @@ func (e *Engine) executeCall(
 		BasePath:          scen.BasePath,
 		InjectionFile:     e.cfg.InjectionFile,
 	}
+	applySIPIdentityKeywords(renderCtx.ExtraKeywords, e.cfg, localIP, localPort)
 	currentRemoteHost := remoteHost
 	currentRemoteIP := remoteHost
 	currentRemotePort := remotePort