difftreelog
refactor(evaluator) simplify state internals
in: master
1 file changed
crates/jrsonnet-evaluator/src/lib.rsdiffbeforeafterboth1#![feature(box_syntax, box_patterns)]2#![feature(type_alias_impl_trait)]3#![feature(debug_non_exhaustive)]4#![feature(test)]5#![allow(macro_expanded_macro_exports_accessed_by_absolute_paths)]67extern crate test;89mod ctx;10mod dynamic;11mod error;12mod evaluate;13mod function;14mod import;15mod map;16mod obj;17mod val;1819pub use ctx::*;20pub use dynamic::*;21pub use error::*;22pub use evaluate::*;23pub use function::parse_function_call;24pub use import::*;25use jrsonnet_parser::*;26pub use obj::*;27use std::{cell::RefCell, collections::HashMap, fmt::Debug, path::PathBuf, rc::Rc};28pub use val::*;2930type BindableFn = dyn Fn(Option<ObjValue>, Option<ObjValue>) -> Result<LazyVal>;31#[derive(Clone)]32pub enum LazyBinding {33 Bindable(Rc<BindableFn>),34 Bound(LazyVal),35}3637impl Debug for LazyBinding {38 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {39 write!(f, "LazyBinding")40 }41}42impl LazyBinding {43 pub fn evaluate(&self, this: Option<ObjValue>, super_obj: Option<ObjValue>) -> Result<LazyVal> {44 match self {45 LazyBinding::Bindable(v) => v(this, super_obj),46 LazyBinding::Bound(v) => Ok(v.clone()),47 }48 }49}5051pub struct EvaluationSettings {52 pub max_stack_frames: usize,53 pub max_stack_trace_size: usize,54}55impl Default for EvaluationSettings {56 fn default() -> Self {57 EvaluationSettings {58 max_stack_frames: 200,59 max_stack_trace_size: 20,60 }61 }62}6364pub struct FileData(Rc<str>, LocExpr, Option<Val>);65#[derive(Default)]66pub struct EvaluationStateInternals {67 /// Used for stack-overflows and stacktraces68 stack: RefCell<Vec<StackTraceElement>>,69 /// Contains file source codes and evaluated results for imports and pretty70 /// printing stacktraces71 files: RefCell<HashMap<Rc<PathBuf>, FileData>>,72 str_files: RefCell<HashMap<Rc<PathBuf>, Rc<str>>>,73 globals: RefCell<HashMap<Rc<str>, Val>>,7475 /// Values to use with std.extVar76 ext_vars: RefCell<HashMap<Rc<str>, Val>>,7778 settings: EvaluationSettings,79 import_resolver: Box<dyn ImportResolver>,80}8182thread_local! {83 /// Contains state for currently executing file84 /// Global state is fine there85 pub(crate) static EVAL_STATE: RefCell<Option<EvaluationState>> = RefCell::new(None)86}87pub(crate) fn with_state<T>(f: impl FnOnce(&EvaluationState) -> T) -> T {88 EVAL_STATE.with(|s| f(s.borrow().as_ref().unwrap()))89}90pub(crate) fn create_error(err: Error) -> LocError {91 with_state(|s| s.error(err))92}93pub(crate) fn create_error_result<T>(err: Error) -> Result<T> {94 Err(with_state(|s| s.error(err)))95}96pub(crate) fn push<T>(97 e: &Option<ExprLocation>,98 comment: &str,99 f: impl FnOnce() -> Result<T>,100) -> Result<T> {101 if e.is_some() {102 with_state(|s| s.push(e.clone().unwrap(), comment.to_owned(), f))103 } else {104 f()105 }106}107108/// Maintains stack trace and import resolution109#[derive(Default, Clone)]110pub struct EvaluationState(Rc<EvaluationStateInternals>);111impl EvaluationState {112 pub fn new(settings: EvaluationSettings, import_resolver: Box<dyn ImportResolver>) -> Self {113 EvaluationState(Rc::new(EvaluationStateInternals {114 settings,115 import_resolver,116 ..Default::default()117 }))118 }119 pub fn evaluate_file_to_json(120 &self,121 path: &PathBuf,122 ) -> std::result::Result<Rc<str>, LocError> {123 self.import_file(&PathBuf::new(), &path).and_then(|v|v.into_json(4))124 }125 pub fn add_file(126 &self,127 name: Rc<PathBuf>,128 code: Rc<str>,129 ) -> std::result::Result<(), ParseError> {130 self.0.files.borrow_mut().insert(131 name.clone(),132 FileData(133 code.clone(),134 parse(135 &code,136 &ParserSettings {137 file_name: name,138 loc_data: true,139 },140 )?,141 None,142 ),143 );144145 Ok(())146 }147 pub fn add_parsed_file(148 &self,149 name: Rc<PathBuf>,150 code: Rc<str>,151 parsed: LocExpr,152 ) -> std::result::Result<(), ()> {153 self.0154 .files155 .borrow_mut()156 .insert(name, FileData(code, parsed, None));157158 Ok(())159 }160 pub fn get_source(&self, name: &PathBuf) -> Option<Rc<str>> {161 let ro_map = self.0.files.borrow();162 ro_map.get(name).map(|value| value.0.clone())163 }164 pub fn evaluate_file(&self, name: &PathBuf) -> Result<Val> {165 self.run_in_state(|| {166 let expr: LocExpr = {167 let ro_map = self.0.files.borrow();168 let value = ro_map169 .get(name)170 .unwrap_or_else(|| panic!("file not added: {:?}", name));171 if value.2.is_some() {172 return Ok(value.2.clone().unwrap());173 }174 value.1.clone()175 };176 let value = evaluate(self.create_default_context()?, &expr)?;177 {178 self.0179 .files180 .borrow_mut()181 .get_mut(name)182 .unwrap()183 .2184 .replace(value.clone());185 }186 Ok(value)187 })188 }189 pub(crate) fn import_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Val> {190 let file_path = self.0.import_resolver.resolve_file(from, path)?;191 {192 let files = self.0.files.borrow();193 if files.contains_key(&file_path) {194 return self.evaluate_file(&file_path);195 }196 }197 let contents = self.0.import_resolver.load_file_contents(&file_path)?;198 self.add_file(file_path.clone(), contents).map_err(|e| {199 create_error(Error::ImportSyntaxError(e))200 })?;201 self.evaluate_file(&file_path)202 }203 pub(crate) fn import_file_str(&self, from: &PathBuf, path: &PathBuf) -> Result<Rc<str>> {204 let path = self.0.import_resolver.resolve_file(from, path)?;205 if !self.0.str_files.borrow().contains_key(&path) {206 let file_str = self.0.import_resolver.load_file_contents(&path)?;207 self.0208 .str_files209 .borrow_mut()210 .insert(path.clone(), file_str);211 }212 Ok(self.0.str_files.borrow().get(&path).cloned().unwrap())213 }214215 pub fn parse_evaluate_raw(&self, code: &str) -> Result<Val> {216 let parsed = parse(217 &code,218 &ParserSettings {219 file_name: Rc::new(PathBuf::from("raw.jsonnet")),220 loc_data: true,221 },222 )223 .unwrap();224 self.evaluate_raw(parsed)225 }226227 pub fn evaluate_raw(&self, code: LocExpr) -> Result<Val> {228 self.run_in_state(|| evaluate(self.create_default_context()?, &code))229 }230231 pub fn add_global(&self, name: Rc<str>, value: Val) {232 self.0.globals.borrow_mut().insert(name, value);233 }234 pub fn add_ext_var(&self, name: Rc<str>, value: Val) {235 self.0.ext_vars.borrow_mut().insert(name, value);236 }237238 pub fn with_stdlib(&self) -> &Self {239 let std_path = Rc::new(PathBuf::from("std.jsonnet"));240 self.run_in_state(|| {241 use jrsonnet_stdlib::STDLIB_STR;242 let mut parsed = false;243 #[cfg(feature = "codegenerated-stdlib")]244 if !parsed {245 parsed = true;246 #[allow(clippy::all)]247 let stdlib = {248 use jrsonnet_parser::*;249 include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))250 };251 self.add_parsed_file(std_path.clone(), STDLIB_STR.to_owned().into(), stdlib)252 .unwrap();253 }254255 #[cfg(feature = "serialized-stdlib")]256 if !parsed {257 parsed = true;258 self.add_parsed_file(259 std_path.clone(),260 STDLIB_STR.to_owned().into(),261 bincode::deserialize(include_bytes!(concat!(262 env!("OUT_DIR"),263 "/stdlib.bincode"264 )))265 .expect("deserialize stdlib"),266 )267 .unwrap();268 }269270 if !parsed {271 self.add_file(std_path, STDLIB_STR.to_owned().into())272 .unwrap();273 }274 let val = self.evaluate_file(&PathBuf::from("std.jsonnet")).unwrap();275 self.add_global("std".into(), val);276 });277 self278 }279280 pub fn create_default_context(&self) -> Result<Context> {281 let globals = self.0.globals.borrow();282 let mut new_bindings: HashMap<Rc<str>, LazyBinding> = HashMap::new();283 for (name, value) in globals.iter() {284 new_bindings.insert(285 name.clone(),286 LazyBinding::Bound(resolved_lazy_val!(value.clone())),287 );288 }289 Context::new().extend_unbound(new_bindings, None, None, None)290 }291292 pub fn push<T>(293 &self,294 e: ExprLocation,295 comment: String,296 f: impl FnOnce() -> Result<T>,297 ) -> Result<T> {298 {299 let mut stack = self.0.stack.borrow_mut();300 if stack.len() > self.0.settings.max_stack_frames {301 drop(stack);302 return Err(self.error(Error::StackOverflow));303 } else {304 stack.push(StackTraceElement(e, comment));305 }306 }307 let result = f();308 self.0.stack.borrow_mut().pop();309 result310 }311 pub fn print_stack_trace(&self) {312 for e in self.stack_trace().0 {313 println!("{:?} - {:?}", e.0, e.1)314 }315 }316 pub fn stack_trace(&self) -> StackTrace {317 StackTrace(318 self.0319 .stack320 .borrow()321 .iter()322 .rev()323 .take(self.0.settings.max_stack_trace_size)324 .cloned()325 .collect(),326 )327 }328 pub fn error(&self, err: Error) -> LocError {329 LocError(err, self.stack_trace())330 }331332 pub fn run_in_state<T>(&self, f: impl FnOnce() -> T) -> T {333 EVAL_STATE.with(|v| {334 let has_state = v.borrow().is_some();335 if !has_state {336 v.borrow_mut().replace(self.clone());337 }338 let result = f();339 if !has_state {340 v.borrow_mut().take();341 }342 result343 })344 }345}346347#[cfg(test)]348pub mod tests {349 use super::Val;350 use crate::EvaluationState;351 use jrsonnet_parser::*;352 use std::{path::PathBuf, rc::Rc};353354 #[test]355 fn eval_state_stacktrace() {356 let state = EvaluationState::default();357 state358 .push(359 ExprLocation(Rc::new(PathBuf::from("test1.jsonnet")), 10, 20),360 "outer".to_owned(),361 || {362 state.push(363 ExprLocation(Rc::new(PathBuf::from("test2.jsonnet")), 30, 40),364 "inner".to_owned(),365 || {366 state.print_stack_trace();367 Ok(())368 },369 )?;370 Ok(())371 },372 )373 .unwrap();374 }375376 #[test]377 fn eval_state_standard() {378 let state = EvaluationState::default();379 state.with_stdlib();380 assert_eq!(381 state382 .parse_evaluate_raw(r#"std.assertEqual(std.base64("test"), "dGVzdA==")"#)383 .unwrap(),384 Val::Bool(true)385 );386 }387388 macro_rules! eval {389 ($str: expr) => {390 EvaluationState::default()391 .with_stdlib()392 .parse_evaluate_raw($str)393 .unwrap()394 };395 }396 macro_rules! eval_json {397 ($str: expr) => {{398 let evaluator = EvaluationState::default();399 evaluator.with_stdlib();400 evaluator.run_in_state(||{401 evaluator402 .parse_evaluate_raw($str)403 .unwrap()404 .into_json(0)405 .unwrap()406 .replace("\n", "")407 })408 }}409 }410411 /// Asserts given code returns `true`412 macro_rules! assert_eval {413 ($str: expr) => {414 assert_eq!(eval!($str), Val::Bool(true))415 };416 }417418 /// Asserts given code returns `false`419 macro_rules! assert_eval_neg {420 ($str: expr) => {421 assert_eq!(eval!($str), Val::Bool(false))422 };423 }424 macro_rules! assert_json {425 ($str: expr, $out: expr) => {426 assert_eq!(eval_json!($str), $out.replace("\t", ""))427 };428 }429430 /// Sanity checking, before trusting to another tests431 #[test]432 fn equality_operator() {433 assert_eval!("2 == 2");434 assert_eval_neg!("2 != 2");435 assert_eval!("2 != 3");436 assert_eval_neg!("2 == 3");437 assert_eval!("'Hello' == 'Hello'");438 assert_eval_neg!("'Hello' != 'Hello'");439 assert_eval!("'Hello' != 'World'");440 assert_eval_neg!("'Hello' == 'World'");441 }442443 #[test]444 fn math_evaluation() {445 assert_eval!("2 + 2 * 2 == 6");446 assert_eval!("3 + (2 + 2 * 2) == 9");447 }448449 #[test]450 fn string_concat() {451 assert_eval!("'Hello' + 'World' == 'HelloWorld'");452 assert_eval!("'Hello' * 3 == 'HelloHelloHello'");453 assert_eval!("'Hello' + 'World' * 3 == 'HelloWorldWorldWorld'");454 }455456 #[test]457 fn faster_join() {458 assert_eval!("std.join([0,0], [[1,2],[3,4],[5,6]]) == [1,2,0,0,3,4,0,0,5,6]");459 assert_eval!("std.join(',', ['1','2','3','4']) == '1,2,3,4'");460 }461462 #[test]463 fn function_contexts() {464 assert_eval!(465 r#"466 local k = {467 t(name = self.h): [self.h, name],468 h: 3,469 };470 local f = {471 t: k.t(),472 h: 4,473 };474 f.t[0] == f.t[1]475 "#476 );477 }478479 #[test]480 fn local() {481 assert_eval!("local a = 2; local b = 3; a + b == 5");482 assert_eval!("local a = 1, b = a + 1; a + b == 3");483 assert_eval!("local a = 1; local a = 2; a == 2");484 }485486 #[test]487 fn object_lazyness() {488 assert_json!("local a = {a:error 'test'}; {}", r#"{}"#);489 }490491 #[test]492 fn object_inheritance() {493 assert_json!("{a: self.b} + {b:3}", r#"{"a": 3,"b": 3}"#);494 }495496 #[test]497 fn object_assertion_success() {498 eval!("{assert \"a\" in self} + {a:2}");499 }500501 #[test]502 fn object_assertion_error() {503 eval!("{assert \"a\" in self}");504 }505506 #[test]507 fn lazy_args() {508 eval!("local test(a) = 2; test(error '3')");509 }510511 #[test]512 #[should_panic]513 fn tailstrict_args() {514 eval!("local test(a) = 2; test(error '3') tailstrict");515 }516517 #[test]518 #[should_panic]519 fn no_binding_error() {520 eval!("a");521 }522523 #[test]524 fn test_object() {525 assert_json!("{a:2}", r#"{"a": 2}"#);526 assert_json!("{a:2+2}", r#"{"a": 4}"#);527 assert_json!("{a:2}+{b:2}", r#"{"a": 2,"b": 2}"#);528 assert_json!("{b:3}+{b:2}", r#"{"b": 2}"#);529 assert_json!("{b:3}+{b+:2}", r#"{"b": 5}"#);530 assert_json!("local test='a'; {[test]:2}", r#"{"a": 2}"#);531 assert_json!(532 r#"533 {534 name: "Alice",535 welcome: "Hello " + self.name + "!",536 }537 "#,538 r#"{"name": "Alice","welcome": "Hello Alice!"}"#539 );540 assert_json!(541 r#"542 {543 name: "Alice",544 welcome: "Hello " + self.name + "!",545 } + {546 name: "Bob"547 }548 "#,549 r#"{"name": "Bob","welcome": "Hello Bob!"}"#550 );551 }552553 #[test]554 fn functions() {555 assert_json!(r#"local a = function(b, c = 2) b + c; a(2)"#, "4");556 assert_json!(557 r#"local a = function(b, c = "Dear") b + c + d, d = "World"; a("Hello")"#,558 r#""HelloDearWorld""#559 );560 }561562 #[test]563 fn local_methods() {564 assert_json!(r#"local a(b, c = 2) = b + c; a(2)"#, "4");565 assert_json!(566 r#"local a(b, c = "Dear") = b + c + d, d = "World"; a("Hello")"#,567 r#""HelloDearWorld""#568 );569 }570571 #[test]572 fn object_locals() {573 assert_json!(r#"{local a = 3, b: a}"#, r#"{"b": 3}"#);574 assert_json!(r#"{local a = 3, local c = a, b: c}"#, r#"{"b": 3}"#);575 assert_json!(576 r#"{local a = function (b) {[b]:4}, test: a("test")}"#,577 r#"{"test": {"test": 4}}"#578 );579 }580581 #[test]582 fn object_comp() {583 assert_json!(584 r#"{local t = "a", ["h"+i+"_"+z]: if "h"+(i-1)+"_"+z in self then t+1 else 0+t for i in [1,2,3] for z in [2,3,4] if z != i}"#,585 "{\"h1_2\": \"0a\",\"h1_3\": \"0a\",\"h1_4\": \"0a\",\"h2_3\": \"a1\",\"h2_4\": \"a1\",\"h3_2\": \"0a\",\"h3_4\": \"a1\"}"586 )587 }588589 #[test]590 fn direct_self() {591 println!(592 "{:#?}",593 eval!(594 r#"595 {596 local me = self,597 a: 3,598 b(): me.a,599 }600 "#601 )602 );603 }604605 #[test]606 fn indirect_self() {607 // `self` assigned to `me` was lost when being608 // referenced from field609 eval!(610 r#"{611 local me = self,612 a: 3,613 b: me.a,614 }.b"#615 );616 }617618 // We can't trust other tests (And official jsonnet testsuite), if assert is not working correctly619 #[test]620 fn std_assert_ok() {621 eval!("std.assertEqual(4.5 << 2, 16)");622 }623624 #[test]625 #[should_panic]626 fn std_assert_failure() {627 eval!("std.assertEqual(4.5 << 2, 15)");628 }629630 #[test]631 fn string_is_string() {632 assert_eq!(633 eval!("local arr = 'hello'; (!std.isArray(arr)) && (!std.isString(arr))"),634 Val::Bool(false)635 );636 }637638 #[test]639 fn base64_works() {640 assert_json!(r#"std.base64("test")"#, r#""dGVzdA==""#);641 }642643 #[test]644 fn utf8_chars() {645 assert_json!(646 r#"local c="😎";{c:std.codepoint(c),l:std.length(c)}"#,647 r#"{"c": 128526,"l": 1}"#648 )649 }650651 #[test]652 fn json() {653 assert_json!(654 r#"std.manifestJsonEx({a:3, b:4, c:6},"")"#,655 r#""{\n\"a\": 3,\n\"b\": 4,\n\"c\": 6\n}""#656 );657 }658659 #[test]660 fn test() {661 assert_json!(662 r#"[[a, b] for a in [1,2,3] for b in [4,5,6]]"#,663 "[[1,4],[1,5],[1,6],[2,4],[2,5],[2,6],[3,4],[3,5],[3,6]]"664 );665 }666667 #[test]668 fn sjsonnet() {669 eval!(670 r#"671 local x0 = {k: 1};672 local x1 = {k: x0.k + x0.k};673 local x2 = {k: x1.k + x1.k};674 local x3 = {k: x2.k + x2.k};675 local x4 = {k: x3.k + x3.k};676 local x5 = {k: x4.k + x4.k};677 local x6 = {k: x5.k + x5.k};678 local x7 = {k: x6.k + x6.k};679 local x8 = {k: x7.k + x7.k};680 local x9 = {k: x8.k + x8.k};681 local x10 = {k: x9.k + x9.k};682 local x11 = {k: x10.k + x10.k};683 local x12 = {k: x11.k + x11.k};684 local x13 = {k: x12.k + x12.k};685 local x14 = {k: x13.k + x13.k};686 local x15 = {k: x14.k + x14.k};687 local x16 = {k: x15.k + x15.k};688 local x17 = {k: x16.k + x16.k};689 local x18 = {k: x17.k + x17.k};690 local x19 = {k: x18.k + x18.k};691 local x20 = {k: x19.k + x19.k};692 local x21 = {k: x20.k + x20.k};693 x21.k694 "#695 );696 }697698 use test::Bencher;699700 // This test is commented out by default, because of huge compilation slowdown701 // #[bench]702 // fn bench_codegen(b: &mut Bencher) {703 // b.iter(|| {704 // #[allow(clippy::all)]705 // let stdlib = {706 // use jrsonnet_parser::*;707 // include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))708 // };709 // stdlib710 // })711 // }712713 #[bench]714 fn bench_serialize(b: &mut Bencher) {715 b.iter(|| {716 bincode::deserialize::<jrsonnet_parser::LocExpr>(include_bytes!(concat!(717 env!("OUT_DIR"),718 "/stdlib.bincode"719 )))720 .expect("deserialize stdlib")721 })722 }723724 #[bench]725 fn bench_parse(b: &mut Bencher) {726 b.iter(|| {727 jrsonnet_parser::parse(728 jrsonnet_stdlib::STDLIB_STR,729 &jrsonnet_parser::ParserSettings {730 loc_data: true,731 file_name: Rc::new(PathBuf::from("std.jsonnet")),732 },733 )734 })735 }736}1#![feature(box_syntax, box_patterns)]2#![feature(type_alias_impl_trait)]3#![feature(debug_non_exhaustive)]4#![feature(test)]5#![allow(macro_expanded_macro_exports_accessed_by_absolute_paths)]67extern crate test;89mod ctx;10mod dynamic;11mod error;12mod evaluate;13mod function;14mod import;15mod map;16mod obj;17mod val;1819pub use ctx::*;20pub use dynamic::*;21pub use error::*;22pub use evaluate::*;23pub use function::parse_function_call;24pub use import::*;25use jrsonnet_parser::*;26pub use obj::*;27use std::{cell::{Ref, RefCell, RefMut}, collections::HashMap, fmt::Debug, path::PathBuf, rc::Rc};28pub use val::*;2930type BindableFn = dyn Fn(Option<ObjValue>, Option<ObjValue>) -> Result<LazyVal>;31#[derive(Clone)]32pub enum LazyBinding {33 Bindable(Rc<BindableFn>),34 Bound(LazyVal),35}3637impl Debug for LazyBinding {38 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {39 write!(f, "LazyBinding")40 }41}42impl LazyBinding {43 pub fn evaluate(&self, this: Option<ObjValue>, super_obj: Option<ObjValue>) -> Result<LazyVal> {44 match self {45 LazyBinding::Bindable(v) => v(this, super_obj),46 LazyBinding::Bound(v) => Ok(v.clone()),47 }48 }49}5051struct EvaluationSettings {52 max_stack_frames: usize,53 max_stack_trace_size: usize,54 ext_vars: HashMap<Rc<str>, Val>,55 globals: HashMap<Rc<str>, Val>,56 import_resolver: Box<dyn ImportResolver>,57}58impl Default for EvaluationSettings {59 fn default() -> Self {60 EvaluationSettings {61 max_stack_frames: 200,62 max_stack_trace_size: 20,63 globals: Default::default(),64 ext_vars: Default::default(),65 import_resolver: Box::new(DummyImportResolver),66 }67 }68}6970#[derive(Default)]71struct EvaluationData {72 /// Used for stack-overflows and stacktraces73 stack: Vec<StackTraceElement>,74 /// Contains file source codes and evaluated results for imports and pretty75 /// printing stacktraces76 files: HashMap<Rc<PathBuf>, FileData>,77 str_files: HashMap<Rc<PathBuf>, Rc<str>>,78}7980pub struct FileData(Rc<str>, LocExpr, Option<Val>);81#[derive(Default)]82pub struct EvaluationStateInternals {83 data: RefCell<EvaluationData>,84 settings: RefCell<EvaluationSettings>,85}8687thread_local! {88 /// Contains state for currently executing file89 /// Global state is fine there90 pub(crate) static EVAL_STATE: RefCell<Option<EvaluationState>> = RefCell::new(None)91}92pub(crate) fn with_state<T>(f: impl FnOnce(&EvaluationState) -> T) -> T {93 EVAL_STATE.with(|s| f(s.borrow().as_ref().unwrap()))94}95pub fn create_error(err: Error) -> LocError {96 with_state(|s| s.error(err))97}98pub fn create_error_result<T>(err: Error) -> Result<T> {99 Err(with_state(|s| s.error(err)))100}101pub(crate) fn push<T>(102 e: &Option<ExprLocation>,103 comment: &str,104 f: impl FnOnce() -> Result<T>,105) -> Result<T> {106 if e.is_some() {107 with_state(|s| s.push(e.clone().unwrap(), comment.to_owned(), f))108 } else {109 f()110 }111}112113/// Maintains stack trace and import resolution114#[derive(Default, Clone)]115pub struct EvaluationState(Rc<EvaluationStateInternals>);116impl EvaluationState {117 fn data(&self) -> Ref<EvaluationData> {118 self.0.data.borrow()119 }120 fn data_mut(&self) -> RefMut<EvaluationData> {121 self.0.data.borrow_mut()122 }123 fn settings(&self) -> Ref<EvaluationSettings> {124 self.0.settings.borrow()125 }126 fn settings_mut(&self) -> RefMut<EvaluationSettings> {127 self.0.settings.borrow_mut()128 }129130 pub fn set_import_resolver(&self, resolver: Box<dyn ImportResolver>) {131 self.settings_mut().import_resolver = resolver;132 }133 pub fn import_resolver(&self) -> Ref<dyn ImportResolver> {134 Ref::map(self.settings(), |s|&*s.import_resolver)135 }136137 pub fn evaluate_file_to_json(138 &self,139 path: &PathBuf,140 ) -> std::result::Result<Rc<str>, LocError> {141 self.import_file(&PathBuf::new(), &path).and_then(|v|v.into_json(4))142 }143 pub fn add_file(144 &self,145 name: Rc<PathBuf>,146 code: Rc<str>,147 ) -> std::result::Result<(), ParseError> {148 self.data_mut().files.insert(149 name.clone(),150 FileData(151 code.clone(),152 parse(153 &code,154 &ParserSettings {155 file_name: name,156 loc_data: true,157 },158 )?,159 None,160 ),161 );162163 Ok(())164 }165 pub fn add_parsed_file(166 &self,167 name: Rc<PathBuf>,168 code: Rc<str>,169 parsed: LocExpr,170 ) -> std::result::Result<(), ()> {171 self.data_mut()172 .files173 .insert(name, FileData(code, parsed, None));174175 Ok(())176 }177 pub fn get_source(&self, name: &PathBuf) -> Option<Rc<str>> {178 let ro_map = &self.data().files;179 ro_map.get(name).map(|value| value.0.clone())180 }181 pub fn evaluate_file(&self, name: &PathBuf) -> Result<Val> {182 self.run_in_state(|| {183 let expr: LocExpr = {184 let ro_map = &self.data().files;185 let value = ro_map186 .get(name)187 .unwrap_or_else(|| panic!("file not added: {:?}", name));188 if value.2.is_some() {189 return Ok(value.2.clone().unwrap());190 }191 value.1.clone()192 };193 let value = evaluate(self.create_default_context()?, &expr)?;194 {195 self.0196 .data.borrow_mut()197 .files198 .get_mut(name)199 .unwrap()200 .2201 .replace(value.clone());202 }203 Ok(value)204 })205 }206 pub(crate) fn import_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Val> {207 let file_path = self.settings().import_resolver.resolve_file(from, path)?;208 {209 let files = &self.data().files;210 if files.contains_key(&file_path) {211 return self.evaluate_file(&file_path);212 }213 }214 let contents = self.settings().import_resolver.load_file_contents(&file_path)?;215 self.add_file(file_path.clone(), contents).map_err(|e| {216 create_error(Error::ImportSyntaxError(e))217 })?;218 self.evaluate_file(&file_path)219 }220 pub(crate) fn import_file_str(&self, from: &PathBuf, path: &PathBuf) -> Result<Rc<str>> {221 let path = self.settings().import_resolver.resolve_file(from, path)?;222 if !self.data().str_files.contains_key(&path) {223 let file_str = self.settings().import_resolver.load_file_contents(&path)?;224 self.data_mut()225 .str_files226 .insert(path.clone(), file_str);227 }228 Ok(self.data().str_files.get(&path).cloned().unwrap())229 }230231 pub fn parse_evaluate_raw(&self, code: &str) -> Result<Val> {232 let parsed = parse(233 &code,234 &ParserSettings {235 file_name: Rc::new(PathBuf::from("raw.jsonnet")),236 loc_data: true,237 },238 )239 .unwrap();240 self.evaluate_raw(parsed)241 }242243 pub fn evaluate_raw(&self, code: LocExpr) -> Result<Val> {244 self.run_in_state(|| evaluate(self.create_default_context()?, &code))245 }246247 pub fn add_global(&self, name: Rc<str>, value: Val) {248 self.settings_mut().globals.insert(name, value);249 }250 pub fn add_ext_var(&self, name: Rc<str>, value: Val) {251 self.settings_mut().ext_vars.insert(name, value);252 }253254 pub fn with_stdlib(&self) -> &Self {255 let std_path = Rc::new(PathBuf::from("std.jsonnet"));256 self.run_in_state(|| {257 use jrsonnet_stdlib::STDLIB_STR;258 let mut parsed = false;259 #[cfg(feature = "codegenerated-stdlib")]260 if !parsed {261 parsed = true;262 #[allow(clippy::all)]263 let stdlib = {264 use jrsonnet_parser::*;265 include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))266 };267 self.add_parsed_file(std_path.clone(), STDLIB_STR.to_owned().into(), stdlib)268 .unwrap();269 }270271 #[cfg(feature = "serialized-stdlib")]272 if !parsed {273 parsed = true;274 self.add_parsed_file(275 std_path.clone(),276 STDLIB_STR.to_owned().into(),277 bincode::deserialize(include_bytes!(concat!(278 env!("OUT_DIR"),279 "/stdlib.bincode"280 )))281 .expect("deserialize stdlib"),282 )283 .unwrap();284 }285286 if !parsed {287 self.add_file(std_path, STDLIB_STR.to_owned().into())288 .unwrap();289 }290 let val = self.evaluate_file(&PathBuf::from("std.jsonnet")).unwrap();291 self.add_global("std".into(), val);292 });293 self294 }295296 pub fn create_default_context(&self) -> Result<Context> {297 let globals = &self.settings().globals;298 let mut new_bindings: HashMap<Rc<str>, LazyBinding> = HashMap::new();299 for (name, value) in globals.iter() {300 new_bindings.insert(301 name.clone(),302 LazyBinding::Bound(resolved_lazy_val!(value.clone())),303 );304 }305 Context::new().extend_unbound(new_bindings, None, None, None)306 }307308 pub fn push<T>(309 &self,310 e: ExprLocation,311 comment: String,312 f: impl FnOnce() -> Result<T>,313 ) -> Result<T> {314 {315 let mut data = self.data_mut();316 let stack = &mut data.stack;317 if stack.len() > self.settings().max_stack_frames {318 // Error creation uses data, so i drop guard here319 drop(data);320 return Err(self.error(Error::StackOverflow));321 } else {322 stack.push(StackTraceElement(e, comment));323 }324 }325 let result = f();326 self.data_mut().stack.pop();327 result328 }329 pub fn print_stack_trace(&self) {330 for e in self.stack_trace().0 {331 println!("{:?} - {:?}", e.0, e.1)332 }333 }334 pub fn stack_trace(&self) -> StackTrace {335 StackTrace(336 self.data()337 .stack338 .iter()339 .rev()340 .take(self.settings().max_stack_trace_size)341 .cloned()342 .collect(),343 )344 }345 pub fn error(&self, err: Error) -> LocError {346 LocError(err, self.stack_trace())347 }348349 pub fn run_in_state<T>(&self, f: impl FnOnce() -> T) -> T {350 EVAL_STATE.with(|v| {351 let has_state = v.borrow().is_some();352 if !has_state {353 v.borrow_mut().replace(self.clone());354 }355 let result = f();356 if !has_state {357 v.borrow_mut().take();358 }359 result360 })361 }362}363364#[cfg(test)]365pub mod tests {366 use super::Val;367 use crate::EvaluationState;368 use jrsonnet_parser::*;369 use std::{path::PathBuf, rc::Rc};370371 #[test]372 fn eval_state_stacktrace() {373 let state = EvaluationState::default();374 state375 .push(376 ExprLocation(Rc::new(PathBuf::from("test1.jsonnet")), 10, 20),377 "outer".to_owned(),378 || {379 state.push(380 ExprLocation(Rc::new(PathBuf::from("test2.jsonnet")), 30, 40),381 "inner".to_owned(),382 || {383 state.print_stack_trace();384 Ok(())385 },386 )?;387 Ok(())388 },389 )390 .unwrap();391 }392393 #[test]394 fn eval_state_standard() {395 let state = EvaluationState::default();396 state.with_stdlib();397 assert_eq!(398 state399 .parse_evaluate_raw(r#"std.assertEqual(std.base64("test"), "dGVzdA==")"#)400 .unwrap(),401 Val::Bool(true)402 );403 }404405 macro_rules! eval {406 ($str: expr) => {407 EvaluationState::default()408 .with_stdlib()409 .parse_evaluate_raw($str)410 .unwrap()411 };412 }413 macro_rules! eval_json {414 ($str: expr) => {{415 let evaluator = EvaluationState::default();416 evaluator.with_stdlib();417 evaluator.run_in_state(||{418 evaluator419 .parse_evaluate_raw($str)420 .unwrap()421 .into_json(0)422 .unwrap()423 .replace("\n", "")424 })425 }}426 }427428 /// Asserts given code returns `true`429 macro_rules! assert_eval {430 ($str: expr) => {431 assert_eq!(eval!($str), Val::Bool(true))432 };433 }434435 /// Asserts given code returns `false`436 macro_rules! assert_eval_neg {437 ($str: expr) => {438 assert_eq!(eval!($str), Val::Bool(false))439 };440 }441 macro_rules! assert_json {442 ($str: expr, $out: expr) => {443 assert_eq!(eval_json!($str), $out.replace("\t", ""))444 };445 }446447 /// Sanity checking, before trusting to another tests448 #[test]449 fn equality_operator() {450 assert_eval!("2 == 2");451 assert_eval_neg!("2 != 2");452 assert_eval!("2 != 3");453 assert_eval_neg!("2 == 3");454 assert_eval!("'Hello' == 'Hello'");455 assert_eval_neg!("'Hello' != 'Hello'");456 assert_eval!("'Hello' != 'World'");457 assert_eval_neg!("'Hello' == 'World'");458 }459460 #[test]461 fn math_evaluation() {462 assert_eval!("2 + 2 * 2 == 6");463 assert_eval!("3 + (2 + 2 * 2) == 9");464 }465466 #[test]467 fn string_concat() {468 assert_eval!("'Hello' + 'World' == 'HelloWorld'");469 assert_eval!("'Hello' * 3 == 'HelloHelloHello'");470 assert_eval!("'Hello' + 'World' * 3 == 'HelloWorldWorldWorld'");471 }472473 #[test]474 fn faster_join() {475 assert_eval!("std.join([0,0], [[1,2],[3,4],[5,6]]) == [1,2,0,0,3,4,0,0,5,6]");476 assert_eval!("std.join(',', ['1','2','3','4']) == '1,2,3,4'");477 }478479 #[test]480 fn function_contexts() {481 assert_eval!(482 r#"483 local k = {484 t(name = self.h): [self.h, name],485 h: 3,486 };487 local f = {488 t: k.t(),489 h: 4,490 };491 f.t[0] == f.t[1]492 "#493 );494 }495496 #[test]497 fn local() {498 assert_eval!("local a = 2; local b = 3; a + b == 5");499 assert_eval!("local a = 1, b = a + 1; a + b == 3");500 assert_eval!("local a = 1; local a = 2; a == 2");501 }502503 #[test]504 fn object_lazyness() {505 assert_json!("local a = {a:error 'test'}; {}", r#"{}"#);506 }507508 #[test]509 fn object_inheritance() {510 assert_json!("{a: self.b} + {b:3}", r#"{"a": 3,"b": 3}"#);511 }512513 #[test]514 fn object_assertion_success() {515 eval!("{assert \"a\" in self} + {a:2}");516 }517518 #[test]519 fn object_assertion_error() {520 eval!("{assert \"a\" in self}");521 }522523 #[test]524 fn lazy_args() {525 eval!("local test(a) = 2; test(error '3')");526 }527528 #[test]529 #[should_panic]530 fn tailstrict_args() {531 eval!("local test(a) = 2; test(error '3') tailstrict");532 }533534 #[test]535 #[should_panic]536 fn no_binding_error() {537 eval!("a");538 }539540 #[test]541 fn test_object() {542 assert_json!("{a:2}", r#"{"a": 2}"#);543 assert_json!("{a:2+2}", r#"{"a": 4}"#);544 assert_json!("{a:2}+{b:2}", r#"{"a": 2,"b": 2}"#);545 assert_json!("{b:3}+{b:2}", r#"{"b": 2}"#);546 assert_json!("{b:3}+{b+:2}", r#"{"b": 5}"#);547 assert_json!("local test='a'; {[test]:2}", r#"{"a": 2}"#);548 assert_json!(549 r#"550 {551 name: "Alice",552 welcome: "Hello " + self.name + "!",553 }554 "#,555 r#"{"name": "Alice","welcome": "Hello Alice!"}"#556 );557 assert_json!(558 r#"559 {560 name: "Alice",561 welcome: "Hello " + self.name + "!",562 } + {563 name: "Bob"564 }565 "#,566 r#"{"name": "Bob","welcome": "Hello Bob!"}"#567 );568 }569570 #[test]571 fn functions() {572 assert_json!(r#"local a = function(b, c = 2) b + c; a(2)"#, "4");573 assert_json!(574 r#"local a = function(b, c = "Dear") b + c + d, d = "World"; a("Hello")"#,575 r#""HelloDearWorld""#576 );577 }578579 #[test]580 fn local_methods() {581 assert_json!(r#"local a(b, c = 2) = b + c; a(2)"#, "4");582 assert_json!(583 r#"local a(b, c = "Dear") = b + c + d, d = "World"; a("Hello")"#,584 r#""HelloDearWorld""#585 );586 }587588 #[test]589 fn object_locals() {590 assert_json!(r#"{local a = 3, b: a}"#, r#"{"b": 3}"#);591 assert_json!(r#"{local a = 3, local c = a, b: c}"#, r#"{"b": 3}"#);592 assert_json!(593 r#"{local a = function (b) {[b]:4}, test: a("test")}"#,594 r#"{"test": {"test": 4}}"#595 );596 }597598 #[test]599 fn object_comp() {600 assert_json!(601 r#"{local t = "a", ["h"+i+"_"+z]: if "h"+(i-1)+"_"+z in self then t+1 else 0+t for i in [1,2,3] for z in [2,3,4] if z != i}"#,602 "{\"h1_2\": \"0a\",\"h1_3\": \"0a\",\"h1_4\": \"0a\",\"h2_3\": \"a1\",\"h2_4\": \"a1\",\"h3_2\": \"0a\",\"h3_4\": \"a1\"}"603 )604 }605606 #[test]607 fn direct_self() {608 println!(609 "{:#?}",610 eval!(611 r#"612 {613 local me = self,614 a: 3,615 b(): me.a,616 }617 "#618 )619 );620 }621622 #[test]623 fn indirect_self() {624 // `self` assigned to `me` was lost when being625 // referenced from field626 eval!(627 r#"{628 local me = self,629 a: 3,630 b: me.a,631 }.b"#632 );633 }634635 // We can't trust other tests (And official jsonnet testsuite), if assert is not working correctly636 #[test]637 fn std_assert_ok() {638 eval!("std.assertEqual(4.5 << 2, 16)");639 }640641 #[test]642 #[should_panic]643 fn std_assert_failure() {644 eval!("std.assertEqual(4.5 << 2, 15)");645 }646647 #[test]648 fn string_is_string() {649 assert_eq!(650 eval!("local arr = 'hello'; (!std.isArray(arr)) && (!std.isString(arr))"),651 Val::Bool(false)652 );653 }654655 #[test]656 fn base64_works() {657 assert_json!(r#"std.base64("test")"#, r#""dGVzdA==""#);658 }659660 #[test]661 fn utf8_chars() {662 assert_json!(663 r#"local c="😎";{c:std.codepoint(c),l:std.length(c)}"#,664 r#"{"c": 128526,"l": 1}"#665 )666 }667668 #[test]669 fn json() {670 assert_json!(671 r#"std.manifestJsonEx({a:3, b:4, c:6},"")"#,672 r#""{\n\"a\": 3,\n\"b\": 4,\n\"c\": 6\n}""#673 );674 }675676 #[test]677 fn test() {678 assert_json!(679 r#"[[a, b] for a in [1,2,3] for b in [4,5,6]]"#,680 "[[1,4],[1,5],[1,6],[2,4],[2,5],[2,6],[3,4],[3,5],[3,6]]"681 );682 }683684 #[test]685 fn sjsonnet() {686 eval!(687 r#"688 local x0 = {k: 1};689 local x1 = {k: x0.k + x0.k};690 local x2 = {k: x1.k + x1.k};691 local x3 = {k: x2.k + x2.k};692 local x4 = {k: x3.k + x3.k};693 local x5 = {k: x4.k + x4.k};694 local x6 = {k: x5.k + x5.k};695 local x7 = {k: x6.k + x6.k};696 local x8 = {k: x7.k + x7.k};697 local x9 = {k: x8.k + x8.k};698 local x10 = {k: x9.k + x9.k};699 local x11 = {k: x10.k + x10.k};700 local x12 = {k: x11.k + x11.k};701 local x13 = {k: x12.k + x12.k};702 local x14 = {k: x13.k + x13.k};703 local x15 = {k: x14.k + x14.k};704 local x16 = {k: x15.k + x15.k};705 local x17 = {k: x16.k + x16.k};706 local x18 = {k: x17.k + x17.k};707 local x19 = {k: x18.k + x18.k};708 local x20 = {k: x19.k + x19.k};709 local x21 = {k: x20.k + x20.k};710 x21.k711 "#712 );713 }714715 use test::Bencher;716717 // This test is commented out by default, because of huge compilation slowdown718 // #[bench]719 // fn bench_codegen(b: &mut Bencher) {720 // b.iter(|| {721 // #[allow(clippy::all)]722 // let stdlib = {723 // use jrsonnet_parser::*;724 // include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))725 // };726 // stdlib727 // })728 // }729730 #[bench]731 fn bench_serialize(b: &mut Bencher) {732 b.iter(|| {733 bincode::deserialize::<jrsonnet_parser::LocExpr>(include_bytes!(concat!(734 env!("OUT_DIR"),735 "/stdlib.bincode"736 )))737 .expect("deserialize stdlib")738 })739 }740741 #[bench]742 fn bench_parse(b: &mut Bencher) {743 b.iter(|| {744 jrsonnet_parser::parse(745 jrsonnet_stdlib::STDLIB_STR,746 &jrsonnet_parser::ParserSettings {747 loc_data: true,748 file_name: Rc::new(PathBuf::from("std.jsonnet")),749 },750 )751 })752 }753}