Skip to main content

E2eConfig

Struct E2eConfig 

Source
pub struct E2eConfig {
Show 13 fields pub fixtures: String, pub output: String, pub languages: Vec<String>, pub call: CallConfig, pub calls: HashMap<String, CallConfig>, pub packages: HashMap<String, PackageRef>, pub format: HashMap<String, String>, pub fields: HashMap<String, String>, pub fields_optional: HashSet<String>, pub fields_array: HashSet<String>, pub result_fields: HashSet<String>, pub fields_c_types: HashMap<String, String>, pub fields_enum: HashSet<String>,
}
Expand description

Root e2e configuration from [e2e] section of alef.toml.

Fields§

§fixtures: String

Directory containing fixture JSON files (default: “fixtures”).

§output: String

Output directory for generated e2e test projects (default: “e2e”).

§languages: Vec<String>

Languages to generate e2e tests for. Defaults to top-level languages list.

§call: CallConfig

Default function call configuration.

§calls: HashMap<String, CallConfig>

Named additional call configurations for multi-function testing. Fixtures reference these via the call field, e.g. "call": "embed".

§packages: HashMap<String, PackageRef>

Per-language package reference overrides.

§format: HashMap<String, String>

Per-language formatter commands.

§fields: HashMap<String, String>

Field path aliases: maps fixture field paths to actual API struct paths. E.g., “metadata.title” -> “metadata.document.title” Supports struct access (foo.bar), map access (foo[key]), direct fields.

§fields_optional: HashSet<String>

Fields that are Optional/nullable in the return type. Rust generators use .as_deref().unwrap_or(“”) for strings, .is_some() for structs.

§fields_array: HashSet<String>

Fields that are arrays/Vecs on the result type. When a fixture path like json_ld.name traverses an array field, the accessor adds [0] (or language equivalent) to index into the first element.

§result_fields: HashSet<String>

Known top-level fields on the result type.

When non-empty, assertions whose resolved field path starts with a segment that is NOT in this set are emitted as comments (skipped) instead of executable assertions. This prevents broken assertions when fixtures reference fields from a different operation (e.g., batch.completed_count on a ScrapeResult).

§fields_c_types: HashMap<String, String>

C FFI accessor type chain: maps "{parent_snake_type}.{field}" to the PascalCase return type name (without prefix).

Used by the C e2e generator to emit chained FFI accessor calls for nested field paths. The root type is always conversion_result.

Example:

[e2e.fields_c_types]
"conversion_result.metadata" = "HtmlMetadata"
"html_metadata.document" = "DocumentMetadata"
§fields_enum: HashSet<String>

Fields whose resolved type is an enum in the generated bindings.

When a contains / contains_all / etc. assertion targets one of these fields, language generators that cannot call .contains() directly on an enum (e.g., Java) will emit a string-conversion call first. For Java, the generated assertion calls .getValue() on the enum — the @JsonValue method that all alef-generated Java enums expose — to obtain the lowercase serde string before performing the string comparison.

Both the raw fixture field path (before alias resolution) and the resolved path (after alias resolution via [e2e.fields]) are accepted, so you can use either form:

# Raw fixture field:
fields_enum = ["links[].link_type", "assets[].category"]
# …or the resolved (aliased) field name:
fields_enum = ["links[].link_type", "assets[].asset_category"]

Implementations§

Source§

impl E2eConfig

Source

pub fn resolve_call(&self, call_name: Option<&str>) -> &CallConfig

Resolve the call config for a fixture. Uses the named call if specified, otherwise falls back to the default [e2e.call].

Trait Implementations§

Source§

impl Clone for E2eConfig

Source§

fn clone(&self) -> E2eConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for E2eConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for E2eConfig

Source§

fn default() -> E2eConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for E2eConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for E2eConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,