ocpi_tariffs/

price.rs

//! Price a CDR using a tariff and compare the prices embedded in the CDR with the prices computed here.

mod tariff;
mod v211;
mod v221;

use std::{borrow::Cow, collections::BTreeMap, fmt, ops::Range};

use chrono::{DateTime, Datelike, TimeDelta, Utc};
use chrono_tz::Tz;
use rust_decimal::Decimal;
use tracing::{debug, error, instrument, trace};

use crate::{
    country, currency, datetime,
    duration::{self, Hms},
    from_warning_all, into_caveat_all,
    json::{self, FromJson as _},
    money,
    number::{self, FromDecimal, TruncateDecimal},
    string,
    warning::{
        self, GatherWarningKinds as _, GatherWarnings, IntoCaveat, IntoCaveatDeferred as _,
        WithElement as _,
    },
    weekday, Ampere, Caveat, Cost, DisplayOption, Kw, Kwh, Money, ParseError, Price,
    SaturatingAdd as _, SaturatingSub as _, VatApplicable, VerdictExt as _, Version,
    Versioned as _,
};

use tariff::Tariff;

type Verdict<T> = crate::Verdict<T, WarningKind>;
type VerdictDeferred<T> = warning::VerdictDeferred<T, WarningKind>;

into_caveat_all!(PeriodNormalized, PeriodsReport, Report);

/// A normalized/expanded form of a charging period to make the pricing calculation simpler.
///
/// The simplicity comes through avoiding having to look up the next period to figure out the end
/// of the current period.
#[derive(Debug)]
struct PeriodNormalized {
    /// The set of quantities consumed across the duration of the `Period`.
    consumed: Consumed,

    /// A snapshot of the values of various quantities at the start of the charge period.
    start_snapshot: TotalsSnapshot,

    /// A snapshot of the values of various quantities at the end of the charge period.
    end_snapshot: TotalsSnapshot,
}

/// The set of quantities consumed across the duration of the `Period`.
#[derive(Clone, Debug)]
#[cfg_attr(test, derive(Default))]
pub(crate) struct Consumed {
    /// The peak current during this period.
    pub current_max: Option<Ampere>,

    /// The lowest current during this period.
    pub current_min: Option<Ampere>,

    /// The charging time consumed in this period.
    pub duration_charging: Option<TimeDelta>,

    /// The parking time consumed in this period.
    pub duration_parking: Option<TimeDelta>,

    /// The energy consumed in this period.
    pub energy: Option<Kwh>,

    /// The maximum power reached during this period.
    pub power_max: Option<Kw>,

    /// The minimum power reached during this period.
    pub power_min: Option<Kw>,
}

/// A snapshot of the values of various quantities at the start and end of the charge period.
#[derive(Clone, Debug)]
struct TotalsSnapshot {
    /// The `DateTime` this snapshot of total quantities was taken.
    date_time: DateTime<Utc>,

    /// The total energy consumed during a charging period.
    energy: Kwh,

    /// The local timezone.
    local_timezone: Tz,

    /// The total charging duration during a charging period.
    duration_charging: TimeDelta,

    /// The total period duration during a charging period.
    duration_total: TimeDelta,
}

impl TotalsSnapshot {
    /// Create a snapshot where all quantities are zero.
    fn zero(date_time: DateTime<Utc>, local_timezone: Tz) -> Self {
        Self {
            date_time,
            energy: Kwh::zero(),
            local_timezone,
            duration_charging: TimeDelta::zero(),
            duration_total: TimeDelta::zero(),
        }
    }

    /// Create a new snapshot based on the current snapshot with consumed quantities added.
    fn next(&self, consumed: &Consumed, date_time: DateTime<Utc>) -> Self {
        let duration = date_time.signed_duration_since(self.date_time);

        let mut next = Self {
            date_time,
            energy: self.energy,
            local_timezone: self.local_timezone,
            duration_charging: self.duration_charging,
            duration_total: self
                .duration_total
                .checked_add(&duration)
                .unwrap_or(TimeDelta::MAX),
        };

        if let Some(duration) = consumed.duration_charging {
            next.duration_charging = next
                .duration_charging
                .checked_add(&duration)
                .unwrap_or(TimeDelta::MAX);
        }

        if let Some(energy) = consumed.energy {
            next.energy = next.energy.saturating_add(energy);
        }

        next
    }

    /// Return the local time of this snapshot.
    fn local_time(&self) -> chrono::NaiveTime {
        self.date_time.with_timezone(&self.local_timezone).time()
    }

    /// Return the local date of this snapshot.
    fn local_date(&self) -> chrono::NaiveDate {
        self.date_time
            .with_timezone(&self.local_timezone)
            .date_naive()
    }

    /// Return the local `Weekday` of this snapshot.
    fn local_weekday(&self) -> chrono::Weekday {
        self.date_time.with_timezone(&self.local_timezone).weekday()
    }
}

/// Structure containing the charge session priced according to the specified tariff.
/// The fields prefixed `total` correspond to CDR fields with the same name.
#[derive(Debug)]
pub struct Report {
    /// Charge session details per period.
    pub periods: Vec<PeriodReport>,

    /// The index of the tariff that was used for pricing.
    pub tariff_used: TariffOrigin,

    /// A list of reports for each tariff found in the CDR or supplied to the [`cdr::price`](crate::cdr::price) function.
    ///
    /// The order of the `tariff::Report`s are the same as the order in which they are given.
    pub tariff_reports: Vec<TariffReport>,

    /// Time-zone that was either specified or detected.
    pub timezone: String,

    /* Billed Quantities */
    /// The total charging time after applying step-size.
    pub billed_charging_time: Option<TimeDelta>,

    /// The total energy after applying step-size.
    pub billed_energy: Option<Kwh>,

    /// The total parking time after applying step-size
    pub billed_parking_time: Option<TimeDelta>,

    /* Totals */
    /// Total duration of the charging session (excluding not charging), in hours.
    ///
    /// This is a total that has no direct source field in the `CDR` as it is calculated in the
    /// [`cdr::price`](crate::cdr::price) function.
    pub total_charging_time: Option<TimeDelta>,

    /// Total energy charged, in kWh.
    pub total_energy: Total<Kwh, Option<Kwh>>,

    /// Total duration of the charging session where the EV was not charging (no energy was transferred between EVSE and EV).
    pub total_parking_time: Total<Option<TimeDelta>>,

    /// Total duration of the charging session (including the duration of charging and not charging).
    pub total_time: Total<TimeDelta>,

    /* Costs */
    /// Total sum of all the costs of this transaction in the specified currency.
    pub total_cost: Total<Price, Option<Price>>,

    /// Total sum of all the cost of all the energy used, in the specified currency.
    pub total_energy_cost: Total<Option<Price>>,

    /// Total sum of all the fixed costs in the specified currency, except fixed price components of parking and reservation. The cost not depending on amount of time/energy used etc. Can contain costs like a start tariff.
    pub total_fixed_cost: Total<Option<Price>>,

    /// Total sum of all the cost related to parking of this transaction, including fixed price components, in the specified currency.
    pub total_parking_cost: Total<Option<Price>>,

    /// Total sum of all the cost related to a reservation of a Charge Point, including fixed price components, in the specified currency.
    pub total_reservation_cost: Total<Option<Price>>,

    /// Total sum of all the cost related to duration of charging during this transaction, in the specified currency.
    pub total_time_cost: Total<Option<Price>>,
}

/// The warnings that happen when pricing a CDR.
#[derive(Debug)]
pub enum WarningKind {
    Country(country::WarningKind),
    Currency(currency::WarningKind),
    DateTime(datetime::WarningKind),
    Decode(json::decode::WarningKind),
    Duration(duration::WarningKind),

    /// The `$.country` field should be an alpha-2 country code.
    ///
    /// The alpha-3 code can be converted into an alpha-3 but the caller should be warned.
    CountryShouldBeAlpha2,

    /// The given dimension should have a volume
    DimensionShouldHaveVolume {
        dimension_name: &'static str,
    },

    /// A field in the tariff doesn't have the expected type.
    FieldInvalidType {
        /// The type that the given field should have according to the schema.
        expected_type: json::ValueKind,
    },

    /// A field in the tariff doesn't have the expected value.
    FieldInvalidValue {
        /// The value encountered.
        value: String,

        /// A message about what values are expected for this field.
        message: Cow<'static, str>,
    },

    /// The given field is required.
    FieldRequired {
        field_name: Cow<'static, str>,
    },

    /// An internal error occurred.
    ///
    /// The details are logged using debug level.
    InternalError,

    Money(money::WarningKind),

    /// The CDR has no charging periods.
    NoPeriods,

    /// No valid tariff has been found in the list of provided tariffs.
    /// The tariff list can be sourced from either the tariffs contained in the CDR or from a list
    /// provided by the caller.
    ///
    /// A valid tariff must have a start date-time before the start of the session and an end
    /// date-time after the start of the session.
    ///
    /// If the CDR does not contain any tariffs consider providing a them using [`TariffSource`]
    /// when calling [`cdr::price`](crate::cdr::price).
    NoValidTariff,

    Number(number::WarningKind),

    /// An error occurred while deserializing a `CDR` or tariff.
    Parse(ParseError),

    /// The `start_date_time` of at least one of the `charging_periods` is outside of the
    /// CDR's `start_date_time`-`end_date_time` range.
    PeriodsOutsideStartEndDateTime {
        cdr_range: Range<DateTime<Utc>>,
        period_range: PeriodRange,
    },

    String(string::WarningKind),

    /// Converting the `tariff::Versioned` into a structured `tariff::v221::Tariff` caused an
    /// unrecoverable error.
    Tariff(crate::tariff::WarningKind),

    Weekday(weekday::WarningKind),
}

impl WarningKind {
    /// Create a new `WarningKind::FieldInvalidValue` where the field is built from the given `json::Element`.
    fn field_invalid_value(
        value: impl Into<String>,
        message: impl Into<Cow<'static, str>>,
    ) -> Self {
        WarningKind::FieldInvalidValue {
            value: value.into(),
            message: message.into(),
        }
    }
}

impl fmt::Display for WarningKind {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Country(warning_kind) => write!(f, "{warning_kind}"),
            Self::CountryShouldBeAlpha2 => {
                f.write_str("The `$.country` field should be an alpha-2 country code.")
            }
            Self::Currency(warning_kind) => write!(f, "{warning_kind}"),
            Self::DateTime(warning_kind) => write!(f, "{warning_kind}"),
            Self::Decode(warning_kind) => write!(f, "{warning_kind}"),
            Self::DimensionShouldHaveVolume { dimension_name } => {
                write!(f, "Dimension `{dimension_name}` should have volume")
            }
            Self::Duration(warning_kind) => write!(f, "{warning_kind}"),
            Self::FieldInvalidType { expected_type } => {
                write!(f, "Field has invalid type. Expected type `{expected_type}`")
            }
            Self::FieldInvalidValue { value, message } => {
                write!(f, "Field has invalid value `{value}`: {message}")
            }
            Self::FieldRequired { field_name } => {
                write!(f, "Field is required: `{field_name}`")
            }
            Self::InternalError => f.write_str("Internal error"),
            Self::Money(warning_kind) => write!(f, "{warning_kind}"),
            Self::NoPeriods => f.write_str("The CDR has no charging periods"),
            Self::NoValidTariff => {
                f.write_str("No valid tariff has been found in the list of provided tariffs")
            }
            Self::Number(warning_kind) => write!(f, "{warning_kind}"),
            Self::Parse(err) => {
                write!(f, "{err}")
            }
            Self::PeriodsOutsideStartEndDateTime {
                cdr_range: Range { start, end },
                period_range,
            } => {
                write!(
                    f,
                    "The CDR's charging period time range is not contained within the `start_date_time` \
                    and `end_date_time`; cdr_range: {start}-{end}, period_range: {period_range}",
                )
            }
            Self::String(warning_kind) => write!(f, "{warning_kind}"),
            Self::Tariff(warnings) => {
                write!(f, "Tariff warnings: {warnings:?}")
            }
            Self::Weekday(warning_kind) => write!(f, "{warning_kind}"),
        }
    }
}

impl warning::Kind for WarningKind {
    fn id(&self) -> Cow<'static, str> {
        match self {
            Self::Country(kind) => kind.id(),
            Self::CountryShouldBeAlpha2 => "country_should_be_alpha_2".into(),
            Self::Currency(kind) => kind.id(),
            Self::DateTime(kind) => kind.id(),
            Self::Decode(kind) => kind.id(),
            Self::DimensionShouldHaveVolume { dimension_name } => {
                format!("dimension_should_have_volume({dimension_name})").into()
            }
            Self::Duration(kind) => kind.id(),
            Self::FieldInvalidType { .. } => "field_invalid_type".into(),
            Self::FieldInvalidValue { .. } => "field_invalid_value".into(),
            Self::FieldRequired { field_name } => format!("field_required({field_name})").into(),
            Self::InternalError => "internal_error".into(),
            Self::Money(kind) => kind.id(),
            Self::NoPeriods => "no_periods".into(),
            Self::NoValidTariff => "no_valid_tariff".into(),
            Self::Number(kind) => kind.id(),
            Self::Parse(ParseError { object: _, kind }) => {
                format!("parse_error.{}", kind.id()).into()
            }
            Self::PeriodsOutsideStartEndDateTime { .. } => {
                "periods_outside_start_end_date_time".into()
            }
            Self::String(kind) => kind.id(),
            Self::Tariff(kind) => kind.id(),
            Self::Weekday(kind) => kind.id(),
        }
    }
}

from_warning_all!(
    country::WarningKind => WarningKind::Country,
    currency::WarningKind => WarningKind::Currency,
    datetime::WarningKind => WarningKind::DateTime,
    duration::WarningKind => WarningKind::Duration,
    json::decode::WarningKind => WarningKind::Decode,
    money::WarningKind => WarningKind::Money,
    number::WarningKind => WarningKind::Number,
    string::WarningKind => WarningKind::String,
    crate::tariff::WarningKind => WarningKind::Tariff,
    weekday::WarningKind => WarningKind::Weekday
);

/// A report of parsing and using the referenced tariff to price a CDR.
#[derive(Debug)]
pub struct TariffReport {
    /// The id of the tariff.
    pub origin: TariffOrigin,

    /// Warnings from parsing a tariff.
    ///
    /// Each entry in the map is an element path and a list of associated warnings.
    pub warnings: BTreeMap<String, Vec<crate::tariff::WarningKind>>,
}

/// The origin data for a tariff.
#[derive(Clone, Debug)]
pub struct TariffOrigin {
    /// The index of the tariff in the CDR JSON or in the list of override tariffs.
    pub index: usize,

    /// The value of the `id` field in the tariff JSON.
    pub id: String,
}

/// A CDR charge period in a normalized form ready for pricing.
#[derive(Debug)]
pub(crate) struct Period {
    /// The start time of this period.
    pub start_date_time: DateTime<Utc>,

    /// The quantities consumed during this period.
    pub consumed: Consumed,
}

/// A structure containing a report for each dimension.
#[derive(Debug)]
pub struct Dimensions {
    /// Energy consumed.
    pub energy: Dimension<Kwh>,

    /// Flat fee without unit for `step_size`.
    pub flat: Dimension<()>,

    /// Duration of time charging.
    pub duration_charging: Dimension<TimeDelta>,

    /// Duration of time not charging.
    pub duration_parking: Dimension<TimeDelta>,
}

impl Dimensions {
    fn new(components: ComponentSet, consumed: &Consumed) -> Self {
        let ComponentSet {
            energy: energy_price,
            flat: flat_price,
            duration_charging: duration_charging_price,
            duration_parking: duration_parking_price,
        } = components;

        let Consumed {
            duration_charging,
            duration_parking,
            energy,
            current_max: _,
            current_min: _,
            power_max: _,
            power_min: _,
        } = consumed;

        Self {
            energy: Dimension {
                price: energy_price,
                volume: *energy,
                billed_volume: *energy,
            },
            flat: Dimension {
                price: flat_price,
                volume: Some(()),
                billed_volume: Some(()),
            },
            duration_charging: Dimension {
                price: duration_charging_price,
                volume: *duration_charging,
                billed_volume: *duration_charging,
            },
            duration_parking: Dimension {
                price: duration_parking_price,
                volume: *duration_parking,
                billed_volume: *duration_parking,
            },
        }
    }
}

#[derive(Debug)]
/// A report for a single dimension during a single period.
pub struct Dimension<V> {
    /// The price component that was active during this period for this dimension.
    /// It could be that no price component was active during this period for this dimension in
    /// which case `price` is `None`.
    pub price: Option<Component>,

    /// The volume of this dimension during this period, as received in the provided charge detail record.
    /// It could be that no volume was provided during this period for this dimension in which case
    /// the `volume` is `None`.
    pub volume: Option<V>,

    /// This field contains the optional value of `volume` after a potential step size was applied.
    /// Step size is applied over the total volume during the whole session of a dimension. But the
    /// resulting additional volume should be billed according to the price component in this
    /// period.
    ///
    /// If no step-size was applied for this period, the volume is exactly equal to the `volume`
    /// field.
    pub billed_volume: Option<V>,
}

impl<V: Cost> Dimension<V> {
    /// The total cost of this dimension during a period.
    pub fn cost(&self) -> Option<Price> {
        let (Some(volume), Some(price_component)) = (&self.billed_volume, &self.price) else {
            return None;
        };

        let excl_vat = volume.cost(Money::from_decimal(price_component.price));

        let incl_vat = match price_component.vat {
            VatApplicable::Applicable(vat) => Some(excl_vat.apply_vat(vat)),
            VatApplicable::Inapplicable => Some(excl_vat),
            VatApplicable::Unknown => None,
        };

        Some(Price { excl_vat, incl_vat })
    }
}

/// A set of price `Component`s, one for each dimension.
///
/// See: <https://github.com/ocpi/ocpi/blob/release-2.2.1-bugfixes/mod_tariffs.asciidoc#142-pricecomponent-class>
/// See: <https://github.com/ocpi/ocpi/blob/release-2.2.1-bugfixes/mod_tariffs.asciidoc#145-tariffdimensiontype-enum>
#[derive(Debug)]
pub struct ComponentSet {
    /// Energy consumed.
    pub energy: Option<Component>,

    /// Flat fee without unit for `step_size`.
    pub flat: Option<Component>,

    /// Duration of time charging.
    pub duration_charging: Option<Component>,

    /// Duration of time not charging.
    pub duration_parking: Option<Component>,
}

impl ComponentSet {
    /// Returns true if all components are `Some`.
    fn has_all_components(&self) -> bool {
        let Self {
            energy,
            flat,
            duration_charging,
            duration_parking,
        } = self;

        flat.is_some()
            && energy.is_some()
            && duration_parking.is_some()
            && duration_charging.is_some()
    }
}

/// A Price Component describes how a certain amount of a certain dimension being consumed
/// translates into an amount of money owed.
///
/// See: <https://github.com/ocpi/ocpi/blob/release-2.2.1-bugfixes/mod_tariffs.asciidoc#142-pricecomponent-class>
#[derive(Clone, Debug)]
pub struct Component {
    /// The index of the tariff this `Component` lives in.
    pub tariff_element_index: usize,

    /// Price per unit (excl. VAT) for this dimension.
    pub price: Decimal,

    /// Applicable VAT percentage for this tariff dimension. If omitted, no VAT is applicable.
    /// Not providing a VAT is different from 0% VAT, which would be a value of 0.0 here.
    pub vat: VatApplicable,

    /// Minimum amount to be billed. That is, the dimension will be billed in this `step_size` blocks.
    /// Consumed amounts are rounded up to the smallest multiple of `step_size` that is greater than
    /// the consumed amount.
    ///
    /// For example: if type is TIME and `step_size` has a value of 300, then time will be billed in
    /// blocks of 5 minutes. If 6 minutes were consumed, 10 minutes (2 blocks of `step_size`) will
    /// be billed.
    pub step_size: u64,
}

impl Component {
    fn new(component: &crate::tariff::v221::PriceComponent, tariff_element_index: usize) -> Self {
        let crate::tariff::v221::PriceComponent {
            price,
            vat,
            step_size,
            dimension_type: _,
        } = component;

        Self {
            tariff_element_index,
            price: *price,
            vat: *vat,
            step_size: *step_size,
        }
    }
}

/// A related source and calculated pair of total amounts.
///
/// This is used to express the source and calculated amounts for the total fields of a `CDR`.
///
/// - `total_cost`
/// - `total_fixed_cost`
/// - `total_energy`
/// - `total_energy_cost`
/// - `total_time`
/// - `total_time_cost`
/// - `total_parking_time`
/// - `total_parking_cost`
/// - `total_reservation_cost`
#[derive(Debug)]
pub struct Total<TCdr, TCalc = TCdr> {
    /// The source value from the `CDR`.
    pub cdr: TCdr,

    /// The value calculated by the [`cdr::price`](crate::cdr::price) function.
    pub calculated: TCalc,
}

/// The range of time the CDR periods span.
#[derive(Debug)]
pub enum PeriodRange {
    /// There are many periods in the CDR and so the range is from the `start_date_time` of the first to
    /// the `start_date_time` of the last.
    Many(Range<DateTime<Utc>>),

    /// There is one period in the CDR and so one `start_date_time`.
    Single(DateTime<Utc>),
}

impl fmt::Display for PeriodRange {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            PeriodRange::Many(Range { start, end }) => write!(f, "{start}-{end}"),
            PeriodRange::Single(date_time) => write!(f, "{date_time}"),
        }
    }
}

/// Where should the tariffs come from when pricing a `CDR`.
///
/// Used with [`cdr::price`](crate::cdr::price).
#[derive(Debug)]
pub enum TariffSource<'buf> {
    /// Use the tariffs from the `CDR`.
    UseCdr,

    /// Ignore the tariffs from the `CDR` and use these instead
    Override(Vec<crate::tariff::Versioned<'buf>>),
}

impl<'buf> TariffSource<'buf> {
    /// Convenience method to provide a single override tariff.
    pub fn single(tariff: crate::tariff::Versioned<'buf>) -> Self {
        Self::Override(vec![tariff])
    }
}

#[instrument(skip_all)]
pub(super) fn cdr(
    cdr_elem: &crate::cdr::Versioned<'_>,
    tariff_source: TariffSource<'_>,
    timezone: Tz,
) -> Verdict<Report> {
    let cdr = parse_cdr(cdr_elem)?;

    match tariff_source {
        TariffSource::UseCdr => {
            let (v221::cdr::WithTariffs { cdr, tariffs }, warnings) = cdr.into_parts();
            debug!("Using tariffs from CDR");
            let tariffs = tariffs
                .iter()
                .map(|elem| {
                    let tariff = crate::tariff::v211::Tariff::from_json(elem);
                    tariff.map_caveat(crate::tariff::v221::Tariff::from)
                })
                .collect::<Result<Vec<_>, _>>()?;

            let cdr = cdr.into_caveat(warnings);

            Ok(price_v221_cdr_with_tariffs(
                cdr_elem, cdr, tariffs, timezone,
            )?)
        }
        TariffSource::Override(tariffs) => {
            let cdr = cdr.map(v221::cdr::WithTariffs::discard_tariffs);

            debug!("Using override tariffs");
            let tariffs = tariffs
                .iter()
                .map(tariff::parse)
                .collect::<Result<Vec<_>, _>>()?;

            Ok(price_v221_cdr_with_tariffs(
                cdr_elem, cdr, tariffs, timezone,
            )?)
        }
    }
}

/// Price a single charge-session using a tariff selected from a list.
///
/// Returns a report containing the totals, subtotals, and a breakdown of the calculation.
/// Price a single charge-session using a single tariff.
///
/// Returns a report containing the totals, subtotals, and a breakdown of the calculation.
fn price_v221_cdr_with_tariffs(
    cdr_elem: &crate::cdr::Versioned<'_>,
    cdr: Caveat<v221::Cdr, WarningKind>,
    tariffs: Vec<Caveat<crate::tariff::v221::Tariff<'_>, crate::tariff::WarningKind>>,
    timezone: Tz,
) -> Verdict<Report> {
    debug!(?timezone, version = ?cdr_elem.version(), "Pricing CDR");
    let (cdr, mut warnings) = cdr.into_parts();

    // Convert each versioned tariff JSON to a structured tariff.
    //
    // This generates a list of `TariffReport`s that are returned to the caller in the `Report`.
    // One of the structured tariffs is selected for use in the `price_periods` function.
    let (tariff_reports, tariffs): (Vec<_>, Vec<_>) = tariffs
        .into_iter()
        .enumerate()
        .map(|(index, tariff)| {
            let (tariff, warnings) = tariff.into_parts();
            (
                TariffReport {
                    origin: TariffOrigin {
                        index,
                        id: tariff.id.to_string(),
                    },
                    warnings: warnings
                        .into_group_by_elem(cdr_elem.as_element())
                        .into_kind_map(),
                },
                tariff,
            )
        })
        .unzip();

    debug!(tariffs = ?tariffs.iter().map(|t| t.id).collect::<Vec<_>>(), "Found tariffs(by id) in CDR");

    let tariffs_normalized = tariff::normalize_all(&tariffs);
    let Some((tariff_index, tariff)) =
        tariff::find_first_active(tariffs_normalized, cdr.start_date_time)
    else {
        return warnings.bail(WarningKind::NoValidTariff, cdr_elem.as_element());
    };

    debug!(tariff_index, id = ?tariff.id(), "Found active tariff");
    debug!(%timezone, "Found timezone");

    let cs_periods = v221::cdr::normalize_periods(&cdr, timezone)
        .with_element(cdr_elem.as_element())?
        .gather_warnings_into(&mut warnings);
    let price_cdr_report = price_periods(&cs_periods, &tariff)
        .with_element(cdr_elem.as_element())?
        .gather_warnings_into(&mut warnings);

    let report = generate_report(
        &cdr,
        timezone,
        tariff_reports,
        price_cdr_report,
        TariffOrigin {
            index: tariff_index,
            id: tariff.id().to_string(),
        },
    );

    Ok(report.into_caveat(warnings))
}

/// Price a list of normalized [`Period`]s using a [`Versioned`](crate::tariff::Versioned) tariff.
pub(crate) fn periods(
    end_date_time: DateTime<Utc>,
    timezone: Tz,
    tariff_elem: &crate::tariff::v221::Tariff<'_>,
    periods: &mut [Period],
) -> VerdictDeferred<PeriodsReport> {
    // Make sure the periods are sorted by time as the start date of one period determines the end
    // date of the previous period.
    periods.sort_by_key(|p| p.start_date_time);
    let mut out_periods = Vec::<PeriodNormalized>::new();

    for (index, period) in periods.iter().enumerate() {
        trace!(index, "processing\n{period:#?}");

        let next_index = index + 1;

        let end_date_time = if let Some(next_period) = periods.get(next_index) {
            next_period.start_date_time
        } else {
            end_date_time
        };

        let next = if let Some(last) = out_periods.last() {
            let start_snapshot = last.end_snapshot.clone();
            let end_snapshot = start_snapshot.next(&period.consumed, end_date_time);

            let period = PeriodNormalized {
                consumed: period.consumed.clone(),
                start_snapshot,
                end_snapshot,
            };
            trace!("Adding new period based on the last added\n{period:#?}\n{last:#?}");
            period
        } else {
            let start_snapshot = TotalsSnapshot::zero(period.start_date_time, timezone);
            let end_snapshot = start_snapshot.next(&period.consumed, end_date_time);

            let period = PeriodNormalized {
                consumed: period.consumed.clone(),
                start_snapshot,
                end_snapshot,
            };
            trace!("Adding new period\n{period:#?}");
            period
        };

        out_periods.push(next);
    }

    let tariff = Tariff::from_v221(tariff_elem);
    price_periods(&out_periods, &tariff)
}

/// Price the given set of CDR periods using a normalized `Tariff`.
fn price_periods(periods: &[PeriodNormalized], tariff: &Tariff) -> VerdictDeferred<PeriodsReport> {
    debug!(count = periods.len(), "Pricing CDR periods");

    if tracing::enabled!(tracing::Level::TRACE) {
        trace!("# CDR period list:");
        for period in periods {
            trace!("{period:#?}");
        }
    }

    let period_totals = period_totals(periods, tariff);
    let (billed, warnings) = period_totals.calculate_billed()?.into_parts();
    let (billable, periods, totals) = billed;
    let total_costs = total_costs(&periods, tariff);
    let report = PeriodsReport {
        billable,
        periods,
        totals,
        total_costs,
    };

    Ok(report.into_caveat_deferred(warnings))
}

/// The internal report generated from the [`periods`] fn.
pub(crate) struct PeriodsReport {
    /// The billable dimensions calculated by applying the step-size to each dimension.
    pub billable: Billable,

    /// A list of reports for each charging period that occurred during a session.
    pub periods: Vec<PeriodReport>,

    /// The totals for each dimension.
    pub totals: Totals,

    /// The total costs for each dimension.
    pub total_costs: TotalCosts,
}

/// A report for a single charging period that occurred during a session.
///
/// A charging period is a period of time that has relevance for the total costs of a CDR.
/// During a charging session, different parameters change all the time, like the amount of energy used,
/// or the time of day. These changes can result in another [`PriceComponent`](https://github.com/ocpi/ocpi/blob/release-2.2.1-bugfixes/mod_tariffs.asciidoc#142-pricecomponent-class) of the Tariff becoming active.
#[derive(Debug)]
pub struct PeriodReport {
    /// The start time of this period.
    pub start_date_time: DateTime<Utc>,

    /// The end time of this period.
    pub end_date_time: DateTime<Utc>,

    /// A structure that contains results per dimension.
    pub dimensions: Dimensions,
}

impl PeriodReport {
    fn new(period: &PeriodNormalized, dimensions: Dimensions) -> Self {
        Self {
            start_date_time: period.start_snapshot.date_time,
            end_date_time: period.end_snapshot.date_time,
            dimensions,
        }
    }

    /// The total cost of all dimensions in this period.
    pub fn cost(&self) -> Option<Price> {
        [
            self.dimensions.duration_charging.cost(),
            self.dimensions.duration_parking.cost(),
            self.dimensions.flat.cost(),
            self.dimensions.energy.cost(),
        ]
        .into_iter()
        .fold(None, |accum, next| {
            if accum.is_none() && next.is_none() {
                None
            } else {
                Some(
                    accum
                        .unwrap_or_default()
                        .saturating_add(next.unwrap_or_default()),
                )
            }
        })
    }
}

/// The result of normalizing the CDR charging periods.
#[derive(Debug)]
struct PeriodTotals {
    /// The list of normalized periods.
    periods: Vec<PeriodReport>,

    /// The computed step size.
    step_size: StepSize,

    /// The totals for each dimension.
    totals: Totals,
}

/// The totals for each dimension.
#[derive(Debug, Default)]
pub(crate) struct Totals {
    /// The total energy used during a session.
    pub energy: Option<Kwh>,

    /// The total charging time used during a session.
    pub duration_charging: Option<TimeDelta>,

    /// The total parking time used during a session.
    pub duration_parking: Option<TimeDelta>,
}

impl PeriodTotals {
    /// Calculate the billed dimensions by applying the step-size to each dimension.
    ///
    /// Applying the step size can mutate the dimension values contained in the `Period`.
    fn calculate_billed(self) -> VerdictDeferred<(Billable, Vec<PeriodReport>, Totals)> {
        let mut warnings = warning::SetDeferred::new();
        let Self {
            mut periods,
            step_size,
            totals,
        } = self;
        let charging_time = totals
            .duration_charging
            .map(|dt| step_size.apply_time(&mut periods, dt))
            .transpose()?
            .gather_warning_kinds_into(&mut warnings);
        let energy = totals
            .energy
            .map(|kwh| step_size.apply_energy(&mut periods, kwh))
            .transpose()?
            .gather_warning_kinds_into(&mut warnings);
        let parking_time = totals
            .duration_parking
            .map(|dt| step_size.apply_parking_time(&mut periods, dt))
            .transpose()?
            .gather_warning_kinds_into(&mut warnings);
        let billed = Billable {
            charging_time,
            energy,
            parking_time,
        };
        Ok((billed, periods, totals).into_caveat_deferred(warnings))
    }
}

/// The billable dimensions calculated by applying the step-size to each dimension.
#[derive(Debug)]
pub(crate) struct Billable {
    /// The billable charging time.
    charging_time: Option<TimeDelta>,

    /// The billable energy use.
    energy: Option<Kwh>,

    /// The billable parking time.
    parking_time: Option<TimeDelta>,
}

/// Map the `session::ChargePeriod`s to a normalized `Period` and calculate the step size and
/// totals for each dimension.
fn period_totals(periods: &[PeriodNormalized], tariff: &Tariff) -> PeriodTotals {
    let mut has_flat_fee = false;
    let mut step_size = StepSize::new();
    let mut totals = Totals::default();

    debug!(
        tariff_id = tariff.id(),
        period_count = periods.len(),
        "Accumulating dimension totals for each period"
    );

    let periods = periods
        .iter()
        .enumerate()
        .map(|(index, period)| {
            let mut component_set = tariff.active_components(period);
            trace!(
                index,
                "Creating charge period with Dimension\n{period:#?}\n{component_set:#?}"
            );

            if component_set.flat.is_some() {
                if has_flat_fee {
                    component_set.flat = None;
                } else {
                    has_flat_fee = true;
                }
            }

            step_size.update(index, &component_set, period);

            trace!(period_index = index, "Step size updated\n{step_size:#?}");

            let dimensions = Dimensions::new(component_set, &period.consumed);

            trace!(period_index = index, "Dimensions created\n{dimensions:#?}");

            if let Some(dt) = dimensions.duration_charging.volume {
                let acc = totals.duration_charging.get_or_insert_default();
                *acc = acc.saturating_add(dt);
            }

            if let Some(kwh) = dimensions.energy.volume {
                let acc = totals.energy.get_or_insert_default();
                *acc = acc.saturating_add(kwh);
            }

            if let Some(dt) = dimensions.duration_parking.volume {
                let acc = totals.duration_parking.get_or_insert_default();
                *acc = acc.saturating_add(dt);
            }

            trace!(period_index = index, ?totals, "Update totals");

            PeriodReport::new(period, dimensions)
        })
        .collect::<Vec<_>>();

    PeriodTotals {
        periods,
        step_size,
        totals,
    }
}

/// The total costs for each dimension.
#[derive(Debug, Default)]
pub(crate) struct TotalCosts {
    /// The [`Price`] for all energy used during a session.
    pub energy: Option<Price>,

    /// The [`Price`] for all flat rates applied during a session.
    pub fixed: Option<Price>,

    /// The [`Price`] for all charging time used during a session.
    pub duration_charging: Option<Price>,

    /// The [`Price`] for all parking time used during a session.
    pub duration_parking: Option<Price>,
}

impl TotalCosts {
    /// Summate each dimension total into a single total.
    ///
    /// Return `None` if there are no cost dimensions otherwise return `Some`.
    pub(crate) fn total(&self) -> Option<Price> {
        let Self {
            energy,
            fixed,
            duration_charging,
            duration_parking,
        } = self;
        debug!(
            energy = %DisplayOption(*energy),
            fixed = %DisplayOption(*fixed),
            duration_charging = %DisplayOption(*duration_charging),
            duration_parking = %DisplayOption(*duration_parking),
            "Calculating total costs."
        );
        [energy, fixed, duration_charging, duration_parking]
            .into_iter()
            .fold(None, |accum: Option<Price>, next| match (accum, next) {
                (None, None) => None,
                _ => Some(
                    accum
                        .unwrap_or_default()
                        .saturating_add(next.unwrap_or_default()),
                ),
            })
    }
}

/// Accumulate total costs per dimension across all periods.
fn total_costs(periods: &[PeriodReport], tariff: &Tariff) -> TotalCosts {
    let mut total_costs = TotalCosts::default();

    debug!(
        tariff_id = tariff.id(),
        period_count = periods.len(),
        "Accumulating dimension costs for each period"
    );
    for (index, period) in periods.iter().enumerate() {
        let dimensions = &period.dimensions;

        trace!(period_index = index, "Processing period");

        let energy_cost = dimensions.energy.cost();
        let fixed_cost = dimensions.flat.cost();
        let duration_charging_cost = dimensions.duration_charging.cost();
        let duration_parking_cost = dimensions.duration_parking.cost();

        trace!(?total_costs.energy, ?energy_cost, "Energy cost");
        trace!(?total_costs.duration_charging, ?duration_charging_cost, "Charging cost");
        trace!(?total_costs.duration_parking, ?duration_parking_cost, "Parking cost");
        trace!(?total_costs.fixed, ?fixed_cost, "Fixed cost");

        total_costs.energy = match (total_costs.energy, energy_cost) {
            (None, None) => None,
            (total, period) => Some(
                total
                    .unwrap_or_default()
                    .saturating_add(period.unwrap_or_default()),
            ),
        };

        total_costs.duration_charging =
            match (total_costs.duration_charging, duration_charging_cost) {
                (None, None) => None,
                (total, period) => Some(
                    total
                        .unwrap_or_default()
                        .saturating_add(period.unwrap_or_default()),
                ),
            };

        total_costs.duration_parking = match (total_costs.duration_parking, duration_parking_cost) {
            (None, None) => None,
            (total, period) => Some(
                total
                    .unwrap_or_default()
                    .saturating_add(period.unwrap_or_default()),
            ),
        };

        total_costs.fixed = match (total_costs.fixed, fixed_cost) {
            (None, None) => None,
            (total, period) => Some(
                total
                    .unwrap_or_default()
                    .saturating_add(period.unwrap_or_default()),
            ),
        };

        trace!(period_index = index, ?total_costs, "Update totals");
    }

    total_costs
}

fn generate_report(
    cdr: &v221::Cdr,
    timezone: Tz,
    tariff_reports: Vec<TariffReport>,
    price_periods_report: PeriodsReport,
    tariff_used: TariffOrigin,
) -> Report {
    let PeriodsReport {
        billable,
        periods,
        totals,
        total_costs,
    } = price_periods_report;
    trace!("Update billed totals {billable:#?}");

    let total_cost = total_costs.total();

    debug!(total_cost = %DisplayOption(total_cost.as_ref()));

    let total_time = {
        debug!(
            period_start = %DisplayOption(periods.first().map(|p| p.start_date_time)),
            period_end = %DisplayOption(periods.last().map(|p| p.end_date_time)),
            "Calculating `total_time`"
        );

        periods
            .first()
            .zip(periods.last())
            .map(|(first, last)| {
                last.end_date_time
                    .signed_duration_since(first.start_date_time)
            })
            .unwrap_or_default()
    };
    debug!(total_time = %Hms(total_time));

    let report = Report {
        periods,
        tariff_used,
        timezone: timezone.to_string(),
        billed_parking_time: billable.parking_time,
        billed_energy: billable.energy.truncate_to_ocpi_scale(),
        billed_charging_time: billable.charging_time,
        tariff_reports,
        total_charging_time: totals.duration_charging,
        total_cost: Total {
            cdr: cdr.total_cost.truncate_to_ocpi_scale(),
            calculated: total_cost.truncate_to_ocpi_scale(),
        },
        total_time_cost: Total {
            cdr: cdr.total_time_cost.truncate_to_ocpi_scale(),
            calculated: total_costs.duration_charging.truncate_to_ocpi_scale(),
        },
        total_time: Total {
            cdr: cdr.total_time,
            calculated: total_time,
        },
        total_parking_cost: Total {
            cdr: cdr.total_parking_cost.truncate_to_ocpi_scale(),
            calculated: total_costs.duration_parking.truncate_to_ocpi_scale(),
        },
        total_parking_time: Total {
            cdr: cdr.total_parking_time,
            calculated: totals.duration_parking,
        },
        total_energy_cost: Total {
            cdr: cdr.total_energy_cost.truncate_to_ocpi_scale(),
            calculated: total_costs.energy.truncate_to_ocpi_scale(),
        },
        total_energy: Total {
            cdr: cdr.total_energy.truncate_to_ocpi_scale(),
            calculated: totals.energy.truncate_to_ocpi_scale(),
        },
        total_fixed_cost: Total {
            cdr: cdr.total_fixed_cost.truncate_to_ocpi_scale(),
            calculated: total_costs.fixed.truncate_to_ocpi_scale(),
        },
        total_reservation_cost: Total {
            cdr: cdr.total_reservation_cost.truncate_to_ocpi_scale(),
            calculated: None,
        },
    };

    trace!("{report:#?}");

    report
}

#[derive(Debug)]
struct StepSize {
    charging_time: Option<(usize, Component)>,
    parking_time: Option<(usize, Component)>,
    energy: Option<(usize, Component)>,
}

/// Return the duration as a `Decimal` amount of seconds.
fn delta_as_seconds_dec(delta: TimeDelta) -> Decimal {
    Decimal::from(delta.num_milliseconds())
        .checked_div(Decimal::from(duration::MILLIS_IN_SEC))
        .expect("Can't overflow; See test `as_seconds_dec_should_not_overflow`")
}

/// Create a `HoursDecimal` from a `Decimal` amount of seconds.
fn delta_from_seconds_dec(seconds: Decimal) -> VerdictDeferred<TimeDelta> {
    let millis = seconds.saturating_mul(Decimal::from(duration::MILLIS_IN_SEC));
    let Ok(millis) = i64::try_from(millis) else {
        return Err(warning::SetDeferred::with_warn(
            duration::WarningKind::Overflow.into(),
        ));
    };
    let Some(delta) = TimeDelta::try_milliseconds(millis) else {
        return Err(warning::SetDeferred::with_warn(
            duration::WarningKind::Overflow.into(),
        ));
    };
    Ok(delta.into_caveat_deferred(warning::SetDeferred::new()))
}

impl StepSize {
    fn new() -> Self {
        Self {
            charging_time: None,
            parking_time: None,
            energy: None,
        }
    }

    fn update(&mut self, index: usize, components: &ComponentSet, period: &PeriodNormalized) {
        if period.consumed.energy.is_some() {
            if let Some(energy) = components.energy.clone() {
                self.energy = Some((index, energy));
            }
        }

        if period.consumed.duration_charging.is_some() {
            if let Some(time) = components.duration_charging.clone() {
                self.charging_time = Some((index, time));
            }
        }

        if period.consumed.duration_parking.is_some() {
            if let Some(parking) = components.duration_parking.clone() {
                self.parking_time = Some((index, parking));
            }
        }
    }

    fn duration_step_size(
        total_volume: TimeDelta,
        period_billed_volume: &mut TimeDelta,
        step_size: u64,
    ) -> VerdictDeferred<TimeDelta> {
        if step_size == 0 {
            return Ok(total_volume.into_caveat_deferred(warning::SetDeferred::new()));
        }

        let total_seconds = delta_as_seconds_dec(total_volume);
        let step_size = Decimal::from(step_size);

        let Some(x) = total_seconds.checked_div(step_size) else {
            return Err(warning::SetDeferred::with_warn(
                duration::WarningKind::Overflow.into(),
            ));
        };
        let total_billed_volume = delta_from_seconds_dec(x.ceil().saturating_mul(step_size))?;

        let period_delta_volume = total_billed_volume.saturating_sub(total_volume);
        *period_billed_volume = period_billed_volume.saturating_add(period_delta_volume);

        Ok(total_billed_volume)
    }

    fn apply_time(
        &self,
        periods: &mut [PeriodReport],
        total: TimeDelta,
    ) -> VerdictDeferred<TimeDelta> {
        let (Some((time_index, price)), None) = (&self.charging_time, &self.parking_time) else {
            return Ok(total.into_caveat_deferred(warning::SetDeferred::new()));
        };

        let Some(period) = periods.get_mut(*time_index) else {
            error!(time_index, "Invalid period index");
            return Err(warning::SetDeferred::with_warn(WarningKind::InternalError));
        };
        let Some(volume) = period.dimensions.duration_charging.billed_volume.as_mut() else {
            return Err(warning::SetDeferred::with_warn(
                WarningKind::DimensionShouldHaveVolume {
                    dimension_name: "time",
                },
            ));
        };

        Self::duration_step_size(total, volume, price.step_size)
    }

    fn apply_parking_time(
        &self,
        periods: &mut [PeriodReport],
        total: TimeDelta,
    ) -> VerdictDeferred<TimeDelta> {
        let warnings = warning::SetDeferred::new();
        let Some((parking_index, price)) = &self.parking_time else {
            return Ok(total.into_caveat_deferred(warnings));
        };

        let Some(period) = periods.get_mut(*parking_index) else {
            error!(parking_index, "Invalid period index");
            return warnings.bail(WarningKind::InternalError);
        };
        let Some(volume) = period.dimensions.duration_parking.billed_volume.as_mut() else {
            return warnings.bail(WarningKind::DimensionShouldHaveVolume {
                dimension_name: "parking_time",
            });
        };

        Self::duration_step_size(total, volume, price.step_size)
    }

    fn apply_energy(
        &self,
        periods: &mut [PeriodReport],
        total_volume: Kwh,
    ) -> VerdictDeferred<Kwh> {
        let warnings = warning::SetDeferred::new();
        let Some((energy_index, price)) = &self.energy else {
            return Ok(total_volume.into_caveat_deferred(warnings));
        };

        if price.step_size == 0 {
            return Ok(total_volume.into_caveat_deferred(warnings));
        }

        let Some(period) = periods.get_mut(*energy_index) else {
            error!(energy_index, "Invalid period index");
            return warnings.bail(WarningKind::InternalError);
        };
        let step_size = Decimal::from(price.step_size);

        let Some(period_billed_volume) = period.dimensions.energy.billed_volume.as_mut() else {
            return warnings.bail(WarningKind::DimensionShouldHaveVolume {
                dimension_name: "energy",
            });
        };

        let Some(watt_hours) = total_volume.watt_hours().checked_div(step_size) else {
            return warnings.bail(duration::WarningKind::Overflow.into());
        };

        let total_billed_volume = Kwh::from_watt_hours(watt_hours.ceil().saturating_mul(step_size));
        let period_delta_volume = total_billed_volume.saturating_sub(total_volume);
        *period_billed_volume = period_billed_volume.saturating_add(period_delta_volume);

        Ok(total_billed_volume.into_caveat_deferred(warnings))
    }
}

fn parse_cdr<'caller: 'buf, 'buf>(
    cdr: &'caller crate::cdr::Versioned<'buf>,
) -> Verdict<v221::cdr::WithTariffs<'buf>> {
    match cdr.version() {
        Version::V211 => {
            let cdr = v211::cdr::WithTariffs::from_json(cdr.as_element())?;
            Ok(cdr.map(v221::cdr::WithTariffs::from))
        }
        Version::V221 => v221::cdr::WithTariffs::from_json(cdr.as_element()),
    }
}

#[cfg(test)]
pub mod test {
    #![allow(clippy::missing_panics_doc, reason = "tests are allowed to panic")]
    #![allow(clippy::panic, reason = "tests are allowed panic")]

    use std::collections::{BTreeMap, BTreeSet};

    use chrono::TimeDelta;
    use rust_decimal::Decimal;
    use serde::Deserialize;
    use tracing::debug;

    use crate::{
        assert_approx_eq, cdr,
        duration::ToHoursDecimal,
        json, number,
        test::{ApproxEq, ExpectFile, Expectation},
        timezone,
        warning::{self, Kind as _},
        Caveat, Kwh, Price,
    };

    use super::{Report, TariffReport, Total, WarningKind};

    // Decimal precision used when comparing the outcomes of the calculation with the CDR.
    const PRECISION: u32 = 2;

    #[test]
    const fn warning_kind_should_be_send_and_sync() {
        const fn f<T: Send + Sync>() {}

        f::<WarningKind>();
    }

    pub trait UnwrapReport {
        #[track_caller]
        fn unwrap_report(self, cdr: &cdr::Versioned<'_>) -> Caveat<Report, WarningKind>;
    }

    impl UnwrapReport for super::Verdict<Report> {
        fn unwrap_report(self, cdr: &cdr::Versioned<'_>) -> Caveat<Report, WarningKind> {
            match self {
                Ok(v) => v,
                Err(warnings) => {
                    panic!(
                        "parsing tariff failed:\n{:?}",
                        warning::SetWriter::new(cdr.as_element(), &warnings)
                    )
                }
            }
        }
    }

    /// A `TimeDelta` wrapper used to serialize and deserialize to/from a `Decimal` representation of hours
    #[derive(Debug, Default)]
    pub(crate) struct HoursDecimal(Decimal);

    impl ToHoursDecimal for HoursDecimal {
        fn to_hours_dec(&self) -> Decimal {
            self.0
        }
    }

    /// Deserialize bytes into a `Decimal` applying the scale defined in the OCPI spec.
    ///
    /// Called from the `impl Deserialize` for a `Decimal` newtype.
    fn decimal<'de, D>(deserializer: D) -> Result<Decimal, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        use serde::Deserialize;

        let mut d = <Decimal as Deserialize>::deserialize(deserializer)?;
        d.rescale(number::SCALE);
        Ok(d)
    }

    impl<'de> Deserialize<'de> for HoursDecimal {
        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
        where
            D: serde::Deserializer<'de>,
        {
            decimal(deserializer).map(Self)
        }
    }

    #[derive(serde::Deserialize)]
    pub(crate) struct Expect {
        /// Expectations for the result of calling `timezone::find_or_infer`.
        pub timezone_find: Option<timezone::test::FindOrInferExpect>,

        /// Expectations for the result of calling `cdr::parse*`.
        pub tariff_parse: Option<ParseExpect>,

        /// Expectations for the result of calling `cdr::parse*`.
        pub cdr_parse: Option<ParseExpect>,

        /// Expectations for the result of calling `cdr::price*`.
        pub cdr_price: Option<PriceExpect>,
    }

    /// The `Expect` is used to parse the JSON but the tests use the individual fields in separate
    /// asset functions. Each of those functions needs to know the `expect_file_name`.
    #[expect(
        clippy::struct_field_names,
        reason = "When deconstructed these fields will always be called *_expect. This avoids having to rename them in-place."
    )]
    pub(crate) struct ExpectFields {
        /// Expectations for the result of calling `timezone::find_or_infer`.
        pub timezone_find_expect: ExpectFile<timezone::test::FindOrInferExpect>,

        /// Expectations for the result of calling `cdr::parse*`.
        pub tariff_parse_expect: ExpectFile<ParseExpect>,

        /// Expectations for the result of calling `cdr::parse*`.
        pub cdr_parse_expect: ExpectFile<ParseExpect>,

        /// Expectations for the result of calling `cdr::price*`.
        pub cdr_price_expect: ExpectFile<PriceExpect>,
    }

    impl ExpectFile<Expect> {
        /// Split the `ExpectFile<Expect>` into its constituent fields and repackage them as `ExpectFile`s.
        pub(crate) fn into_fields(self) -> ExpectFields {
            let ExpectFile {
                value,
                expect_file_name,
            } = self;

            match value {
                Some(expect) => {
                    let Expect {
                        timezone_find,
                        tariff_parse,
                        cdr_parse,
                        cdr_price,
                    } = expect;
                    ExpectFields {
                        timezone_find_expect: ExpectFile::with_value(
                            timezone_find,
                            &expect_file_name,
                        ),
                        tariff_parse_expect: ExpectFile::with_value(
                            tariff_parse,
                            &expect_file_name,
                        ),
                        cdr_parse_expect: ExpectFile::with_value(cdr_parse, &expect_file_name),
                        cdr_price_expect: ExpectFile::with_value(cdr_price, &expect_file_name),
                    }
                }
                None => ExpectFields {
                    timezone_find_expect: ExpectFile::only_file_name(&expect_file_name),
                    tariff_parse_expect: ExpectFile::only_file_name(&expect_file_name),
                    cdr_parse_expect: ExpectFile::only_file_name(&expect_file_name),
                    cdr_price_expect: ExpectFile::only_file_name(&expect_file_name),
                },
            }
        }
    }

    pub(crate) fn assert_parse_report(
        unexpected_fields: json::UnexpectedFields<'_>,
        expect: ExpectFile<ParseExpect>,
    ) {
        let ExpectFile {
            value,
            expect_file_name,
        } = expect;
        let unexpected_fields_expect = value
            .map(|exp| exp.unexpected_fields)
            .unwrap_or(Expectation::Absent);

        if let Expectation::Present(expectation) = unexpected_fields_expect {
            let unexpected_fields_expect = expectation.expect_value();

            for field in unexpected_fields {
                assert!(
                    unexpected_fields_expect.contains(&field.to_string()),
                    "The CDR has an unexpected field that's not expected in `{expect_file_name}`: `{field}`"
                );
            }
        } else {
            assert!(
                unexpected_fields.is_empty(),
                "The CDR has unexpected fields but the expect file doesn't `{expect_file_name}`; {unexpected_fields:#}",
            );
        }
    }

    pub(crate) fn assert_price_report(
        cdr_elem: &cdr::Versioned<'_>,
        report: Caveat<Report, WarningKind>,
        expect: ExpectFile<PriceExpect>,
    ) {
        let (report, warnings) = report.into_parts();
        let Report {
            mut tariff_reports,
            periods: _,
            tariff_used,
            timezone: _,
            billed_energy: _,
            billed_parking_time: _,
            billed_charging_time: _,
            total_charging_time: _,
            total_cost,
            total_fixed_cost,
            total_time,
            total_time_cost,
            total_energy,
            total_energy_cost,
            total_parking_time,
            total_parking_cost,
            total_reservation_cost,
        } = report;

        let ExpectFile {
            value: expect,
            expect_file_name,
        } = expect;

        // This destructure isn't pretty but it's at least simple to maintain.
        // The alternative is getting involved with references of references when processing each borrowed field.
        let (
            warnings_expect,
            tariff_index_expect,
            tariff_id_expect,
            tariff_reports_expect,
            total_cost_expectation,
            total_fixed_cost_expectation,
            total_time_expectation,
            total_time_cost_expectation,
            total_energy_expectation,
            total_energy_cost_expectation,
            total_parking_time_expectation,
            total_parking_cost_expectation,
            total_reservation_cost_expectation,
        ) = expect
            .map(|exp| {
                let PriceExpect {
                    warnings,
                    tariff_index,
                    tariff_id,
                    tariff_reports,
                    total_cost,
                    total_fixed_cost,
                    total_time,
                    total_time_cost,
                    total_energy,
                    total_energy_cost,
                    total_parking_time,
                    total_parking_cost,
                    total_reservation_cost,
                } = exp;

                (
                    warnings,
                    tariff_index,
                    tariff_id,
                    tariff_reports,
                    total_cost,
                    total_fixed_cost,
                    total_time,
                    total_time_cost,
                    total_energy,
                    total_energy_cost,
                    total_parking_time,
                    total_parking_cost,
                    total_reservation_cost,
                )
            })
            .unwrap_or((
                Expectation::Absent,
                Expectation::Absent,
                Expectation::Absent,
                Expectation::Absent,
                Expectation::Absent,
                Expectation::Absent,
                Expectation::Absent,
                Expectation::Absent,
                Expectation::Absent,
                Expectation::Absent,
                Expectation::Absent,
                Expectation::Absent,
                Expectation::Absent,
            ));

        if let Expectation::Present(expectation) = warnings_expect {
            let warnings_expect = expectation.expect_value();

            debug!("{warnings_expect:?}");

            for warning::Group { element, warnings } in
                warnings.group_by_elem(cdr_elem.as_element())
            {
                let elem_path = element.path().to_string();
                let Some(warnings_expect) = warnings_expect.get(&*elem_path) else {
                    let warning_ids = warnings
                        .iter()
                        .map(|k| format!("  \"{}\",", k.id()))
                        .collect::<Vec<_>>()
                        .join("\n");

                    panic!("No warnings expected `{expect_file_name}` for `Element` at `{elem_path}` but {} warnings were reported:\n[\n{}\n]", warnings.len(), warning_ids);
                };

                let warnings_expect = warnings_expect
                    .iter()
                    .map(|s| &**s)
                    .collect::<BTreeSet<_>>();

                for warning_kind in warnings {
                    let id = warning_kind.id();
                    assert!(
                        warnings_expect.contains(&*id),
                        "Unexpected warning `{id}` for `Element` at `{elem_path}`"
                    );
                }
            }
        } else {
            assert!(
                warnings.is_empty(),
                "The expectation file at `{expect_file_name}` did not expect warnings, but the CDR has warnings;\n{:?}",
                warnings.group_by_elem(cdr_elem.as_element()).into_id_map()
            );
        }

        if let Expectation::Present(expectation) = tariff_reports_expect {
            let tariff_reports_expect: BTreeMap<_, _> = expectation
                .expect_value()
                .into_iter()
                .map(|TariffReportExpect { id, warnings }| (id, warnings))
                .collect();

            for report in &mut tariff_reports {
                let TariffReport { origin, warnings } = report;
                let id = &origin.id;
                let Some(warnings_expect) = tariff_reports_expect.get(id) else {
                    panic!("A tariff with {id} is not expected `{expect_file_name}`");
                };

                debug!("{warnings_expect:?}");

                for (elem_path, warnings) in warnings {
                    let Some(warnings_expect) = warnings_expect.get(elem_path) else {
                        let warning_ids = warnings
                            .iter()
                            .map(|k| format!("  \"{}\",", k.id()))
                            .collect::<Vec<_>>()
                            .join("\n");

                        panic!("No warnings expected for `Element` at `{elem_path}` but {} warnings were reported:\n[\n{}\n]", warnings.len(), warning_ids);
                    };

                    let warnings_expect = warnings_expect
                        .iter()
                        .map(|s| &**s)
                        .collect::<BTreeSet<_>>();

                    for warning_kind in warnings {
                        let id = warning_kind.id();
                        assert!(
                            warnings_expect.contains(&*id),
                            "Unexpected warning `{id}` for `Element` at `{elem_path}`"
                        );
                    }
                }
            }
        } else {
            for report in &tariff_reports {
                let TariffReport { origin, warnings } = report;

                let id = &origin.id;

                assert!(
                    warnings.is_empty(),
                    "The tariff with id `{id}` has warnings.\n {warnings:?}"
                );
            }
        }

        if let Expectation::Present(expectation) = tariff_id_expect {
            assert_eq!(tariff_used.id, expectation.expect_value());
        }

        if let Expectation::Present(expectation) = tariff_index_expect {
            assert_eq!(tariff_used.index, expectation.expect_value());
        }

        total_cost_expectation.expect_price("total_cost", &total_cost);
        total_fixed_cost_expectation.expect_opt_price("total_fixed_cost", &total_fixed_cost);
        total_time_expectation.expect_duration("total_time", &total_time);
        total_time_cost_expectation.expect_opt_price("total_time_cost", &total_time_cost);
        total_energy_expectation.expect_opt_kwh("total_energy", &total_energy);
        total_energy_cost_expectation.expect_opt_price("total_energy_cost", &total_energy_cost);
        total_parking_time_expectation
            .expect_opt_duration("total_parking_time", &total_parking_time);
        total_parking_cost_expectation.expect_opt_price("total_parking_cost", &total_parking_cost);
        total_reservation_cost_expectation
            .expect_opt_price("total_reservation_cost", &total_reservation_cost);
    }

    /// Expectations for the result of calling `cdr::parse*`.
    #[derive(serde::Deserialize)]
    pub struct ParseExpect {
        #[serde(default)]
        unexpected_fields: Expectation<Vec<String>>,
    }

    /// Expectations for the result of calling `cdr::price`.
    #[derive(serde::Deserialize)]
    pub struct PriceExpect {
        /// Expected Warnings from parsing a CDR.
        ///
        /// Each entry in the map is an element path and a list of associated warnings.
        #[serde(default)]
        warnings: Expectation<BTreeMap<String, Vec<String>>>,

        /// Index of the tariff that was found to be active.
        #[serde(default)]
        tariff_index: Expectation<usize>,

        /// Id of the tariff that was found to be active.
        #[serde(default)]
        tariff_id: Expectation<String>,

        /// A list of the tariff IDs found in the CDR or supplied to the [`cdr::price`](crate::cdr::price) function.
        ///
        /// Each tariff may have a set of unexpected fields encountered while parsing the tariff.
        #[serde(default)]
        tariff_reports: Expectation<Vec<TariffReportExpect>>,

        /// Total sum of all the costs of this transaction in the specified currency.
        #[serde(default)]
        total_cost: Expectation<Price>,

        /// Total sum of all the fixed costs in the specified currency, except fixed price components of parking and reservation. The cost not depending on amount of time/energy used etc. Can contain costs like a start tariff.
        #[serde(default)]
        total_fixed_cost: Expectation<Price>,

        /// Total duration of the charging session (including the duration of charging and not charging), in hours.
        #[serde(default)]
        total_time: Expectation<HoursDecimal>,

        /// Total sum of all the cost related to duration of charging during this transaction, in the specified currency.
        #[serde(default)]
        total_time_cost: Expectation<Price>,

        /// Total energy charged, in kWh.
        #[serde(default)]
        total_energy: Expectation<Kwh>,

        /// Total sum of all the cost of all the energy used, in the specified currency.
        #[serde(default)]
        total_energy_cost: Expectation<Price>,

        /// Total duration of the charging session where the EV was not charging (no energy was transferred between EVSE and EV), in hours.
        #[serde(default)]
        total_parking_time: Expectation<HoursDecimal>,

        /// Total sum of all the cost related to parking of this transaction, including fixed price components, in the specified currency.
        #[serde(default)]
        total_parking_cost: Expectation<Price>,

        /// Total sum of all the cost related to a reservation of a Charge Point, including fixed price components, in the specified currency.
        #[serde(default)]
        total_reservation_cost: Expectation<Price>,
    }

    #[derive(Debug, Deserialize)]
    struct TariffReportExpect {
        /// The id of the tariff.
        id: String,

        /// Expected Warnings from parsing a tariff.
        ///
        /// Each entry in the map is an element path and a list of associated warnings.
        #[serde(default)]
        warnings: BTreeMap<String, Vec<String>>,
    }

    impl Expectation<Price> {
        #[track_caller]
        fn expect_opt_price(self, field_name: &str, total: &Total<Option<Price>>) {
            if let Expectation::Present(expect_value) = self {
                match (expect_value.into_option(), total.calculated) {
                    (Some(a), Some(b)) => assert!(
                        a.approx_eq(&b),
                        "Expected `{a}` but `{b}` was calculated for `{field_name}`"
                    ),
                    (Some(a), None) => {
                        panic!("Expected `{a}`, but no price was calculated for `{field_name}`")
                    }
                    (None, Some(b)) => {
                        panic!("Expected no value, but `{b}` was calculated for `{field_name}`")
                    }
                    (None, None) => (),
                }
            } else {
                match (total.cdr, total.calculated) {
                    (None, None) => (),
                    (None, Some(calculated)) => {
                        assert!(calculated.is_zero(), "The CDR field `{field_name}` doesn't have a value but a value was calculated; calculated: {calculated}");
                    }
                    (Some(cdr), None) => {
                        assert!(
                            cdr.is_zero(),
                            "The CDR field `{field_name}` has a value but the calculated value is none; cdr: {cdr}"
                        );
                    }
                    (Some(cdr), Some(calculated)) => {
                        assert!(
                            cdr.approx_eq(&calculated),
                            "Comparing `{field_name}` field with CDR"
                        );
                    }
                }
            }
        }

        #[track_caller]
        fn expect_price(self, field_name: &str, total: &Total<Price, Option<Price>>) {
            if let Expectation::Present(expect_value) = self {
                match (expect_value.into_option(), total.calculated) {
                    (Some(a), Some(b)) => assert!(
                        a.approx_eq(&b),
                        "Expected `{a}` but `{b}` was calculated for `{field_name}`"
                    ),
                    (Some(a), None) => {
                        panic!("Expected `{a}`, but no price was calculated for `{field_name}`")
                    }
                    (None, Some(b)) => {
                        panic!("Expected no value, but `{b}` was calculated for `{field_name}`")
                    }
                    (None, None) => (),
                }
            } else if let Some(calculated) = total.calculated {
                assert!(
                    total.cdr.approx_eq(&calculated),
                    "CDR contains `{}` but `{}` was calculated for `{field_name}`",
                    total.cdr,
                    calculated
                );
            } else {
                assert!(
                    total.cdr.is_zero(),
                    "The CDR field `{field_name}` has a value but the calculated value is none; cdr: {:?}",
                    total.cdr
                );
            }
        }
    }

    impl Expectation<HoursDecimal> {
        #[track_caller]
        fn expect_duration(self, field_name: &str, total: &Total<TimeDelta>) {
            if let Expectation::Present(expect_value) = self {
                assert_approx_eq!(
                    expect_value.expect_value().to_hours_dec(),
                    total.calculated.to_hours_dec(),
                    "Comparing `{field_name}` field with expectation"
                );
            } else {
                assert_approx_eq!(
                    total.cdr.to_hours_dec(),
                    total.calculated.to_hours_dec(),
                    "Comparing `{field_name}` field with CDR"
                );
            }
        }

        #[track_caller]
        fn expect_opt_duration(
            self,
            field_name: &str,
            total: &Total<Option<TimeDelta>, Option<TimeDelta>>,
        ) {
            if let Expectation::Present(expect_value) = self {
                assert_approx_eq!(
                    expect_value
                        .into_option()
                        .unwrap_or_default()
                        .to_hours_dec(),
                    &total
                        .calculated
                        .as_ref()
                        .map(ToHoursDecimal::to_hours_dec)
                        .unwrap_or_default(),
                    "Comparing `{field_name}` field with expectation"
                );
            } else {
                assert_approx_eq!(
                    total.cdr.unwrap_or_default().to_hours_dec(),
                    total.calculated.unwrap_or_default().to_hours_dec(),
                    "Comparing `{field_name}` field with CDR"
                );
            }
        }
    }

    impl Expectation<Kwh> {
        #[track_caller]
        fn expect_opt_kwh(self, field_name: &str, total: &Total<Kwh, Option<Kwh>>) {
            if let Expectation::Present(expect_value) = self {
                assert_eq!(
                    expect_value
                        .into_option()
                        .map(|kwh| kwh.round_dp(PRECISION)),
                    total
                        .calculated
                        .map(|kwh| kwh.rescale().round_dp(PRECISION)),
                    "Comparing `{field_name}` field with expectation"
                );
            } else {
                assert_eq!(
                    total.cdr.round_dp(PRECISION),
                    total
                        .calculated
                        .map(|kwh| kwh.rescale().round_dp(PRECISION))
                        .unwrap_or_default(),
                    "Comparing `{field_name}` field with CDR"
                );
            }
        }
    }
}

#[cfg(test)]
mod test_periods {
    #![allow(clippy::as_conversions, reason = "tests are allowed to panic")]
    #![allow(clippy::panic, reason = "tests are allowed panic")]

    use assert_matches::assert_matches;
    use chrono::Utc;
    use chrono_tz::Tz;
    use rust_decimal::Decimal;
    use rust_decimal_macros::dec;

    use crate::{
        assert_approx_eq, cdr,
        price::{self, test::UnwrapReport},
        tariff, test, Kwh, Version,
    };

    use super::{Consumed, Period, TariffSource};

    #[test]
    fn should_price_periods_from_time_and_parking_time_cdr_and_tariff() {
        const VERSION: Version = Version::V211;
        const CDR_JSON: &str = include_str!(
            "../test_data/v211/real_world/time_and_parking_time_separate_tariff/cdr.json"
        );
        const TARIFF_JSON: &str = include_str!(
            "../test_data/v211/real_world/time_and_parking_time_separate_tariff/tariff.json"
        );
        // Every period has a 15 minute duration.
        const PERIOD_DURATION: chrono::TimeDelta = chrono::TimeDelta::minutes(15);

        /// Create `TIME` period for each energy value provided.
        ///
        /// Each `TIME` period is the same duration.
        /// But has a different `start_date_time`.
        fn charging(start_date_time: &str, energy: Vec<Decimal>) -> Vec<Period> {
            let start: chrono::DateTime<Utc> = start_date_time.parse().unwrap();

            energy
                .into_iter()
                .enumerate()
                .map(|(i, kwh)| {
                    let i = i32::try_from(i).unwrap();
                    let start_date_time = start + (PERIOD_DURATION * i);

                    Period {
                        start_date_time,
                        consumed: Consumed {
                            duration_charging: Some(PERIOD_DURATION),
                            energy: Some(kwh.into()),
                            ..Default::default()
                        },
                    }
                })
                .collect()
        }

        /// Create `period_count` number of `PARKING_TIME` periods.
        ///
        /// Each `PARKING_TIME` period is the same duration and energy usage (0kWh)
        /// but has a different `start_date_time`.
        fn parking(start_date_time: &str, period_count: usize) -> Vec<Period> {
            // Every parking period has a consumed energy of zero.
            let period_energy = Kwh::from(0);
            let start: chrono::DateTime<Utc> = start_date_time.parse().unwrap();

            let period_count = i32::try_from(period_count).unwrap();
            // Add uniform periods except for the last one
            let mut periods: Vec<Period> = (0..period_count - 1)
                .map(|i| {
                    let start_date_time = start + (PERIOD_DURATION * i);

                    Period {
                        start_date_time,
                        consumed: Consumed {
                            duration_parking: Some(PERIOD_DURATION),
                            energy: Some(period_energy),
                            ..Default::default()
                        },
                    }
                })
                .collect();

            let start_date_time = start + (PERIOD_DURATION * (period_count - 1));

            // The last period is a 10 minutes period instead of 15 minutes.
            periods.push(Period {
                start_date_time,
                consumed: Consumed {
                    duration_parking: Some(chrono::TimeDelta::seconds(644)),
                    energy: Some(period_energy),
                    ..Default::default()
                },
            });

            periods
        }

        test::setup();

        let report = cdr::parse_with_version(CDR_JSON, VERSION).unwrap();
        let cdr::ParseReport {
            cdr,
            unexpected_fields,
        } = report;

        assert!(unexpected_fields.is_empty());
        let tariff::ParseReport {
            tariff,
            unexpected_fields,
        } = tariff::parse_with_version(TARIFF_JSON, VERSION).unwrap();
        assert!(unexpected_fields.is_empty());

        // If you know the version and timezone of a CDR you simply pass them into the `cdr::price` fn.
        let report = cdr::price(
            &cdr,
            TariffSource::Override(vec![tariff.clone()]),
            Tz::Europe__Amsterdam,
        )
        .unwrap_report(&cdr);

        let (report, warnings) = report.into_parts();
        assert_matches!(warnings.into_kind_vec().as_slice(), []);

        let price::Report {
            // We are not concerned with warnings in this test
            periods,
            // We are not concerned with the tariff reports in this test
            tariff_used: _,
            tariff_reports: _,
            timezone: _,
            billed_energy,
            billed_parking_time,
            billed_charging_time,
            total_charging_time,
            total_energy,
            total_parking_time,
            // The `total_time` simply the addition of `total_charging_time` and `total_parking_time`.
            total_time: _,
            total_cost,
            total_energy_cost,
            total_fixed_cost,
            total_parking_cost,
            // Reservation costs are not computed during pricing.
            total_reservation_cost: _,
            total_time_cost,
        } = report;

        let mut cdr_periods = charging(
            "2025-04-09T16:12:54.000Z",
            vec![
                dec!(2.75),
                dec!(2.77),
                dec!(1.88),
                dec!(2.1),
                dec!(2.09),
                dec!(2.11),
                dec!(2.09),
                dec!(2.09),
                dec!(2.09),
                dec!(2.09),
                dec!(2.09),
                dec!(2.09),
                dec!(2.09),
                dec!(2.11),
                dec!(2.13),
                dec!(2.09),
                dec!(2.11),
                dec!(2.12),
                dec!(2.13),
                dec!(2.1),
                dec!(2.0),
                dec!(0.69),
                dec!(0.11),
            ],
        );
        let mut periods_parking = parking("2025-04-09T21:57:55.000Z", 47);

        cdr_periods.append(&mut periods_parking);
        cdr_periods.sort_by_key(|p| p.start_date_time);

        assert_eq!(
            cdr_periods.len(),
            periods.len(),
            "The amount of `price::Report` periods should equal the periods given to the `price::periods` fn"
        );
        assert_eq!(
            periods.len(),
            70,
            "The `time_and_parking/cdr.json` has 70 `charging_periods`"
        );

        assert!(periods
            .iter()
            .map(|p| p.start_date_time)
            .collect::<Vec<_>>()
            .is_sorted());

        let (tariff, warnings) = super::tariff::parse(&tariff).unwrap().into_parts();
        assert!(warnings.is_empty());

        let periods_report = price::periods(
            "2025-04-10T09:38:38.000Z".parse().unwrap(),
            chrono_tz::Europe::Amsterdam,
            &tariff,
            &mut cdr_periods,
        )
        .unwrap()
        .unwrap();

        let price::PeriodsReport {
            billable,
            periods,
            totals,
            total_costs,
        } = periods_report;

        assert_eq!(
            cdr_periods.len(),
            periods.len(),
            "The amount of `price::Report` periods should equal the periods given to the `price::periods` fn"
        );
        assert_eq!(
            periods.len(),
            70,
            "The `time_and_parking/cdr.json` has 70 `charging_periods`"
        );

        assert_approx_eq!(billable.charging_time, billed_charging_time);
        assert_approx_eq!(billable.energy, billed_energy);
        assert_approx_eq!(billable.parking_time, billed_parking_time,);

        assert_approx_eq!(totals.duration_charging, total_charging_time);
        assert_approx_eq!(totals.energy, total_energy.calculated);
        assert_approx_eq!(totals.duration_parking, total_parking_time.calculated);

        assert_approx_eq!(total_costs.duration_charging, total_time_cost.calculated,);
        assert_approx_eq!(total_costs.energy, total_energy_cost.calculated,);
        assert_approx_eq!(total_costs.fixed, total_fixed_cost.calculated);
        assert_approx_eq!(total_costs.duration_parking, total_parking_cost.calculated);
        assert_approx_eq!(total_costs.total(), total_cost.calculated);
    }
}

#[cfg(test)]
mod test_validate_cdr {
    use assert_matches::assert_matches;

    use crate::{
        cdr,
        json::FromJson,
        price::{self, v221, WarningKind},
        test::{self, datetime_from_str},
    };

    #[test]
    fn should_pass_parse_validation() {
        test::setup();
        let json = cdr_json("2022-01-13T16:00:00Z", "2022-01-13T19:12:00Z");
        let cdr::ParseReport {
            cdr,
            unexpected_fields,
        } = cdr::parse_with_version(&json, crate::Version::V221).unwrap();
        assert!(unexpected_fields.is_empty());
        let (_cdr, warnings) = v221::Cdr::from_json(cdr.as_element()).unwrap().into_parts();
        assert!(warnings.is_empty());
    }

    #[test]
    fn should_fail_validation_start_end_range_doesnt_overlap_with_periods() {
        test::setup();

        let json = cdr_json("2022-02-13T16:00:00Z", "2022-02-13T19:12:00Z");
        let cdr::ParseReport {
            cdr,
            unexpected_fields,
        } = cdr::parse_with_version(&json, crate::Version::V221).unwrap();
        assert!(unexpected_fields.is_empty());
        let (_cdr, warnings) = v221::Cdr::from_json(cdr.as_element()).unwrap().into_parts();
        let warnings = warnings.into_kind_vec();
        let [warning] = warnings.try_into().unwrap();
        let (cdr_range, period_range) = assert_matches!(warning, WarningKind::PeriodsOutsideStartEndDateTime { cdr_range, period_range } => (cdr_range, period_range));

        {
            assert_eq!(cdr_range.start, datetime_from_str("2022-02-13T16:00:00Z"));
            assert_eq!(cdr_range.end, datetime_from_str("2022-02-13T19:12:00Z"));
        }
        {
            let period_range =
                assert_matches!(period_range, price::PeriodRange::Many(range) => range);

            assert_eq!(
                period_range.start,
                datetime_from_str("2022-01-13T16:00:00Z")
            );
            assert_eq!(period_range.end, datetime_from_str("2022-01-13T18:30:00Z"));
        }
    }

    fn cdr_json(start_date_time: &str, end_date_time: &str) -> String {
        let value = serde_json::json!({
            "country_code": "NL",
            "party_id": "ENE",
            "start_date_time": start_date_time,
            "end_date_time": end_date_time,
            "currency": "EUR",
            "tariffs": [],
            "cdr_location": {
                "country": "NLD"
            },
            "charging_periods": [
                {
                    "start_date_time": "2022-01-13T16:00:00Z",
                    "dimensions": [
                        {
                            "type": "TIME",
                            "volume": 2.5
                        }
                    ]
                },
                {
                    "start_date_time": "2022-01-13T18:30:00Z",
                    "dimensions": [
                        {
                            "type": "PARKING_TIME",
                            "volume": 0.7
                        }
                    ]
                }
            ],
            "total_cost": {
                "excl_vat": 11.25,
                "incl_vat": 12.75
            },
            "total_time_cost": {
                "excl_vat": 7.5,
                "incl_vat": 8.25
            },
            "total_parking_time": 0.7,
            "total_parking_cost": {
                "excl_vat": 3.75,
                "incl_vat": 4.5
            },
            "total_time": 3.2,
            "total_energy": 0,
            "last_updated": "2022-01-13T00:00:00Z"
        });

        value.to_string()
    }
}

#[cfg(test)]
mod test_real_world_v211 {
    use std::path::Path;

    use crate::{
        cdr,
        price::{
            self,
            test::{Expect, ExpectFields, UnwrapReport},
        },
        tariff, test, timezone, Version,
    };

    #[test_each::file(
        glob = "ocpi-tariffs/test_data/v211/real_world/*/cdr*.json",
        name(segments = 2)
    )]
    fn test_price_cdr(cdr_json: &str, path: &Path) {
        const VERSION: Version = Version::V211;

        test::setup();

        let expect_json = test::read_expect_json(path, "price");
        let expect = test::parse_expect_json::<Expect>(expect_json.as_deref());

        let ExpectFields {
            timezone_find_expect,
            tariff_parse_expect,
            cdr_parse_expect,
            cdr_price_expect,
        } = expect.into_fields();

        let tariff_json = std::fs::read_to_string(path.parent().unwrap().join("tariff.json")).ok();
        let tariff = tariff_json
            .as_deref()
            .map(|json| tariff::parse_with_version(json, VERSION))
            .transpose()
            .unwrap();

        let tariff = if let Some(parse_report) = tariff {
            let tariff::ParseReport {
                tariff,
                unexpected_fields,
            } = parse_report;
            price::test::assert_parse_report(unexpected_fields, tariff_parse_expect);
            price::TariffSource::Override(vec![tariff])
        } else {
            assert!(tariff_parse_expect.value.is_none(), "There is no separate tariff to parse so there is no need to define a `tariff_parse` expectation");
            price::TariffSource::UseCdr
        };

        let report = cdr::parse_with_version(cdr_json, VERSION).unwrap();
        let cdr::ParseReport {
            cdr,
            unexpected_fields,
        } = report;
        price::test::assert_parse_report(unexpected_fields, cdr_parse_expect);

        let (timezone_source, warnings) = timezone::find_or_infer(&cdr).into_parts();
        let timezone_source = timezone_source.unwrap();

        timezone::test::assert_find_or_infer_outcome(
            &cdr,
            timezone_source,
            timezone_find_expect,
            &warnings,
        );

        let report = cdr::price(&cdr, tariff, timezone_source.into_timezone()).unwrap_report(&cdr);
        price::test::assert_price_report(&cdr, report, cdr_price_expect);
    }
}

#[cfg(test)]
mod test_real_world_v221 {
    use std::path::Path;

    use crate::{
        cdr,
        price::{
            self,
            test::{ExpectFields, UnwrapReport},
        },
        tariff, test, timezone, Version,
    };

    #[test_each::file(
        glob = "ocpi-tariffs/test_data/v221/real_world/*/cdr*.json",
        name(segments = 2)
    )]
    fn test_price_cdr(cdr_json: &str, path: &Path) {
        const VERSION: Version = Version::V221;

        test::setup();

        let expect_json = test::read_expect_json(path, "price");
        let expect = test::parse_expect_json(expect_json.as_deref());
        let ExpectFields {
            timezone_find_expect,
            tariff_parse_expect,
            cdr_parse_expect,
            cdr_price_expect,
        } = expect.into_fields();

        let tariff_json = std::fs::read_to_string(path.parent().unwrap().join("tariff.json")).ok();
        let tariff = tariff_json
            .as_deref()
            .map(|json| tariff::parse_with_version(json, VERSION))
            .transpose()
            .unwrap();
        let tariff = tariff
            .map(|report| {
                let tariff::ParseReport {
                    tariff,
                    unexpected_fields,
                } = report;
                price::test::assert_parse_report(unexpected_fields, tariff_parse_expect);
                price::TariffSource::Override(vec![tariff])
            })
            .unwrap_or(price::TariffSource::UseCdr);

        let report = cdr::parse_with_version(cdr_json, VERSION).unwrap();
        let cdr::ParseReport {
            cdr,
            unexpected_fields,
        } = report;
        price::test::assert_parse_report(unexpected_fields, cdr_parse_expect);

        let (timezone_source, warnings) = timezone::find_or_infer(&cdr).into_parts();
        let timezone_source = timezone_source.unwrap();

        timezone::test::assert_find_or_infer_outcome(
            &cdr,
            timezone_source,
            timezone_find_expect,
            &warnings,
        );

        // The v221 tariff location does not contain a timezone field, this timezone should be
        // used from the `Location`.
        //
        // The tariff's time related fields are in UTC and can be converted to local time by using
        // the timezone from the `Location` object.
        //
        // > `start_date_time`:
        // >
        // > The time when this tariff becomes active, in UTC, time_zone field of the Location can be used to convert to local time.
        // >
        // > See: <https://github.com/ocpi/ocpi/blob/release-2.2.1-bugfixes/mod_tariffs.asciidoc#131-tariff-object>
        //
        // See: <https://github.com/ocpi/ocpi/blob/release-2.2.1-bugfixes/mod_locations.asciidoc>
        let report = cdr::price(&cdr, tariff, timezone_source.into_timezone()).unwrap_report(&cdr);
        price::test::assert_price_report(&cdr, report, cdr_price_expect);
    }
}