Struct TestClerk 

pub struct TestClerk { /* private fields */ }

Available on crate feature testing only.

A ready-made Clerk setup for tests that are about the application rather than about authentication.

Wraps a TestIssuer so the common case — “this request is signed in as someone, now test what my app does” — is two calls and needs no knowledge of JWKS or token claims:

let clerk = TestClerk::new()?;

// Wire the layer into your router, then send authenticated requests.
let layer = clerk.layer()?;
let cookie = clerk.cookie("user_2abc")?;

Reach past it when authentication is what you are testing: session and cookie_for take a full TestSession, and issuer exposes the underlying TestIssuer.

Implementations

impl TestClerk

pub fn new() -> Result<Self, TestIssuerError>

Generates a fresh key and a Clerk setup around it.

Costs one RSA-2048 key generation (~100ms, variable). Build it once per suite and share it — see the module docs.

pub fn from_issuer(issuer: TestIssuer) -> Self

Builds a Clerk setup around an existing issuer, so the key can be shared with another process. See TestIssuer::from_pem_file_or_generate.

pub fn issuer(&self) -> &TestIssuer

The underlying issuer, for anything this wrapper does not cover.

pub fn jwks_json(&self) -> Result<String, TestIssuerError>

The JWKS document for this setup’s key.

pub fn session(&self, user_id: impl Into<String>) -> TestSession

A signed-in session for user_id, to customize before signing.

TestClerk::session("user_2abc") is TestSession::new("user_2abc"); it is here so a test does not have to import both types.

pub fn token( &self, user_id: impl Into<String>, ) -> Result<String, TestIssuerError>

A session token for user_id.

pub fn cookie( &self, user_id: impl Into<String>, ) -> Result<String, TestIssuerError>

A __session cookie header value for user_id, the credential Clerk’s browser SDK sends.

pub fn bearer( &self, user_id: impl Into<String>, ) -> Result<String, TestIssuerError>

An Authorization header value for user_id.

pub fn token_for( &self, session: &TestSession, ) -> Result<String, TestIssuerError>

A session token for a customized session.

pub fn cookie_for( &self, session: &TestSession, ) -> Result<String, TestIssuerError>

A __session cookie header value for a customized session.

pub fn bearer_for( &self, session: &TestSession, ) -> Result<String, TestIssuerError>

An Authorization header value for a customized session.

impl TestClerk

pub fn config(&self) -> Result<ClerkAuthLayerConfig, TestIssuerError>

Available on crate feature server only.

A layer config that verifies against this setup’s key and never reaches the network.

Use this when the layer needs further configuration; otherwise layer builds it directly.

pub fn layer(&self) -> Result<ClerkAuthLayer, TestIssuerError>

Available on crate feature server only.

A ClerkAuthLayer that verifies tokens minted by this setup.

Trait Implementations

impl Debug for TestClerk

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.