ringo-flow 0.14.1

Declarative telephony scenario test runner for baresip, built on ringo-core
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

// @ts-check
// A real two-party scenario showcase (compiles + wires through to baresip; the
// dial/accept legs need live SIP creds via env to actually pass). Run with:
//   ringo-flow run crates/ringo-flow/examples/two-party.js
//
// Fixtures are plain closure-scoped variables: declared once up top, assigned in
// `setup()` (which runs fresh before each scenario), and read by every scenario /
// teardown. The `@type` annotations give every body full type-checking + completion
// with no per-scenario typing — the idiomatic JS test-fixture pattern.

/** @type {Agent} */ let caller;
/** @type {Agent} */ let callee;

setup(() => {
  // Connect two real baresip agents; `new Agent(...)` returns the live handle.
  caller = new Agent("caller", {
    username: env("A_USER"),
    domain: env("SIP_DOMAIN"),
    password: env("A_PASS"),
  });
  callee = new Agent("callee", {
    username: env("B_USER"),
    domain: env("SIP_DOMAIN"),
    password: env("B_PASS"),
  });
});

teardown(() => caller.hangup());

scenario("answered call", async () => {
  // Instant verbs (dial/accept/register/hangup) stay synchronous; only the
  // blocking waiters (until/verifyAudio) are Promises you `await`.
  caller.register();
  await until(() => expect(caller.registered).toBeTruthy(), "10s");

  caller.dial(callee);
  await until(() => expect(callee.state).toBe(State.Ringing), "15s");
  callee.accept();
  await until(() => expect(caller.state).toBe(State.Established), "10s");

  expect(caller.quality?.mos).toBeGreaterThanOrEqual(4.0);

  // Both legs send a tone and we verify reception on both ends concurrently.
  caller.sendAudio(tone(440));
  callee.sendAudio(tone(480));
  await Promise.all([callee.verifyAudio(440, "5s"), caller.verifyAudio(480, "5s")]);
});