1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.
//! Utilities to build objects from the `repr` crate for unit testing.
//!
//! These test utilities are relied by crates other than `repr`.
use chrono::NaiveDateTime;
use mz_lowertest::deserialize_optional_generic;
use mz_ore::str::StrExt;
use mz_repr::adt::numeric::Numeric;
use mz_repr::adt::timestamp::CheckedTimestamp;
use mz_repr::strconv::parse_jsonb;
use mz_repr::{Datum, Row, RowArena, ScalarType};
use proc_macro2::TokenTree;
/* #endregion */
fn parse_litval<'a, F>(litval: &'a str, littyp: &str) -> Result<F, String>
where
F: std::str::FromStr,
F::Err: ToString,
{
litval.parse::<F>().map_err(|e| {
format!(
"error when parsing {} into {}: {}",
litval,
littyp,
e.to_string()
)
})
}
/// Constructs a `Row` from a sequence of `litval` and `littyp`.
///
/// See [get_scalar_type_or_default] for creating a `ScalarType`.
///
/// Generally, each `litval` can be parsed into a Datum in the manner you would
/// imagine. Exceptions:
/// * A Timestamp should be in the format `"\"%Y-%m-%d %H:%M:%S%.f\""` or
/// `"\"%Y-%m-%d %H:%M:%S\""`
///
/// Not all types are supported yet. Currently supported types:
/// * string, bool, timestamp
/// * all flavors of numeric types
pub fn test_spec_to_row<'a, I>(datum_iter: I) -> Result<Row, String>
where
I: Iterator<Item = (&'a str, &'a ScalarType)>,
{
let temp_storage = RowArena::new();
Row::try_pack(datum_iter.map(|(litval, littyp)| {
if litval == "null" {
Ok(Datum::Null)
} else {
match littyp {
ScalarType::Bool => Ok(Datum::from(parse_litval::<bool>(litval, "bool")?)),
ScalarType::Numeric { .. } => {
Ok(Datum::from(parse_litval::<Numeric>(litval, "Numeric")?))
}
ScalarType::Int16 => Ok(Datum::from(parse_litval::<i16>(litval, "i16")?)),
ScalarType::Int32 => Ok(Datum::from(parse_litval::<i32>(litval, "i32")?)),
ScalarType::Int64 => Ok(Datum::from(parse_litval::<i64>(litval, "i64")?)),
ScalarType::Float32 => Ok(Datum::from(parse_litval::<f32>(litval, "f32")?)),
ScalarType::Float64 => Ok(Datum::from(parse_litval::<f64>(litval, "f64")?)),
ScalarType::String => Ok(Datum::from(
temp_storage.push_string(mz_lowertest::unquote(litval)),
)),
ScalarType::Timestamp { .. } => {
let datetime = if litval.contains('.') {
NaiveDateTime::parse_from_str(litval, "\"%Y-%m-%d %H:%M:%S%.f\"")
} else {
NaiveDateTime::parse_from_str(litval, "\"%Y-%m-%d %H:%M:%S\"")
};
Ok(Datum::from(
CheckedTimestamp::from_timestamplike(
datetime
.map_err(|e| format!("Error while parsing NaiveDateTime: {}", e))?,
)
.unwrap(),
))
}
ScalarType::Jsonb => parse_jsonb(&mz_lowertest::unquote(litval))
.map(|jsonb| temp_storage.push_unary_row(jsonb.into_row()))
.map_err(|parse| format!("Invalid JSON literal: {:?}", parse)),
_ => Err(format!("Unsupported literal type {:?}", littyp)),
}
}
}))
}
/// Convert a Datum to a String such that [test_spec_to_row] can convert the
/// String back into a row containing the same Datum.
///
/// Currently supports only Datums supported by [test_spec_to_row].
pub fn datum_to_test_spec(datum: Datum) -> String {
let result = format!("{}", datum);
match datum {
Datum::Timestamp(_) => result.quoted().to_string(),
_ => result,
}
}
/// Parses `ScalarType` from `scalar_type_stream` or infers it from `litval`
///
/// See [mz_lowertest::to_json] for the syntax for specifying a `ScalarType`.
/// If `scalar_type_stream` is empty, will attempt to guess a `ScalarType` for
/// the literal:
/// * If `litval` is "true", "false", or "null", will return `Bool`.
/// * Else if starts with `'"'`, will return String.
/// * Else if contains `'.'`, will return Float64.
/// * Otherwise, returns Int64.
pub fn get_scalar_type_or_default<I>(
litval: &str,
scalar_type_stream: &mut I,
) -> Result<ScalarType, String>
where
I: Iterator<Item = TokenTree>,
{
let typ: Option<ScalarType> = deserialize_optional_generic(scalar_type_stream, "ScalarType")?;
match typ {
Some(typ) => Ok(typ),
None => {
if ["true", "false", "null"].contains(&litval) {
Ok(ScalarType::Bool)
} else if litval.starts_with('\"') {
Ok(ScalarType::String)
} else if litval.contains('.') {
Ok(ScalarType::Float64)
} else {
Ok(ScalarType::Int64)
}
}
}
}
/// If the stream starts with a sequence of tokens that can be parsed as a datum,
/// return those tokens as one string.
///
/// Sequences of tokens that can be parsed as a datum:
/// * A Literal token, which is anything in quotations or a positive number
/// * An null, false, or true Ident token
/// * Punct(-) + a literal token
///
/// If the stream starts with a sequence of tokens that can be parsed as a
/// datum, 1) returns Ok(Some(..)) 2) advances the stream to the first token
/// that is not part of the sequence.
/// If the stream does not start with tokens that can be parsed as a datum:
/// * Return Ok(None) if `rest_of_stream` has not been advanced.
/// * Returns Err(..) otherwise.
pub fn extract_literal_string<I>(
first_arg: &TokenTree,
rest_of_stream: &mut I,
) -> Result<Option<String>, String>
where
I: Iterator<Item = TokenTree>,
{
match first_arg {
TokenTree::Ident(ident) => {
if ["true", "false", "null"].contains(&&ident.to_string()[..]) {
Ok(Some(ident.to_string()))
} else {
Ok(None)
}
}
TokenTree::Literal(literal) => Ok(Some(literal.to_string())),
TokenTree::Punct(punct) if punct.as_char() == '-' => {
match rest_of_stream.next() {
Some(TokenTree::Literal(literal)) => {
Ok(Some(format!("{}{}", punct.as_char(), literal)))
}
None => Ok(None),
// Must error instead of handling the tokens using default
// behavior since `stream_iter` has advanced.
Some(other) => Err(format!(
"`{}` `{}` is not a valid literal",
punct.as_char(),
other
)),
}
}
_ => Ok(None),
}
}
/// Parse a token as a vec of strings that can be parsed as datums in a row.
///
/// The token is assumed to be of the form `[datum1 datum2 .. datumn]`.
pub fn parse_vec_of_literals(token: &TokenTree) -> Result<Vec<String>, String> {
match token {
TokenTree::Group(group) => {
let mut inner_iter = group.stream().into_iter();
let mut result = Vec::new();
while let Some(symbol) = inner_iter.next() {
match extract_literal_string(&symbol, &mut inner_iter)? {
Some(dat) => result.push(dat),
None => {
return Err(format!(
"TokenTree `{}` cannot be interpreted as a literal.",
symbol
));
}
}
}
Ok(result)
}
invalid => Err(format!(
"TokenTree `{}` cannot be parsed as a vec of literals",
invalid
)),
}
}