Testing

Test your integration offline with MockOnlineSim — no network, key or money.

MockOnlineSim is an in-process fake of the OnlineSim API that ships with the package. It is an OnlineSimTransport that answers like the real backend — same shapes, same error codes, HTTP 456 for a wrong key, HTTP 200 ERROR_WRONG_KEY for none — and keeps a balance, operations and rents. Your code talks to a normal OnlineSim client, so nothing in it changes for tests. It is deterministic: no randomness, no clock, numbers and ids come from a counter.

Setup

import 'package:onlinesim/onlinesim.dart';

final mock = MockOnlineSim(balance: 10);
final client = mock.client(); // an OnlineSim wired to the mock
MockOnlineSim({String apiKey = 'mock-key', double balance = 100, MockPrices prices = defaultMockPrices, Map<int, MockRentTariff> rentTariffs = defaultMockRentTariffs, int guardInterval = 0})
OptionDefaultDescription
apiKey'mock-key'Key the mock accepts. mock.client() uses it; mock.client(apiKey: 'x') tests a wrong key.
balance100Starting balance, USD.
prices{7: {'vkcom': 0.5, 'telegram': 1.2, 'google': 0.3}, 44: {'google': 0.2, 'vkcom': 0.36}}Number prices (country → service → USD); replaces the defaults. Also feeds numbers.tariffs().
rentTariffs{7: MockRentTariff(days: {1: 1.0, 3: 2.5, 7: 5.0})}Rent prices; extend: 0 makes rents of that country non-extendable.
guardInterval0Seconds; > 0: an operation without SMS, or an unconfirmed rent without any SMS, cannot be closed (NO_COMPLETE_TZID).

mock.client(apiKey:, lang:, devId:, timeout:) takes the usual client options except the transport. To build the client yourself, pass the mock as the transport; any baseUrl works:

import 'package:onlinesim/onlinesim.dart';

final mock = MockOnlineSim();
final client = OnlineSim(apiKey: 'mock-key', transport: mock);

A full example

Order a number, let an SMS arrive while waitCode polls, check the code and the money. addSmsAfter delivers the SMS after a number of polls instead of after some time, so waitCode runs with interval: Duration.zero and the test takes milliseconds.

import 'package:onlinesim/onlinesim.dart';
import 'package:test/test.dart';

void main() {
  test('receives the code', () async {
    final mock = MockOnlineSim(balance: 10);
    final client = mock.client();

    final order = await client.numbers.getWithNumber('google', country: 44);
    expect(order.number, '+44900000001');

    mock.addSmsAfter(order.tzid, 'Your Google code: 123-456', 2); // the third poll sees it
    final code = await client.numbers.waitCode(order.tzid, interval: Duration.zero);

    expect(code, '123456');
    expect(mock.operations().single.status, 'TZ_OVER_OK'); // waitCode closed it
    expect(mock.balance(), 9.8); // the price is spent once an SMS arrived
  });
}

The msg of an operation is the code by default: the first run of 4–8 digits, with spaces and dashes between digits removed (123-456 → 123456); a text without such a run comes back whole. messageToCode: false (or fullMessage in waitCode) gives the full text.

Errors

failNext(code) makes the next request answer {"response": code} — the client turns it into ApiException (or NoNumberException) exactly as for the real server. Pass endpoint to fail only that endpoint. failNextTransport() makes the next request fail with a non-JSON HTTP 502 (TransportException).

import 'package:onlinesim/onlinesim.dart';
import 'package:test/test.dart';

void main() {
  test('handles a missing number and a network hiccup', () async {
    final mock = MockOnlineSim();
    final client = mock.client();

    mock.failNext('NO_NUMBER', endpoint: 'getNum.php');
    await expectLater(client.numbers.get('google'), throwsA(isA<NoNumberException>()));

    mock.failNextTransport(status: 503);
    await expectLater(client.user.balance(), throwsA(isA<TransportException>()));

    expect((await client.user.balance()).balance, 100); // one-shot
  });
}

The state itself produces the real error codes too: WARNING_LOW_BALANCE when the balance is short, NO_NUMBER when reject matches the next number, UNDEFINED_COUNTRY / ERROR_NO_SERVICE for unknown prices, ERROR_WRONG_TZID for an unknown or closed operation (next too; ERROR_NO_TZID for tzid 0), UNDEFINED_COUNTRY / UNDEFINED_DAYS for an unknown rent country or period, TRY_AGAIN_LATER for every refused rent.extend, ERROR_NO_OPERATIONS for an unknown rent in rent.close, ERROR_WRONG_KEY for a wrong key (HTTP 456) or no key (HTTP 200).

Inspecting requests

mock.requests lists every request received: MockRequest with method, path, query, body; path is relative to /api/.

import 'package:onlinesim/onlinesim.dart';
import 'package:test/test.dart';

void main() {
  test('sends reject as a comma list', () async {
    final mock = MockOnlineSim();
    await mock.client().numbers.get('google', country: 44, reject: ['4470', '4471']);

    final request = mock.requests.single;
    expect(request.path, 'getNum.php');
    expect(request.query, {'service': 'google', 'country': '44', 'reject': '4470,4471', 'lang': 'en'});
  });
}

Control API

MemberDescription
client({apiKey, lang, devId, timeout})A normal OnlineSim wired to the mock.
send(request)The mock is an OnlineSimTransport: pass it as transport.
addSms(tzid, text, {service})An SMS arrives now at a number operation or a rent (detected by tzid). Throws StateError for an unknown or closed one.
addSmsAfter(tzid, text, polls, {service})The SMS arrives after polls state requests for tzid (numbers.state/stateOne, rent.state/stateOne).
failNext(code, {endpoint})The next request (to endpoint only, e.g. 'getNum.php') answers {"response": code}.
failNextTransport({status, endpoint})The next request fails with a non-JSON body and HTTP status (default 502).
setBalance(usd) / balance()Set / read the total balance, USD (it includes the part frozen by open operations, as user.balance() reports it).
operations() / rents()Snapshots of the current number operations (MockOperation) / open rents (MockRent), for assertions.
requestsLog of the requests received.
reset()Back to the constructor's state.

What the mock does

  • Numbers: get freezes the price; close after an SMS spends it, close without one refunds it; ban after an SMS answers "0", like the server. Numbers are +<country>9000000NN, ids count from 1. next switches to the following SMS. The operation's time stays at 1200 s — there is no clock.
  • Rent: get reserves the price (status 0, checked false) and keeps the extension flag; the first SMS that is not notify confirms the rent (status 1) and charges it — addSms(tzid, text, service: 'notify') adds a notice with code 0 that confirms nothing. extend works on a confirmed rent and charges at once. close releases the reservation of an unconfirmed rent and gives no refund for a confirmed one. sum is a number in get/extend and a decimal string on the wire of state, like the server. SMS appear in messages, newest first.
  • User: balance (frozen part included), a fixed profile, setWebhookUrl accepts any scheme://… URL (VALIDATION_ERROR otherwise), webhookLogs lists the deliveries the mock recorded when an SMS arrived while a webhook URL was set — it makes no HTTP call; their params follow the real payload (code '' without a code, rent number in digits without +, rent timeLeft in minutes). paymentHistory has no orders.
  • Free: free.list returns two fixed countries (44 first) with one number and a few SMS each.
  • Not imitated: anything that needs real time — the 5 s lock after setOperationOk (INTERVAL_CONCURRENT_REQUESTS_ERROR), the 10 s lock of rent.extend, the 120 s before an unconfirmed rent may be closed and its 20-minute wait for the first SMS. guardInterval > 0 stands in for "too early to close".