Struct apollo_router::TestHarness
source ยท pub struct TestHarness<'a> { /* private fields */ }
Expand description
Builder for the part of an Apollo Router that handles GraphQL requests, as a tower::Service
.
This allows tests, benchmarks, etc to manipulate request and response objects in memory without going over the network on the supergraph side.
On the subgraph side, this test harness never makes network requests to subgraphs
unless with_subgraph_network_requests
is called.
Compared to running a full RouterHttpServer
,
this test harness is lacking:
- Custom endpoints from plugins
- The health check endpoint
- CORS (FIXME: should this include CORS?)
- HTTP compression
Example making a single request:
use apollo_router::services::supergraph;
use apollo_router::TestHarness;
use tower::util::ServiceExt;
let config = serde_json::json!({"supergraph": { "introspection": false }});
let request = supergraph::Request::fake_builder()
// Request building here
.build()
.unwrap();
let response = TestHarness::builder()
.configuration_json(config)?
.build_router()
.await?
.oneshot(request.try_into().unwrap())
.await?
.next_response()
.await
.unwrap();
Implementationsยง
sourceยงimpl<'a> TestHarness<'a>
impl<'a> TestHarness<'a>
sourcepub fn schema(self, schema: &'a str) -> Self
pub fn schema(self, schema: &'a str) -> Self
Specifies the (static) supergraph schema definition.
Panics if called more than once.
If this isnโt called, a default โcannedโ schema is used.
It can be found in the Router repository at apollo-router/testing_schema.graphql
.
In that case, subgraph responses are overridden with some โcannedโ data.
sourcepub fn configuration(self, configuration: Arc<Configuration>) -> Self
pub fn configuration(self, configuration: Arc<Configuration>) -> Self
Specifies the (static) router configuration.
sourcepub fn configuration_json(self, configuration: Value) -> Result<Self, Error>
pub fn configuration_json(self, configuration: Value) -> Result<Self, Error>
Specifies the (static) router configuration as a JSON value,
such as from the serde_json::json!
macro.
sourcepub fn extra_plugin<P: Plugin>(self, plugin: P) -> Self
pub fn extra_plugin<P: Plugin>(self, plugin: P) -> Self
Adds an extra, already instanciated plugin.
May be called multiple times. These extra plugins are added after plugins specified in configuration.
sourcepub fn router_hook(
self,
callback: impl Fn(BoxService) -> BoxService + Send + Sync + 'static
) -> Self
pub fn router_hook(
self,
callback: impl Fn(BoxService) -> BoxService + Send + Sync + 'static
) -> Self
Adds a callback-based hook similar to Plugin::router_service
sourcepub fn supergraph_hook(
self,
callback: impl Fn(BoxService) -> BoxService + Send + Sync + 'static
) -> Self
pub fn supergraph_hook(
self,
callback: impl Fn(BoxService) -> BoxService + Send + Sync + 'static
) -> Self
Adds a callback-based hook similar to Plugin::supergraph_service
sourcepub fn execution_hook(
self,
callback: impl Fn(BoxService) -> BoxService + Send + Sync + 'static
) -> Self
pub fn execution_hook(
self,
callback: impl Fn(BoxService) -> BoxService + Send + Sync + 'static
) -> Self
Adds a callback-based hook similar to Plugin::execution_service
sourcepub fn subgraph_hook(
self,
callback: impl Fn(&str, BoxService) -> BoxService + Send + Sync + 'static
) -> Self
pub fn subgraph_hook(
self,
callback: impl Fn(&str, BoxService) -> BoxService + Send + Sync + 'static
) -> Self
Adds a callback-based hook similar to Plugin::subgraph_service
sourcepub fn with_subgraph_network_requests(self) -> Self
pub fn with_subgraph_network_requests(self) -> Self
Enables this test harness to make network requests to subgraphs.
If this is not called, all subgraph requests get an empty response by default
(unless schema
is also not called).
This behavior can be changed by implementing Plugin::subgraph_service
on a plugin given to extra_plugin
.
sourcepub async fn build(self) -> Result<BoxCloneService, BoxError>
๐Deprecated: use build_supergraph instead
pub async fn build(self) -> Result<BoxCloneService, BoxError>
Builds the supergraph service
sourcepub async fn build_supergraph(self) -> Result<BoxCloneService, BoxError>
pub async fn build_supergraph(self) -> Result<BoxCloneService, BoxError>
Builds the supergraph service
sourcepub async fn build_router(self) -> Result<BoxCloneService, BoxError>
pub async fn build_router(self) -> Result<BoxCloneService, BoxError>
Builds the router service
Auto Trait Implementationsยง
impl<'a> !RefUnwindSafe for TestHarness<'a>
impl<'a> Send for TestHarness<'a>
impl<'a> Sync for TestHarness<'a>
impl<'a> Unpin for TestHarness<'a>
impl<'a> !UnwindSafe for TestHarness<'a>
Blanket Implementationsยง
ยงimpl<T> FutureExt for T
impl<T> FutureExt for T
ยงfn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
ยงfn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
sourceยงimpl<T> Instrument for T
impl<T> Instrument for T
sourceยงfn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourceยงfn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceยงimpl<T> Instrument for T
impl<T> Instrument for T
sourceยงfn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourceยงfn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceยงimpl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
sourceยงfn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
ยงimpl<D> OwoColorize for D
impl<D> OwoColorize for D
ยงfn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
ยงfn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
ยงfn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>
fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>
ยงfn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>
fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>
ยงfn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
ยงfn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
ยงfn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>
fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>
ยงfn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>
fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>
ยงfn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>
fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>
ยงfn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>
fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>
ยงfn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>
fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>
ยงfn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>
fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>
ยงfn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>
fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>
ยงfn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>
fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>
ยงfn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>
fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>
ยงfn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>
fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>
ยงfn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>
fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>
ยงfn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>
fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>
ยงfn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
ยงfn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
ยงfn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
ยงfn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
ยงfn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>
fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>
ยงfn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>
fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>
ยงfn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>
fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>
ยงfn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>
fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>
ยงfn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>
fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>
ยงfn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>
fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>
ยงfn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::fg
or
a color-specific method, such as OwoColorize::green
, Read moreยงfn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::bg
or
a color-specific method, such as OwoColorize::on_yellow
, Read more