inst/tinytest/test_session.R

library(tinytest)

# All live-server tests are gated on at_home() so R CMD check sees no
# network. Locally, set MX_TEST_SERVER / MX_TEST_USER / MX_TEST_PASS to
# run against a real Synapse.

expect_true(is.function(mx.api::mx_login))
expect_true(is.function(mx.api::mx_session))
expect_true(is.function(mx.api::mx_logout))
expect_true(is.function(mx.api::mx_whoami))
expect_true(is.function(mx.api::mx_register))

s <- mx.api::mx_session(
  server = "https://example/",
  token = "tok",
  user_id = "@u:example",
  device_id = "DEV"
)
expect_inherits(s, "mx_session")
expect_equal(s$server, "https://example")
expect_equal(s$token, "tok")

if (at_home() && nzchar(Sys.getenv("MX_TEST_SERVER"))) {
  s <- mx.api::mx_login(
    Sys.getenv("MX_TEST_SERVER"),
    Sys.getenv("MX_TEST_USER"),
    Sys.getenv("MX_TEST_PASS")
  )
  expect_inherits(s, "mx_session")
  wid <- mx.api::mx_whoami(s)
  expect_equal(wid$user_id, s$user_id)
  mx.api::mx_logout(s)
}

Try the mx.api package in your browser

Any scripts or data that you put into this service are public.

mx.api documentation built on Sept. 12, 2026, 1:07 a.m.