test: Asterisk upgrade check
verified.ts records what the code relies on Asterisk doing and the version it was measured on; pnpm test fails while the Dockerfile pins another one. pnpm test:asterisk-upgrade boots the image next to a TLS provider and lists every behaviour that moved and what depends on it.
This commit is contained in:
iamdoubz committed
1 parent
678d45e4f9
commit
a0121d4975
5 files changed
+416
-1
No files matched your search
@@ -0,0 +1,26 @@
|
||||
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
// A new Asterisk in asterisk/Dockerfile must go through the upgrade check first (verified.ts).
|
||||
import { readFileSync } from 'node:fs';
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import { VERIFIED_ASTERISK, pinnedAsterisk } from './asterisk/verified.ts';
|
||||
|
||||
describe('the pinned Asterisk', () => {
|
||||
it('is the version the upgrade check last passed on', () => {
|
||||
expect(
|
||||
pinnedAsterisk(),
|
||||
`asterisk/Dockerfile pins ${pinnedAsterisk()}, the upgrade check last passed on ` +
|
||||
`${VERIFIED_ASTERISK}. Build the image, run \`pnpm test:asterisk-upgrade\` and ` +
|
||||
'`pnpm test:asterisk`, act on what moved, then set VERIFIED_ASTERISK in ' +
|
||||
'apps/api/test/asterisk/verified.ts',
|
||||
).toBe(VERIFIED_ASTERISK);
|
||||
});
|
||||
|
||||
it('is the one spec 01 §2 names', () => {
|
||||
const spec = readFileSync(
|
||||
new URL('../../../docs/spec/01-infrastructure.md', import.meta.url),
|
||||
'utf8',
|
||||
);
|
||||
expect(spec).toContain(`**Pinned: \`${pinnedAsterisk()}\``);
|
||||
expect(spec).toContain(`ARG ASTERISK_VERSION=${pinnedAsterisk()}`);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,311 @@
|
||||
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
// Asterisk upgrade check (01 §2): boot the pinned image and measure each behaviour in verified.ts,
|
||||
// then list every one that moved and what depends on it. A second Asterisk plays a provider on
|
||||
// TLS with a certificate from our own CA for "provider.test", so the qualify check sees a real
|
||||
// host name. Needs Docker and the image built from asterisk/Dockerfile (ASTERISK_IMAGE, default
|
||||
// "selfphoneng-asterisk").
|
||||
// Usage: pnpm test:asterisk-upgrade
|
||||
import { spawnSync } from 'node:child_process';
|
||||
import { cpSync, mkdtempSync, readdirSync, rmSync, writeFileSync, appendFileSync } from 'node:fs';
|
||||
import { tmpdir } from 'node:os';
|
||||
import { join } from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import { AmiClient } from '../../src/ami/client.ts';
|
||||
import { field, type AmiMessage } from '../../src/ami/events.ts';
|
||||
import { FACTS, VERIFIED_ASTERISK, pinnedAsterisk, type Fact } from './verified.ts';
|
||||
|
||||
const IMAGE = process.env.ASTERISK_IMAGE ?? 'selfphoneng-asterisk';
|
||||
const GOLDEN = fileURLToPath(
|
||||
new URL('../../src/generator/__golden__/one-user/expected', import.meta.url),
|
||||
);
|
||||
const NET = 'sp-upgrade';
|
||||
const PBX = 'sp-upgrade-pbx';
|
||||
const PROVIDER = 'sp-upgrade-provider';
|
||||
const HOST = 'provider.test';
|
||||
const AMI_PORT = 15040;
|
||||
const AMI_SECRET = 'upgrade-test-secret';
|
||||
const SUB = { user: 'upgrade', pass: 'UpgradeSecret42' };
|
||||
const RISKY = ['app_system', 'func_shell', 'app_disa', 'res_agi', 'app_externalivr'];
|
||||
|
||||
const sleep = (ms: number) => new Promise((r) => setTimeout(r, ms));
|
||||
const docker = (...args: string[]) => {
|
||||
const r = spawnSync('docker', args, { encoding: 'utf8' });
|
||||
return { ok: r.status === 0, out: `${r.stdout ?? ''}${r.stderr ?? ''}` };
|
||||
};
|
||||
const log = (...a: unknown[]) => console.log('[upgrade-test]', ...a);
|
||||
async function waitFor(what: string, fn: () => Promise<boolean>, seconds = 60) {
|
||||
for (let i = 0; i < seconds; i++) {
|
||||
if (await fn()) return;
|
||||
await sleep(1000);
|
||||
}
|
||||
throw new Error(`timed out waiting for ${what}`);
|
||||
}
|
||||
|
||||
/** A CA, and a certificate from it for HOST: what the PBX trusts and the provider shows. */
|
||||
function certificates(dir: string) {
|
||||
const r = docker(
|
||||
'run',
|
||||
'--rm',
|
||||
'-v',
|
||||
`${dir}:/out`,
|
||||
'--entrypoint',
|
||||
'sh',
|
||||
IMAGE,
|
||||
'-c',
|
||||
[
|
||||
'cd /out',
|
||||
'openssl req -x509 -newkey rsa:2048 -nodes -days 1 -subj /CN=sp-upgrade-ca -keyout ca.key -out ca.pem',
|
||||
`openssl req -newkey rsa:2048 -nodes -subj /CN=${HOST} -keyout privkey.pem -out host.csr`,
|
||||
`printf 'subjectAltName=DNS:${HOST}' > host.ext`,
|
||||
'openssl x509 -req -in host.csr -CA ca.pem -CAkey ca.key -CAcreateserial -days 1 -extfile host.ext -out fullchain.pem',
|
||||
'chmod 644 *',
|
||||
].join(' && '),
|
||||
);
|
||||
if (!r.ok) throw new Error(`certificates: ${r.out}`);
|
||||
}
|
||||
|
||||
const tlsTransport = (name: string, port: number, client: boolean) => `
|
||||
[${name}]
|
||||
type = transport
|
||||
protocol = tls
|
||||
bind = 0.0.0.0:${port}
|
||||
cert_file = /tls/fullchain.pem
|
||||
priv_key_file = /tls/privkey.pem
|
||||
method = tlsv1_2
|
||||
${client ? 'verify_server = yes\nca_list_file = /tls/ca.pem\n' : ''}`;
|
||||
|
||||
/** The provider: TLS only, one account that may register. */
|
||||
const providerPjsip = `${tlsTransport('transport-tls', 5061, false)}
|
||||
[${SUB.user}]
|
||||
type = endpoint
|
||||
context = default
|
||||
disallow = all
|
||||
allow = ulaw
|
||||
auth = ${SUB.user}-auth
|
||||
aors = ${SUB.user}
|
||||
|
||||
[${SUB.user}-auth]
|
||||
type = auth
|
||||
auth_type = userpass
|
||||
username = ${SUB.user}
|
||||
password = ${SUB.pass}
|
||||
|
||||
[${SUB.user}]
|
||||
type = aor
|
||||
max_contacts = 1
|
||||
remove_existing = yes
|
||||
`;
|
||||
|
||||
/**
|
||||
* Added to the one-user golden config: a trunk to the provider by name over TLS. The registration
|
||||
* is the control (REGISTER verifies the name on every version we know); the AOR's qualify is the
|
||||
* fact being measured.
|
||||
*/
|
||||
const pbxPjsip = `${tlsTransport('sp-upgrade-tls', 5062, true)}
|
||||
[sp-upgrade-auth]
|
||||
type = auth
|
||||
auth_type = userpass
|
||||
username = ${SUB.user}
|
||||
password = ${SUB.pass}
|
||||
|
||||
[sp-upgrade-reg]
|
||||
type = registration
|
||||
transport = sp-upgrade-tls
|
||||
outbound_auth = sp-upgrade-auth
|
||||
server_uri = sip:${HOST}:5061;transport=tls
|
||||
client_uri = sip:${SUB.user}@${HOST}:5061;transport=tls
|
||||
contact_user = ${SUB.user}
|
||||
retry_interval = 5
|
||||
|
||||
[sp-upgrade-trunk]
|
||||
type = aor
|
||||
contact = sip:${HOST}:5061;transport=tls
|
||||
qualify_frequency = 5
|
||||
|
||||
[sp-upgrade-trunk]
|
||||
type = endpoint
|
||||
transport = sp-upgrade-tls
|
||||
outbound_auth = sp-upgrade-auth
|
||||
aors = sp-upgrade-trunk
|
||||
context = sp-upgrade-test
|
||||
`;
|
||||
|
||||
const pbxDialplan = `
|
||||
[sp-upgrade-test]
|
||||
exten => s,1,Answer()
|
||||
same => n,Hangup()
|
||||
`;
|
||||
|
||||
async function main() {
|
||||
const pinned = pinnedAsterisk();
|
||||
const tls = mkdtempSync(join(tmpdir(), 'sp-upgrade-tls-'));
|
||||
const pbxConf = mkdtempSync(join(tmpdir(), 'sp-upgrade-pbx-'));
|
||||
const provConf = mkdtempSync(join(tmpdir(), 'sp-upgrade-prov-'));
|
||||
cpSync(GOLDEN, pbxConf, { recursive: true });
|
||||
appendFileSync(join(pbxConf, 'pjsip_selfphoneng.conf'), pbxPjsip);
|
||||
appendFileSync(join(pbxConf, 'extensions_selfphoneng.conf'), pbxDialplan);
|
||||
for (const f of readdirSync(GOLDEN))
|
||||
writeFileSync(join(provConf, f), f === 'pjsip_selfphoneng.conf' ? providerPjsip : '');
|
||||
writeFileSync(
|
||||
join(pbxConf, 'manager.conf.template'),
|
||||
'[general]\nenabled = yes\nport = 5038\nbindaddr = 0.0.0.0\n\n[selfphoneng]\nsecret = ${AMI_SECRET}\npermit = 0.0.0.0/0.0.0.0\nread = all\nwrite = all\n',
|
||||
);
|
||||
|
||||
const ami = new AmiClient({
|
||||
host: '127.0.0.1',
|
||||
port: AMI_PORT,
|
||||
username: 'selfphoneng',
|
||||
secret: AMI_SECRET,
|
||||
logger: { info() {}, warn() {}, error() {}, debug() {} },
|
||||
backoffMs: [500],
|
||||
});
|
||||
const asterisk = (name: string, conf: string, extra: string[]) =>
|
||||
docker(
|
||||
'run',
|
||||
'-d',
|
||||
'--rm',
|
||||
'--name',
|
||||
name,
|
||||
'--network',
|
||||
NET,
|
||||
...extra,
|
||||
'-e',
|
||||
`AMI_SECRET=${AMI_SECRET}`,
|
||||
'-v',
|
||||
`${conf}:/etc/asterisk/selfphoneng`,
|
||||
'-v',
|
||||
`${tls}:/tls:ro`,
|
||||
IMAGE,
|
||||
);
|
||||
const booted = (name: string) =>
|
||||
waitFor(
|
||||
`${name} to boot`,
|
||||
async () => docker('exec', name, 'asterisk', '-rx', 'core waitfullybooted').ok,
|
||||
);
|
||||
|
||||
const seen = {} as Record<Fact, boolean>;
|
||||
const problems: string[] = [];
|
||||
try {
|
||||
docker('rm', '-f', PBX, PROVIDER);
|
||||
docker('network', 'create', NET);
|
||||
certificates(tls);
|
||||
const prov = asterisk(PROVIDER, provConf, ['--network-alias', HOST]);
|
||||
if (!prov.ok) throw new Error(`provider: ${prov.out}`);
|
||||
await booted(PROVIDER);
|
||||
const pbx = asterisk(PBX, pbxConf, [
|
||||
'-p',
|
||||
`127.0.0.1:${AMI_PORT}:5038`,
|
||||
'-v',
|
||||
`${join(pbxConf, 'manager.conf.template')}:/etc/asterisk/manager.conf.template:ro`,
|
||||
]);
|
||||
if (!pbx.ok) throw new Error(`pbx: ${pbx.out}`);
|
||||
await booted(PBX);
|
||||
|
||||
const running = docker('exec', PBX, 'asterisk', '-V').out.trim();
|
||||
if (running !== `Asterisk ${pinned}`)
|
||||
throw new Error(
|
||||
`the image runs "${running}" but asterisk/Dockerfile pins ${pinned}: rebuild it ` +
|
||||
`(docker build -t ${IMAGE} asterisk)`,
|
||||
);
|
||||
log(`${running}, last verified on ${VERIFIED_ASTERISK}`);
|
||||
|
||||
ami.start();
|
||||
await new Promise((r) => ami.once('connected', r));
|
||||
const cli = (cmd: string) => ami.command(cmd);
|
||||
|
||||
const modules = await Promise.all(RISKY.map((m) => cli(`module show like ${m}`)));
|
||||
seen.riskyModulesGone = modules.every((o) => /\b0 modules loaded/.test(o));
|
||||
const ep101 = await cli('pjsip show endpoint 101');
|
||||
seen.mwiSubscribeReplaces = /mwi_subscribe_replaces_unsolicited\s*:\s*yes/.test(ep101);
|
||||
// set_var lines show as their own rows: " __SP_DIRECTION : internal".
|
||||
seen.setVarKeepsUnderscores = /^\s*__SP_DIRECTION\s*:\s*internal\s*$/m.test(ep101);
|
||||
const commands = await cli('manager show commands');
|
||||
seen.voicemailMoveRemove =
|
||||
/\bVoicemailMove\b/.test(commands) && /\bVoicemailRemove\b/.test(commands);
|
||||
|
||||
// CDR: one Local call through the test context.
|
||||
const cdr = new Promise<AmiMessage>((r) => ami.once('event:Cdr', r));
|
||||
await cli('channel originate Local/s@sp-upgrade-test application Wait 1');
|
||||
const m = await Promise.race([
|
||||
cdr,
|
||||
sleep(15_000).then(() => {
|
||||
throw new Error('no Cdr event within 15 s of a call');
|
||||
}),
|
||||
]);
|
||||
seen.cdrLinkedId = !!field(m, 'LinkedID');
|
||||
const start = field(m, 'StartTime') ?? '';
|
||||
seen.cdrTimesUtcNoZone =
|
||||
/^\d{4}-\d\d-\d\d \d\d:\d\d:\d\d$/.test(start) &&
|
||||
Math.abs(Date.parse(`${start.replace(' ', 'T')}Z`) - Date.now()) < 120_000;
|
||||
|
||||
// TLS: the registration must work first, or the qualify answer says nothing.
|
||||
await waitFor(
|
||||
'the TLS registration to the provider (the control)',
|
||||
async () => /sp-upgrade-reg\S*\s.*Registered/.test(await cli('pjsip show registrations')),
|
||||
45,
|
||||
).catch(async (e: Error) => {
|
||||
throw new Error(`${e.message}:\n${await cli('pjsip show registrations')}`);
|
||||
});
|
||||
let contacts = '';
|
||||
for (let i = 0; i < 20; i++) {
|
||||
contacts = await cli('pjsip show contacts');
|
||||
if (/sp-upgrade-trunk\/\S+\s.*\b(Avail|Unavail)/.test(contacts)) break;
|
||||
await sleep(1000);
|
||||
}
|
||||
seen.tlsQualifyByHostname = /sp-upgrade-trunk\/\S+\s.*\bAvail\b/.test(contacts);
|
||||
if (!seen.tlsQualifyByHostname) {
|
||||
const why = docker('logs', PBX)
|
||||
// eslint-disable-next-line no-control-regex -- strips Asterisk's ANSI colors
|
||||
.out.replace(/\x1b\[[0-9;]*m/g, '')
|
||||
.split('\n');
|
||||
const line = contacts.split('\n').find((l) => l.includes('sp-upgrade-trunk'));
|
||||
log('qualify over TLS failed:', line);
|
||||
for (const l of why
|
||||
.filter((x) => /sp-upgrade-trunk|identity|EUNSUP|qualif/i.test(x))
|
||||
.slice(-4))
|
||||
log(l.trim());
|
||||
}
|
||||
|
||||
const listed = await ami.actionList({ Action: 'PJSIPShowContacts' });
|
||||
seen.staticContactsInShowContacts = listed.some((x) => x.Aor === 'sp-upgrade-trunk');
|
||||
const detail = await ami.actionList({
|
||||
Action: 'PJSIPShowEndpoint',
|
||||
Endpoint: 'sp-upgrade-trunk',
|
||||
});
|
||||
seen.endpointShowsContactStatus = detail.some(
|
||||
(x) => x.Event === 'ContactStatusDetail' && x.AOR === 'sp-upgrade-trunk',
|
||||
);
|
||||
} catch (e) {
|
||||
problems.push((e as Error).message);
|
||||
} finally {
|
||||
ami.stop();
|
||||
docker('rm', '-f', PBX, PROVIDER);
|
||||
docker('network', 'rm', NET);
|
||||
for (const d of [tls, pbxConf, provConf]) rmSync(d, { recursive: true, force: true });
|
||||
}
|
||||
|
||||
const moved = (Object.keys(FACTS) as Fact[]).filter(
|
||||
(k) => k in seen && seen[k] !== FACTS[k].expect,
|
||||
);
|
||||
for (const k of Object.keys(FACTS) as Fact[])
|
||||
console.log(
|
||||
`${!(k in seen) ? '? ' : moved.includes(k) ? 'MOVED' : 'ok '} ${k}: ${k in seen ? seen[k] : 'not measured'}`,
|
||||
);
|
||||
for (const k of moved)
|
||||
problems.push(
|
||||
`${k} was ${FACTS[k].expect} on ${VERIFIED_ASTERISK}, is ${seen[k]} on ${pinned}: ` +
|
||||
`${FACTS[k].what}. Depends on it: ${FACTS[k].where}`,
|
||||
);
|
||||
if (problems.length) {
|
||||
console.log('FAIL asterisk upgrade');
|
||||
for (const p of problems) console.log(` ${p}`);
|
||||
process.exit(1);
|
||||
}
|
||||
console.log(
|
||||
pinned === VERIFIED_ASTERISK
|
||||
? `ok asterisk ${pinned}: every fact as recorded`
|
||||
: `ok asterisk ${pinned}: nothing moved since ${VERIFIED_ASTERISK}; set VERIFIED_ASTERISK in verified.ts`,
|
||||
);
|
||||
}
|
||||
|
||||
await main();
|
||||
@@ -0,0 +1,68 @@
|
||||
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
// What the code relies on Asterisk doing, as last measured by upgrade-test.ts, and on which
|
||||
// version. asterisk-version.test.ts fails when asterisk/Dockerfile pins another version: run
|
||||
// `pnpm test:asterisk-upgrade` on the new image, act on each change it lists, then update this.
|
||||
import { readFileSync } from 'node:fs';
|
||||
|
||||
export const VERIFIED_ASTERISK = '24.0.0-rc2';
|
||||
|
||||
/** The version asterisk/Dockerfile builds. */
|
||||
export function pinnedAsterisk(): string {
|
||||
const file = readFileSync(new URL('../../../../asterisk/Dockerfile', import.meta.url), 'utf8');
|
||||
const v = /^ARG ASTERISK_VERSION=(\S+)$/m.exec(file)?.[1];
|
||||
if (!v) throw new Error('asterisk/Dockerfile has no ARG ASTERISK_VERSION');
|
||||
return v;
|
||||
}
|
||||
|
||||
/** `expect`: the answer on VERIFIED_ASTERISK. `where`: what depends on it, to change if it moves. */
|
||||
export const FACTS = {
|
||||
riskyModulesGone: {
|
||||
expect: true,
|
||||
what: 'app_system, func_shell, app_disa, res_agi and app_externalivr are not loaded',
|
||||
where: 'asterisk/conf/modules.conf noload lines (08 §6): a renamed module would load again',
|
||||
},
|
||||
mwiSubscribeReplaces: {
|
||||
expect: true,
|
||||
what: 'endpoints take mwi_subscribe_replaces_unsolicited',
|
||||
where: 'generator/pjsip.ts: without it a phone that SUBSCRIBEs for MWI gets a 500 (03 §5.2)',
|
||||
},
|
||||
setVarKeepsUnderscores: {
|
||||
expect: true,
|
||||
what: 'set_var = __SP_DIRECTION=… loads as "__SP_DIRECTION"',
|
||||
where: 'generator/pjsip.ts set_var lines; dialplan reads SP_DIRECTION on dialed legs (03 §5.2)',
|
||||
},
|
||||
staticContactsInShowContacts: {
|
||||
expect: false,
|
||||
what: 'PJSIPShowContacts lists static (contact =) AOR contacts',
|
||||
where: 'live/state.ts reads trunk reachability from PJSIPShowEndpoint instead (04 §5.1)',
|
||||
},
|
||||
endpointShowsContactStatus: {
|
||||
expect: true,
|
||||
what: 'PJSIPShowEndpoint has a ContactStatusDetail for a static contact',
|
||||
where: 'live/state.ts trunk reachability (04 §5.1)',
|
||||
},
|
||||
voicemailMoveRemove: {
|
||||
expect: true,
|
||||
what: 'the AMI actions VoicemailMove and VoicemailRemove exist',
|
||||
where: 'services/voicemail.ts mark read and delete (04 §5.6)',
|
||||
},
|
||||
cdrLinkedId: {
|
||||
expect: true,
|
||||
what: 'Cdr AMI events carry LinkedID (cdr_manager.conf mapping)',
|
||||
where: 'services/cdr.ts groups a call by it (01 §3.15, 04 §5.4)',
|
||||
},
|
||||
cdrTimesUtcNoZone: {
|
||||
expect: true,
|
||||
what: 'Cdr StartTime is "YYYY-MM-DD HH:MM:SS" in UTC, no zone',
|
||||
where: 'services/cdr.ts utc() adds the Z itself',
|
||||
},
|
||||
tlsQualifyByHostname: {
|
||||
expect: false,
|
||||
what: 'a qualify OPTIONS over TLS checks the certificate against the host name, not the IP',
|
||||
where:
|
||||
'generator/pjsip.ts sets qualify_frequency = 0 on TLS trunks because of this (08 §2.1); ' +
|
||||
'24.0.0-rc3 says it fixes it ("Preserve target hostname for qualified OPTIONS destination")',
|
||||
},
|
||||
} as const;
|
||||
|
||||
export type Fact = keyof typeof FACTS;
|
||||
Reference in new issue
Block a user