oxigraph/testsuite/src/sparql_evaluator.rs

use crate::files::*;
use crate::manifest::*;
use crate::report::*;
use crate::vocab::*;
use chrono::Utc;
use oxigraph::model::vocab::*;
use oxigraph::model::*;
use oxigraph::sparql::*;
use oxigraph::{Error, MemoryStore, Result};
use std::collections::HashMap;
use std::fmt;
use std::str::FromStr;
use std::sync::Arc;

pub fn evaluate_sparql_tests(
    manifest: impl Iterator<Item = Result<Test>>,
) -> Result<Vec<TestResult>> {
    manifest
        .map(|test| {
            let test = test?;
            let outcome = evaluate_sparql_test(&test);
            Ok(TestResult {
                test: test.id,
                outcome,
                date: Utc::now(),
            })
        })
        .collect()
}

fn evaluate_sparql_test(test: &Test) -> Result<()> {
    if test.kind == "http://www.w3.org/2001/sw/DataAccess/tests/test-manifest#PositiveSyntaxTest"
        || test.kind
            == "http://www.w3.org/2001/sw/DataAccess/tests/test-manifest#PositiveSyntaxTest11"
    {
        let query_file = test
            .action
            .as_deref()
            .ok_or_else(|| Error::msg(format!("No action found for test {}", test)))?;
        match Query::parse(&read_file_to_string(&query_file)?, Some(&query_file)) {
            Err(error) => Err(Error::msg(format!(
                "Not able to parse {} with error: {}",
                test, error
            ))),
            Ok(query) => match Query::parse(&query.to_string(), None) {
                Ok(_) => Ok(()),
                Err(error) => Err(Error::msg(format!(
                    "Failure to deserialize \"{}\" of {} with error: {}",
                    query.to_string(),
                    test,
                    error
                ))),
            },
        }
    } else if test.kind
        == "http://www.w3.org/2001/sw/DataAccess/tests/test-manifest#NegativeSyntaxTest"
        || test.kind
            == "http://www.w3.org/2001/sw/DataAccess/tests/test-manifest#NegativeSyntaxTest11"
    {
        let query_file = test
            .action
            .as_deref()
            .ok_or_else(|| Error::msg(format!("No action found for test {}", test)))?;
        match Query::parse(&read_file_to_string(query_file)?, Some(query_file)) {
            Ok(result) => Err(Error::msg(format!(
                "Oxigraph parses even if it should not {}. The output tree is: {}",
                test, result
            ))),
            Err(_) => Ok(()),
        }
    } else if test.kind
        == "http://www.w3.org/2001/sw/DataAccess/tests/test-manifest#QueryEvaluationTest"
    {
        let store = MemoryStore::new();
        if let Some(data) = &test.data {
            load_to_store(data, &store, None)?;
        }
        for graph_data in &test.graph_data {
            load_to_store(
                &graph_data,
                &store,
                Some(&NamedNode::parse(graph_data)?.into()),
            )?;
        }
        let query_file = test
            .query
            .as_deref()
            .ok_or_else(|| Error::msg(format!("No action found for test {}", test)))?;
        let options = QueryOptions::default()
            .with_base_iri(query_file)
            .with_service_handler(StaticServiceHandler::new(&test.service_data)?);
        match store.prepare_query(&read_file_to_string(query_file)?, options) {
            Err(error) => Err(Error::msg(format!(
                "Failure to parse query of {} with error: {}",
                test, error
            ))),
            Ok(query) => match query.exec() {
                Err(error) => Err(Error::msg(format!(
                    "Failure to execute query of {} with error: {}",
                    test, error
                ))),
                Ok(actual_results) => {
                    let expected_results = load_sparql_query_result(test.result.as_ref().unwrap())
                        .map_err(|e| {
                            Error::msg(format!(
                                "Error constructing expected graph for {}: {}",
                                test, e
                            ))
                        })?;
                    let with_order =
                        if let StaticQueryResults::Solutions { ordered, .. } = &expected_results {
                            *ordered
                        } else {
                            false
                        };
                    let actual_results =
                        StaticQueryResults::from_query_results(actual_results, with_order)?;

                    if are_query_results_isomorphic(&expected_results, &actual_results) {
                        Ok(())
                    } else {
                        Err(Error::msg(format!("Failure on {}.\nExpected file:\n{}\nOutput file:\n{}\nParsed query:\n{}\nData:\n{}\n",
                                               test,
                                               actual_results,
                                               expected_results,
                                               Query::parse(&read_file_to_string(query_file)?, Some(query_file)).unwrap(),
                                               store
                        )))
                    }
                }
            },
        }
    } else {
        Err(Error::msg(format!("Unsupported test type: {}", test.kind)))
    }
}

fn load_sparql_query_result(url: &str) -> Result<StaticQueryResults> {
    if url.ends_with(".srx") {
        StaticQueryResults::from_query_results(
            QueryResult::read(read_file(url)?, QueryResultSyntax::Xml)?,
            false,
        )
    } else if url.ends_with(".srj") {
        StaticQueryResults::from_query_results(
            QueryResult::read(read_file(url)?, QueryResultSyntax::Json)?,
            false,
        )
    } else {
        Ok(StaticQueryResults::from_dataset(load_store(url)?))
    }
}

#[derive(Clone)]
struct StaticServiceHandler {
    services: Arc<HashMap<NamedNode, MemoryStore>>,
}

impl StaticServiceHandler {
    fn new(services: &[(String, String)]) -> Result<Self> {
        Ok(Self {
            services: Arc::new(
                services
                    .iter()
                    .map(|(name, data)| {
                        let name = NamedNode::parse(name)?;
                        let store = MemoryStore::new();
                        load_to_store(&data, &store, None)?;
                        Ok((name, store))
                    })
                    .collect::<Result<_>>()?,
            ),
        })
    }
}

impl ServiceHandler for StaticServiceHandler {
    fn handle<'a>(
        &'a self,
        service_name: &NamedNode,
        graph_pattern: &'a GraphPattern,
    ) -> Result<QuerySolutionsIterator<'a>> {
        if let QueryResult::Bindings(iterator) = self
            .services
            .get(service_name)
            .ok_or_else(|| Error::msg(format!("Service {} not found", service_name)))?
            .prepare_query_from_pattern(
                &graph_pattern,
                QueryOptions::default().with_service_handler(self.clone()),
            )?
            .exec()?
        {
            //TODO: very ugly
            let (variables, iter) = iterator.destruct();
            let collected = iter.collect::<Vec<_>>();
            Ok(QuerySolutionsIterator::new(
                variables,
                Box::new(collected.into_iter()),
            ))
        } else {
            Err(Error::msg("Expected solutions but got another QueryResult"))
        }
    }
}

fn to_dataset(result: QueryResult<'_>, with_order: bool) -> Result<MemoryStore> {
    match result {
        QueryResult::Graph(graph) => graph.map(|t| t.map(|t| t.in_graph(None))).collect(),
        QueryResult::Boolean(value) => {
            let store = MemoryStore::new();
            let result_set = BlankNode::default();
            store.insert(Quad::new(
                result_set,
                rdf::TYPE.clone(),
                rs::RESULT_SET.clone(),
                None,
            ));
            store.insert(Quad::new(
                result_set,
                rs::BOOLEAN.clone(),
                Literal::from(value),
                None,
            ));
            Ok(store)
        }
        QueryResult::Bindings(solutions) => {
            let store = MemoryStore::new();
            let result_set = BlankNode::default();
            store.insert(Quad::new(
                result_set,
                rdf::TYPE.clone(),
                rs::RESULT_SET.clone(),
                None,
            ));
            for variable in solutions.variables() {
                store.insert(Quad::new(
                    result_set,
                    rs::RESULT_VARIABLE.clone(),
                    Literal::new_simple_literal(variable.as_str()),
                    None,
                ));
            }
            for (i, solution) in solutions.enumerate() {
                let solution = solution?;
                let solution_id = BlankNode::default();
                store.insert(Quad::new(
                    result_set,
                    rs::SOLUTION.clone(),
                    solution_id,
                    None,
                ));
                for (variable, value) in solution.iter() {
                    let binding = BlankNode::default();
                    store.insert(Quad::new(solution_id, rs::BINDING.clone(), binding, None));
                    store.insert(Quad::new(binding, rs::VALUE.clone(), value.clone(), None));
                    store.insert(Quad::new(
                        binding,
                        rs::VARIABLE.clone(),
                        Literal::new_simple_literal(variable.as_str()),
                        None,
                    ));
                }
                if with_order {
                    store.insert(Quad::new(
                        solution_id,
                        rs::INDEX.clone(),
                        Literal::from((i + 1) as i128),
                        None,
                    ));
                }
            }
            Ok(store)
        }
    }
}

fn are_query_results_isomorphic(
    expected: &StaticQueryResults,
    actual: &StaticQueryResults,
) -> bool {
    match (expected, actual) {
        (
            StaticQueryResults::Solutions {
                variables: expected_variables,
                solutions: expected_solutions,
                ordered,
            },
            StaticQueryResults::Solutions {
                variables: actual_variables,
                solutions: actual_solutions,
                ..
            },
        ) => {
            expected_variables == actual_variables
                && if *ordered {
                    expected_solutions.iter().zip(actual_solutions).all(
                        |(expected_solution, actual_solution)| {
                            compare_solutions(expected_solution, actual_solution)
                        },
                    )
                } else {
                    expected_solutions.iter().all(|expected_solution| {
                        actual_solutions.iter().any(|actual_solution| {
                            compare_solutions(expected_solution, actual_solution)
                        })
                    })
                }
        }
        (StaticQueryResults::Boolean(expected), StaticQueryResults::Boolean(actual)) => {
            expected == actual
        }
        (StaticQueryResults::Graph(expected), StaticQueryResults::Graph(actual)) => {
            expected.is_isomorphic(&actual)
        }
        _ => false,
    }
}

fn compare_solutions(expected: &[(Variable, Term)], actual: &[(Variable, Term)]) -> bool {
    let mut bnode_map = HashMap::new();
    expected.iter().zip(actual).all(
        move |((expected_variable, expected_value), (actual_variable, actual_value))| {
            expected_variable == actual_variable
                && expected_value
                    == if let Term::BlankNode(actual_value) = actual_value {
                        bnode_map.entry(actual_value).or_insert(expected_value)
                    } else {
                        actual_value
                    }
        },
    )
}

enum StaticQueryResults {
    Graph(MemoryStore),
    Solutions {
        variables: Vec<Variable>,
        solutions: Vec<Vec<(Variable, Term)>>,
        ordered: bool,
    },
    Boolean(bool),
}

impl fmt::Display for StaticQueryResults {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            StaticQueryResults::Graph(g) => g.fmt(f),
            StaticQueryResults::Solutions {
                variables,
                solutions,
                ..
            } => {
                write!(f, "Variables:")?;
                for v in variables {
                    write!(f, " {}", v)?;
                }
                for solution in solutions {
                    write!(f, "\n{{")?;
                    for (k, v) in solution {
                        write!(f, "{} = {} ", k, v)?;
                    }
                    write!(f, "}}")?;
                }
                Ok(())
            }
            StaticQueryResults::Boolean(b) => b.fmt(f),
        }
    }
}

impl StaticQueryResults {
    fn from_query_results(
        results: QueryResult<'_>,
        with_order: bool,
    ) -> Result<StaticQueryResults> {
        Ok(Self::from_dataset(to_dataset(results, with_order)?))
    }

    fn from_dataset(dataset: MemoryStore) -> StaticQueryResults {
        if let Some(result_set) = dataset
            .quads_for_pattern(
                None,
                Some(&rdf::TYPE),
                Some(&rs::RESULT_SET.clone().into()),
                None,
            )
            .map(|q| q.subject_owned())
            .next()
        {
            if let Some(bool) = dataset
                .quads_for_pattern(Some(&result_set), Some(&rs::BOOLEAN), None, None)
                .map(|q| q.object_owned())
                .next()
            {
                // Boolean query
                StaticQueryResults::Boolean(bool == Literal::from(true).into())
            } else {
                // Regular query
                let mut variables: Vec<Variable> = dataset
                    .quads_for_pattern(Some(&result_set), Some(&rs::RESULT_VARIABLE), None, None)
                    .filter_map(|q| {
                        if let Term::Literal(l) = q.object_owned() {
                            Some(Variable::new(l.value()))
                        } else {
                            None
                        }
                    })
                    .collect();
                variables.sort();

                let mut solutions: Vec<_> = dataset
                    .quads_for_pattern(Some(&result_set), Some(&rs::SOLUTION), None, None)
                    .filter_map(|q| {
                        if let Term::BlankNode(solution) = q.object_owned() {
                            let solution = solution.into();
                            let mut bindings = dataset
                                .quads_for_pattern(Some(&solution), Some(&rs::BINDING), None, None)
                                .filter_map(|q| {
                                    if let Term::BlankNode(binding) = q.object_owned() {
                                        let binding = binding.into();
                                        if let (Some(Term::Literal(variable)), Some(value)) = (
                                            dataset
                                                .quads_for_pattern(
                                                    Some(&binding),
                                                    Some(&rs::VARIABLE),
                                                    None,
                                                    None,
                                                )
                                                .map(|q| q.object_owned())
                                                .next(),
                                            dataset
                                                .quads_for_pattern(
                                                    Some(&binding),
                                                    Some(&rs::VALUE),
                                                    None,
                                                    None,
                                                )
                                                .map(|q| q.object_owned())
                                                .next(),
                                        ) {
                                            Some((Variable::new(variable.value()), value))
                                        } else {
                                            None
                                        }
                                    } else {
                                        None
                                    }
                                })
                                .collect::<Vec<_>>();
                            bindings.sort_by(|(a, _), (b, _)| a.cmp(&b));
                            let index = dataset
                                .quads_for_pattern(Some(&solution), Some(&rs::INDEX), None, None)
                                .filter_map(|q| {
                                    if let Term::Literal(l) = q.object_owned() {
                                        u64::from_str(l.value()).ok()
                                    } else {
                                        None
                                    }
                                })
                                .next();
                            Some((bindings, index))
                        } else {
                            None
                        }
                    })
                    .collect();
                solutions.sort_by(|(_, index_a), (_, index_b)| index_a.cmp(index_b));

                let ordered = solutions.iter().all(|(_, index)| index.is_some());

                StaticQueryResults::Solutions {
                    variables,
                    solutions: solutions
                        .into_iter()
                        .map(|(solution, _)| solution)
                        .collect(),
                    ordered,
                }
            }
        } else {
            StaticQueryResults::Graph(dataset)
        }
    }
}