rustpbx 0.4.4

A SIP PBX implementation in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

// tests/helpers/test_server.rs
//
// `TestPbx` — a minimal in-process RustPBX server that combines:
//   * a real SipServer bound to a random UDP port
//   * an Axum HTTP server with the `/rwi` WebSocket endpoint
//
// This is used by E2E tests that need a real SIP stack (so that sipbot UAs can
// actually exchange SIP/SDP with the PBX).

use std::collections::HashMap;
use std::sync::Arc;

use axum::{
    Extension,
    extract::{Query, ws::WebSocketUpgrade},
    http::HeaderMap,
    routing::get,
};
use tokio::net::TcpListener;
use tokio_util::sync::CancellationToken;

use rustpbx::{
    call::app::agent_registry::AgentRegistry,
    config::ProxyConfig,
    proxy::{
        active_call_registry::ActiveProxyCallRegistry,
        auth::AuthModule,
        call::{CallModule, DialplanInspector},
        registrar::RegistrarModule,
        routing::{RouteQueueConfig, RouteRule},
        server::{SipServerBuilder, SipServerRef},
    },
    rwi::{
        RwiAuth, RwiAuthRef, RwiGateway, RwiGatewayRef,
        auth::{RwiConfig, RwiTokenConfig},
        handler::rwi_ws_handler,
    },
};

pub const TEST_TOKEN: &str = "e2e-test-token";

/// Optional injections for TestPbx startup.
#[derive(Default)]
pub struct TestPbxInject {
    /// Override the full proxy config (port/address will still be normalized for tests).
    pub proxy_config: Option<ProxyConfig>,
    /// Inject embedded routes into proxy config.
    pub routes: Option<Vec<RouteRule>>,
    /// Inject embedded queues into proxy config.
    pub queues: Option<HashMap<String, RouteQueueConfig>>,
    /// Inject custom AgentRegistry (e.g. skill-group resolver).
    pub agent_registry: Option<Arc<dyn AgentRegistry>>,
    /// Additional dialplan inspectors to register (e.g. SBC JSON-RPC).
    pub dialplan_inspectors: Vec<Box<dyn DialplanInspector>>,
}

/// A running in-process PBX with a real SIP stack and an RWI WebSocket endpoint.
pub struct TestPbx {
    /// Base WebSocket URL for connecting RWI clients, e.g. `ws://127.0.0.1:<port>/rwi/v1`.
    #[allow(dead_code)]
    pub rwi_url: String,
    /// SIP port this server is listening on (UDP).
    #[allow(dead_code)]
    pub sip_port: u16,
    /// `127.0.0.1` IP where the SIP server is bound.
    #[allow(dead_code)]
    pub sip_addr: String,
    /// RWI gateway — can be used to inject events in tests.
    #[allow(dead_code)]
    pub gateway: RwiGatewayRef,
    /// Shared call registry (same instance as in the SipServer).
    #[allow(dead_code)]
    pub registry: Arc<ActiveProxyCallRegistry>,
    /// Cancellation token — cancel to shut everything down.
    pub cancel_token: CancellationToken,
}

impl TestPbx {
    /// Start a TestPbx bound to the given `sip_port`.
    ///
    /// Use `portpicker::pick_unused_port().unwrap()` to choose ports.
    #[allow(dead_code)]
    pub async fn start(sip_port: u16) -> Self {
        Self::start_with_inject(sip_port, TestPbxInject::default()).await
    }

    /// Start TestPbx with injectable config components (routes/queues/agent-registry).
    pub async fn start_with_inject(sip_port: u16, inject: TestPbxInject) -> Self {
        let cancel_token = CancellationToken::new();

        // ── Build SipServer ──────────────────────────────────────────────────
        let mut cfg = inject.proxy_config.unwrap_or_else(|| ProxyConfig {
            addr: "127.0.0.1".to_string(),
            udp_port: Some(sip_port),
            ..Default::default()
        });
        cfg.addr = "127.0.0.1".to_string();
        cfg.udp_port = Some(sip_port);
        if let Some(routes) = inject.routes {
            cfg.routes = Some(routes);
        }
        if let Some(queues) = inject.queues {
            cfg.queues = queues;
        }

        let proxy_config = Arc::new(cfg);

        let mut builder = SipServerBuilder::new(proxy_config.clone())
            .with_cancel_token(cancel_token.child_token());
        builder = builder
            .register_module("registrar", |inner, config| {
                Ok(Box::new(RegistrarModule::new(inner, config)))
            })
            .register_module("auth", |inner, _config| {
                Ok(Box::new(AuthModule::new(
                    inner.clone(),
                    inner.proxy_config.clone(),
                )))
            })
            .register_module("call", |inner, config| {
                Ok(Box::new(CallModule::new(config, inner)))
            });
        if let Some(agent_registry) = inject.agent_registry {
            builder = builder.with_agent_registry(agent_registry);
        }
        for inspector in inject.dialplan_inspectors {
            builder = builder.with_dialplan_inspector(inspector);
        }

        let sip_server = builder.build().await.expect("SipServer build failed");

        let sip_server_ref: SipServerRef = sip_server.get_inner();
        let registry = sip_server_ref.active_call_registry.clone();

        // Spawn the SIP serving loop
        {
            let ct = cancel_token.child_token();
            tokio::spawn(async move {
                tokio::select! {
                    _ = ct.cancelled() => {}
                    res = sip_server.serve() => {
                        if let Err(e) = res {
                            tracing::error!("SipServer serve error: {e:?}");
                        }
                    }
                }
            });
        }

        // ── Build RWI components ─────────────────────────────────────────────
        let rwi_config = RwiConfig {
            enabled: true,
            tokens: vec![RwiTokenConfig {
                token: TEST_TOKEN.to_string(),
                scopes: vec!["call.control".to_string()],
            }],
            ..Default::default()
        };
        let auth: RwiAuthRef = Arc::new(tokio::sync::RwLock::new(RwiAuth::new(&rwi_config)));
        let gateway: RwiGatewayRef = Arc::new(tokio::sync::RwLock::new(RwiGateway::new()));

        // ── Build Axum router with RWI endpoint ──────────────────────────────
        let auth_c = auth.clone();
        let gw_c = gateway.clone();
        let reg_c = registry.clone();
        let srv_c = Some(sip_server_ref.clone());

        let router = axum::Router::new().route(
            "/rwi/v1",
            get(
                move |client_addr: rustpbx::handler::middleware::clientaddr::ClientAddr,
                      ws: WebSocketUpgrade,
                      Query(params): Query<HashMap<String, String>>,
                      headers: HeaderMap| {
                    let a = auth_c.clone();
                    let g = gw_c.clone();
                    let r = reg_c.clone();
                    let s = srv_c.clone();
                    async move {
                        rwi_ws_handler(
                            client_addr,
                            ws,
                            Query(params),
                            Extension(a),
                            Extension(g),
                            Extension(r),
                            Extension(s),
                            headers,
                        )
                        .await
                    }
                },
            ),
        );

        let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
        let http_port = listener.local_addr().unwrap().port();

        let ct = cancel_token.child_token();
        tokio::spawn(async move {
            axum::serve(listener, router)
                .with_graceful_shutdown(async move { ct.cancelled().await })
                .await
                .unwrap();
        });

        let rwi_url = format!("ws://127.0.0.1:{}/rwi/v1", http_port);

        Self {
            rwi_url,
            sip_port,
            sip_addr: "127.0.0.1".to_string(),
            gateway,
            registry,
            cancel_token,
        }
    }

    /// Return the SIP address string: `127.0.0.1:<sip_port>`.
    #[allow(dead_code)]
    pub fn sip_host(&self) -> String {
        format!("{}:{}", self.sip_addr, self.sip_port)
    }

    /// Shut down the server.
    #[allow(dead_code)]
    pub fn stop(&self) {
        self.cancel_token.cancel();
    }
}

impl Drop for TestPbx {
    fn drop(&mut self) {
        self.cancel_token.cancel();
    }
}