ion_schema/

violation.rs

use crate::ion_path::IonPath;
use std::fmt;
use std::fmt::Formatter;
use thiserror::Error;

/// Represents [Violation] found during validation with detailed error message, error code and the constraint for which the validation failed
/// Equivalence of `Violation` is not supported due to its tree structure of having children `Violation`s.
/// Please use macro `assert_equivalent_violations!(violation1, violation2)` for comparing if two violations are equal.
/// This macro uses `flattened_violations` and does not depend on the order of the children `Violation`s.
/// For non-equivalent violations use macro `assert_non_equivalent_violations!(violation1, violation2)`.
#[derive(Debug, Clone, Error)]
pub struct Violation {
    constraint: String,  // represents the constraint that created this violation
    code: ViolationCode, // represents an error code that indicates the type of the violation
    message: String,     // represents the detailed error message for this violation
    ion_path: IonPath,   // represents the path to Ion value for which violation occurred
    violations: Vec<Violation>,
}

impl Violation {
    pub fn new<A: AsRef<str>, B: AsRef<str>>(
        constraint: A,
        code: ViolationCode,
        message: B,
        ion_path: &mut IonPath,
    ) -> Self {
        Self {
            constraint: constraint.as_ref().to_owned(),
            code,
            message: message.as_ref().to_owned(),
            ion_path: ion_path.to_owned(),
            violations: Vec::new(),
        }
    }

    pub fn with_violations<A: AsRef<str>, B: AsRef<str>>(
        constraint: A,
        code: ViolationCode,
        message: B,
        ion_path: &mut IonPath,
        violations: Vec<Violation>,
    ) -> Self {
        Self {
            constraint: constraint.as_ref().to_owned(),
            code,
            message: message.as_ref().to_owned(),
            ion_path: ion_path.to_owned(),
            violations,
        }
    }

    pub fn ion_path(&self) -> &IonPath {
        &self.ion_path
    }

    pub fn message(&self) -> &String {
        &self.message
    }

    pub fn code(&self) -> &ViolationCode {
        &self.code
    }

    /// Provides flattened list of leaf violations which represent the root cause of the top-level violation.
    pub fn flattened_violations(&self) -> Vec<&Violation> {
        let mut flattened_violations = Vec::new();
        self.flatten_violations(&mut flattened_violations);
        flattened_violations
    }

    fn flatten_violations<'a>(&'a self, flattened: &mut Vec<&'a Violation>) {
        if self.violations.is_empty() {
            flattened.push(self);
        }
        for violation in &self.violations {
            if violation.violations.is_empty() {
                flattened.push(violation);
            } else {
                violation.flatten_violations(flattened)
            }
        }
    }

    pub fn violations(&self) -> impl Iterator<Item = &Violation> {
        self.violations.iter()
    }
}

impl fmt::Display for Violation {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.write_str(self.message.as_str())?;

        let mut stack = vec![];
        let mut violations_iter = self.violations.iter();
        let mut violation = violations_iter.next();

        let mut indent = "  ".to_string();

        while let Some(v) = violation {
            f.write_fmt(format_args!("\n{}- {}", &indent, v.message))?;

            if !v.violations.is_empty() {
                stack.push(violations_iter);
                violations_iter = v.violations.iter();
                indent.push_str("  ");
            }
            violation = violations_iter.next();
            while violation.is_none() && !stack.is_empty() {
                violations_iter = stack.pop().unwrap();
                indent.truncate(indent.len() - 2);
                violation = violations_iter.next();
            }
        }
        Ok(())
    }
}

/// Represents violation code that indicates the type of the violation
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum ViolationCode {
    AllTypesNotMatched,
    AnnotationMismatched,
    ElementMismatched,     // this is used for mismatched elements in containers
    ElementNotDistinct,    // this is used for elements that are not distinct in containers
    FieldNamesMismatched,  // this is used for mismatched field names in a struct
    FieldNamesNotDistinct, // this is used for field names that are not distinct in a struct
    FieldsNotMatched,
    InvalidIeee754Float, // this is used for ieee754_float constraint
    InvalidLength, // this is used for any length related constraints (e.g. container_length, byte_length, codepoint_length)
    InvalidNull,   // if the value is a null for type references that doesn't allow null
    InvalidOpenContent, // if a container contains open content when `content: closed` is specified
    InvalidValue,  // this is used for valid_values constraint
    MissingAnnotation, // if the annotation is missing for annotations constraint
    MissingValue,  // if the ion value is missing for a particular constraint
    MoreThanOneTypeMatched,
    NoTypesMatched,
    RegexMismatched, // this is used for regex constraint
    TypeConstraintsUnsatisfied,
    TypeMatched,
    TypeMismatched,
    UnexpectedAnnotation, // if unexpected annotation is found for annotations constraint
}

impl fmt::Display for ViolationCode {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}",
            match self {
                ViolationCode::AllTypesNotMatched => "all_types_not_matched",
                ViolationCode::AnnotationMismatched => "annotation_mismatched",
                ViolationCode::ElementMismatched => "element_mismatched",
                ViolationCode::ElementNotDistinct => "element_not_distinct",
                ViolationCode::FieldNamesMismatched => "field_names_mismatched",
                ViolationCode::FieldNamesNotDistinct => "field_names_not_distinct",
                ViolationCode::FieldsNotMatched => "fields_not_matched",
                ViolationCode::InvalidIeee754Float => "invalid_ieee754_float",
                ViolationCode::InvalidLength => "invalid_length",
                ViolationCode::InvalidNull => "invalid_null",
                ViolationCode::InvalidOpenContent => "invalid_open_content",
                ViolationCode::InvalidValue => "invalid_value",
                ViolationCode::MissingAnnotation => "missing_annotation",
                ViolationCode::MissingValue => "missing_value",
                ViolationCode::MoreThanOneTypeMatched => "more_than_one_type_matched",
                ViolationCode::NoTypesMatched => "no_types_matched",
                ViolationCode::RegexMismatched => "regex_mismatched",
                ViolationCode::TypeConstraintsUnsatisfied => "type_constraints_unsatisfied",
                ViolationCode::TypeMatched => "type_matched",
                ViolationCode::TypeMismatched => "type_mismatched",
                ViolationCode::UnexpectedAnnotation => "unexpected_annotation",
            }
        )
    }
}

#[macro_export]
/// Equivalence for `Violation`s is not supported due to its tree structure of having children violations.
/// This macro can be used for comparing if two violations are equal and uses `flattened_violations` for the comparison.
macro_rules! assert_equivalent_violations {
    ($left:expr, $right:expr $(,)?) => {
        let mut left_strings: Vec<String> = $left
                .flattened_violations()
                .into_iter()
                .map(|x| format!("{:?}", x))
                .collect();
        left_strings.sort();
        let mut right_strings: Vec<String> = $right
                .flattened_violations()
                .into_iter()
                .map(|x| format!("{:?}", x))
                .collect();
        right_strings.sort();
        assert_eq!(left_strings, right_strings);
    };
    ($left:expr, $right:expr, $($arg:tt)+) => {
        let mut left_strings: Vec<String> = $left
                .flattened_violations()
                .into_iter()
                .map(|x| format!("{:?}", x))
                .collect();
        left_strings.sort();
        let mut right_strings: Vec<String> = $right
                .flattened_violations()
                .into_iter()
                .map(|x| format!("{:?}", x))
                .collect();
        right_strings.sort();
        assert_eq!(left_strings, right_strings, $($arg)+);
    };
}

/// Equivalence for `Violation`s is not supported due to its tree structure of having children violations.
/// This macro can be used for comparing if two violations are not equal and uses `flattened_violations` for the comparison.
#[macro_export]
macro_rules! assert_non_equivalent_violations {
    ($left:expr, $right:expr $(,)?) => {
        let mut left_strings: Vec<String> = $left
                .flattened_violations()
                .into_iter()
                .map(|x| format!("{:?}", x))
                .collect();
        left_strings.sort();
        let mut right_strings: Vec<String> = $right
                .flattened_violations()
                .into_iter()
                .map(|x| format!("{:?}", x))
                .collect();
        right_strings.sort();
        assert_ne!(left_strings, right_strings);
    };
    ($left:expr, $right:expr, $($arg:tt)+) => {
        let mut left_strings: Vec<String> = $left
                .flattened_violations()
                .into_iter()
                .map(|x| format!("{:?}", x))
                .collect();
        left_strings.sort();
        let mut right_strings: Vec<String> = $right
                .flattened_violations()
                .into_iter()
                .map(|x| format!("{:?}", x))
                .collect();
        right_strings.sort();
        assert_ne!(left_strings, right_strings, $($arg)+);
    };
}

#[cfg(test)]
mod violation_tests {
    use crate::ion_path::{IonPath, IonPathElement};
    use crate::violation::{Violation, ViolationCode};
    use rstest::rstest;

    #[rstest(violation1, violation2,
    case::unordered_violations(Violation::with_violations(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
            vec![
                Violation::new(
                    "regex",
                    ViolationCode::RegexMismatched,
                    "regex mismatched",
                    &mut IonPath::default(),
                ),
                Violation::new(
                    "container_length",
                    ViolationCode::InvalidLength,
                    "invalid length",
                    &mut IonPath::default(),
                ),
            ],
        ), Violation::with_violations(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
            vec![
                Violation::new(
                    "container_length",
                    ViolationCode::InvalidLength,
                    "invalid length",
                    &mut IonPath::default(),
                ),
                Violation::new(
                    "regex",
                    ViolationCode::RegexMismatched,
                    "regex mismatched",
                    &mut IonPath::default(),
                ),
            ],
        )
    ),
    case::nested_violations(
        Violation::with_violations(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
            vec![
                Violation::with_violations(
                    "regex",
                    ViolationCode::RegexMismatched,
                    "regex mismatched",
                    &mut IonPath::default(),
                    vec![
                        Violation::new(
                            "container_length",
                            ViolationCode::InvalidLength,
                            "invalid length",
                            &mut IonPath::default(),
                        ),
                        Violation::new(
                            "codepoint_length",
                            ViolationCode::InvalidLength,
                            "invalid length",
                            &mut IonPath::default(),
                        )
                    ]
                )
            ],
        ),
        Violation::with_violations(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
            vec![
                Violation::with_violations(
                    "regex",
                    ViolationCode::RegexMismatched,
                    "regex mismatched",
                    &mut IonPath::default(),
                    vec![
                        Violation::new(
                            "codepoint_length",
                            ViolationCode::InvalidLength,
                            "invalid length",
                            &mut IonPath::default(),
                        ),
                        Violation::new(
                            "container_length",
                            ViolationCode::InvalidLength,
                            "invalid length",
                            &mut IonPath::default(),
                        )
                    ]
                )
            ],
        )
    ),
    case::empty_violations(
        Violation::with_violations(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
            vec![],
        ),
        Violation::with_violations(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
            vec![],
        )
    ),
    case::multiple_violations_from_one_constraint(
        Violation::with_violations(
        "type_constraint",
        ViolationCode::TypeMismatched,
        "type mismatched",
        &mut IonPath::default(),
        vec![
            Violation::new(
                "element",
                ViolationCode::ElementMismatched,
                "element mismatched",
                &mut IonPath::default(),
            ),
            Violation::new(
                "element",
                ViolationCode::ElementNotDistinct,
                "element not distinct",
                &mut IonPath::default(),
            ),
        ],
        ),
    Violation::with_violations(
        "type_constraint",
        ViolationCode::TypeMismatched,
        "type mismatched",
        &mut IonPath::default(),
        vec![
            Violation::new(
                "element",
                ViolationCode::ElementNotDistinct,
                "element not distinct",
                &mut IonPath::default(),
            ),
            Violation::new(
                "element",
                ViolationCode::ElementMismatched,
                "element mismatched",
                &mut IonPath::default(),
            ),
        ],
        ),
    )
    )]
    fn violation_equivalence(violation1: Violation, violation2: Violation) {
        assert_equivalent_violations!(violation1, violation2);
    }

    #[rstest(violation1, violation2,
    case::different_violations(
        Violation::with_violations(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
            vec![
                Violation::new(
                    "regex",
                    ViolationCode::RegexMismatched,
                    "regex mismatched",
                    &mut IonPath::default(),
                ),
                Violation::new(
                    "container_length",
                    ViolationCode::InvalidLength,
                    "invalid length",
                    &mut IonPath::default(),
                ),
            ],
        ), Violation::with_violations(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
            vec![
            Violation::new(
                "container_length",
                ViolationCode::InvalidLength,
                "invalid length",
                &mut IonPath::default(),
            ),
            ],
        )
    ),
    case::different_constraints(
        Violation::new(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
        ),
        Violation::new(
            "regex",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
        )
    ),
    case::different_violation_code(
        Violation::new(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
        ),
        Violation::new(
            "type_constraint",
            ViolationCode::RegexMismatched,
            "type mismatched",
            &mut IonPath::default(),
        )
    ),
    case::different_violation_message(
        Violation::new(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "regex mismatched",
            &mut IonPath::default(),
        ),
        Violation::new(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
        )
    ),
    case::different_ion_path(
        Violation::new(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::new(vec![IonPathElement::Index(2)]),
        ),
        Violation::new(
            "type_constraint",
            ViolationCode::TypeMismatched,
            "type mismatched",
            &mut IonPath::default(),
        )
    ))]
    fn non_equivalent_violations(violation1: Violation, violation2: Violation) {
        assert_non_equivalent_violations!(violation1, violation2);
    }
}