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 73 stack: Vec<StackTraceElement>,74 75 76 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 89 90 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}112113114#[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 evaluate_snippet_to_json(144 &self,145 path: &PathBuf,146 snippet: &str,147 ) -> std::result::Result<Rc<str>, LocError> {148 self.parse_evaluate_raw_with_source(Rc::new(path.clone()), snippet).and_then(|v|v.into_json(4))149 }150151 pub fn add_file(152 &self,153 name: Rc<PathBuf>,154 code: Rc<str>,155 ) -> std::result::Result<(), ParseError> {156 self.data_mut().files.insert(157 name.clone(),158 FileData(159 code.clone(),160 parse(161 &code,162 &ParserSettings {163 file_name: name,164 loc_data: true,165 },166 )?,167 None,168 ),169 );170171 Ok(())172 }173 pub fn add_parsed_file(174 &self,175 name: Rc<PathBuf>,176 code: Rc<str>,177 parsed: LocExpr,178 ) -> std::result::Result<(), ()> {179 self.data_mut()180 .files181 .insert(name, FileData(code, parsed, None));182183 Ok(())184 }185 pub fn get_source(&self, name: &PathBuf) -> Option<Rc<str>> {186 let ro_map = &self.data().files;187 ro_map.get(name).map(|value| value.0.clone())188 }189 pub fn evaluate_file(&self, name: &PathBuf) -> Result<Val> {190 self.run_in_state(|| {191 let expr: LocExpr = {192 let ro_map = &self.data().files;193 let value = ro_map194 .get(name)195 .unwrap_or_else(|| panic!("file not added: {:?}", name));196 if value.2.is_some() {197 return Ok(value.2.clone().unwrap());198 }199 value.1.clone()200 };201 let value = evaluate(self.create_default_context()?, &expr)?;202 {203 self.0204 .data.borrow_mut()205 .files206 .get_mut(name)207 .unwrap()208 .2209 .replace(value.clone());210 }211 Ok(value)212 })213 }214 pub(crate) fn import_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Val> {215 let file_path = self.settings().import_resolver.resolve_file(from, path)?;216 {217 let files = &self.data().files;218 if files.contains_key(&file_path) {219 return self.evaluate_file(&file_path);220 }221 }222 let contents = self.settings().import_resolver.load_file_contents(&file_path)?;223 self.add_file(file_path.clone(), contents).map_err(|e| {224 create_error(Error::ImportSyntaxError(e))225 })?;226 self.evaluate_file(&file_path)227 }228 pub(crate) fn import_file_str(&self, from: &PathBuf, path: &PathBuf) -> Result<Rc<str>> {229 let path = self.settings().import_resolver.resolve_file(from, path)?;230 if !self.data().str_files.contains_key(&path) {231 let file_str = self.settings().import_resolver.load_file_contents(&path)?;232 self.data_mut()233 .str_files234 .insert(path.clone(), file_str);235 }236 Ok(self.data().str_files.get(&path).cloned().unwrap())237 }238239 pub fn parse_evaluate_raw_with_source(&self, source: Rc<PathBuf>, code: &str) -> Result<Val> {240 let parsed = parse(241 &code,242 &ParserSettings {243 file_name: source,244 loc_data: true,245 },246 )247 .unwrap();248 self.evaluate_raw(parsed)249 }250 pub fn parse_evaluate_raw(&self, code: &str) -> Result<Val> {251 self.parse_evaluate_raw_with_source(Rc::new(PathBuf::from("raw.jsonnet")), code)252 }253254 pub fn evaluate_raw(&self, code: LocExpr) -> Result<Val> {255 self.run_in_state(|| evaluate(self.create_default_context()?, &code))256 }257258 pub fn add_global(&self, name: Rc<str>, value: Val) {259 self.settings_mut().globals.insert(name, value);260 }261 pub fn add_ext_var(&self, name: Rc<str>, value: Val) {262 self.settings_mut().ext_vars.insert(name, value);263 }264 pub fn set_max_trace(&self, max_trace: usize) {265 self.settings_mut().max_stack_trace_size = max_trace;266 }267 pub fn set_max_stack(&self, max_stack: usize) {268 self.settings_mut().max_stack_frames = max_stack;269 }270271 pub fn with_stdlib(&self) -> &Self {272 let std_path = Rc::new(PathBuf::from("std.jsonnet"));273 self.run_in_state(|| {274 use jrsonnet_stdlib::STDLIB_STR;275 let mut parsed = false;276 #[cfg(feature = "codegenerated-stdlib")]277 if !parsed {278 parsed = true;279 #[allow(clippy::all)]280 let stdlib = {281 use jrsonnet_parser::*;282 include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))283 };284 self.add_parsed_file(std_path.clone(), STDLIB_STR.to_owned().into(), stdlib)285 .unwrap();286 }287288 #[cfg(feature = "serialized-stdlib")]289 if !parsed {290 parsed = true;291 self.add_parsed_file(292 std_path.clone(),293 STDLIB_STR.to_owned().into(),294 bincode::deserialize(include_bytes!(concat!(295 env!("OUT_DIR"),296 "/stdlib.bincode"297 )))298 .expect("deserialize stdlib"),299 )300 .unwrap();301 }302303 if !parsed {304 self.add_file(std_path, STDLIB_STR.to_owned().into())305 .unwrap();306 }307 let val = self.evaluate_file(&PathBuf::from("std.jsonnet")).unwrap();308 self.add_global("std".into(), val);309 });310 self311 }312313 pub fn create_default_context(&self) -> Result<Context> {314 let globals = &self.settings().globals;315 let mut new_bindings: HashMap<Rc<str>, LazyBinding> = HashMap::new();316 for (name, value) in globals.iter() {317 new_bindings.insert(318 name.clone(),319 LazyBinding::Bound(resolved_lazy_val!(value.clone())),320 );321 }322 Context::new().extend_unbound(new_bindings, None, None, None)323 }324325 326 pub fn push<T>(327 &self,328 e: ExprLocation,329 comment: String,330 f: impl FnOnce() -> Result<T>,331 ) -> Result<T> {332 {333 let mut data = self.data_mut();334 let stack = &mut data.stack;335 if stack.len() > self.settings().max_stack_frames {336 337 drop(data);338 return Err(self.error(Error::StackOverflow));339 } else {340 stack.push(StackTraceElement(e, comment));341 }342 }343 let result = f();344 self.data_mut().stack.pop();345 result346 }347348 349 pub fn stack_trace(&self) -> StackTrace {350 StackTrace(351 self.data()352 .stack353 .iter()354 .rev()355 .take(self.settings().max_stack_trace_size)356 .cloned()357 .collect(),358 )359 }360361 362 pub fn error(&self, err: Error) -> LocError {363 LocError(err, self.stack_trace())364 }365366 367 pub fn run_in_state<T>(&self, f: impl FnOnce() -> T) -> T {368 EVAL_STATE.with(|v| {369 let has_state = v.borrow().is_some();370 if !has_state {371 v.borrow_mut().replace(self.clone());372 }373 let result = f();374 if !has_state {375 v.borrow_mut().take();376 }377 result378 })379 }380}381382#[cfg(test)]383pub mod tests {384 use super::Val;385 use crate::EvaluationState;386 use jrsonnet_parser::*;387 use std::{path::PathBuf, rc::Rc};388389 #[test]390 fn eval_state_stacktrace() {391 let state = EvaluationState::default();392 state393 .push(394 ExprLocation(Rc::new(PathBuf::from("test1.jsonnet")), 10, 20),395 "outer".to_owned(),396 || {397 state.push(398 ExprLocation(Rc::new(PathBuf::from("test2.jsonnet")), 30, 40),399 "inner".to_owned(),400 || {401 Ok(())402 },403 )?;404 Ok(())405 },406 )407 .unwrap();408 }409410 #[test]411 fn eval_state_standard() {412 let state = EvaluationState::default();413 state.with_stdlib();414 assert_eq!(415 state416 .parse_evaluate_raw(r#"std.assertEqual(std.base64("test"), "dGVzdA==")"#)417 .unwrap(),418 Val::Bool(true)419 );420 }421422 macro_rules! eval {423 ($str: expr) => {424 EvaluationState::default()425 .with_stdlib()426 .parse_evaluate_raw($str)427 .unwrap()428 };429 }430 macro_rules! eval_json {431 ($str: expr) => {{432 let evaluator = EvaluationState::default();433 evaluator.with_stdlib();434 evaluator.run_in_state(||{435 evaluator436 .parse_evaluate_raw($str)437 .unwrap()438 .into_json(0)439 .unwrap()440 .replace("\n", "")441 })442 }}443 }444445 446 macro_rules! assert_eval {447 ($str: expr) => {448 assert_eq!(eval!($str), Val::Bool(true))449 };450 }451452 453 macro_rules! assert_eval_neg {454 ($str: expr) => {455 assert_eq!(eval!($str), Val::Bool(false))456 };457 }458 macro_rules! assert_json {459 ($str: expr, $out: expr) => {460 assert_eq!(eval_json!($str), $out.replace("\t", ""))461 };462 }463464 465 #[test]466 fn equality_operator() {467 assert_eval!("2 == 2");468 assert_eval_neg!("2 != 2");469 assert_eval!("2 != 3");470 assert_eval_neg!("2 == 3");471 assert_eval!("'Hello' == 'Hello'");472 assert_eval_neg!("'Hello' != 'Hello'");473 assert_eval!("'Hello' != 'World'");474 assert_eval_neg!("'Hello' == 'World'");475 }476477 #[test]478 fn math_evaluation() {479 assert_eval!("2 + 2 * 2 == 6");480 assert_eval!("3 + (2 + 2 * 2) == 9");481 }482483 #[test]484 fn string_concat() {485 assert_eval!("'Hello' + 'World' == 'HelloWorld'");486 assert_eval!("'Hello' * 3 == 'HelloHelloHello'");487 assert_eval!("'Hello' + 'World' * 3 == 'HelloWorldWorldWorld'");488 }489490 #[test]491 fn faster_join() {492 assert_eval!("std.join([0,0], [[1,2],[3,4],[5,6]]) == [1,2,0,0,3,4,0,0,5,6]");493 assert_eval!("std.join(',', ['1','2','3','4']) == '1,2,3,4'");494 }495496 #[test]497 fn function_contexts() {498 assert_eval!(499 r#"500 local k = {501 t(name = self.h): [self.h, name],502 h: 3,503 };504 local f = {505 t: k.t(),506 h: 4,507 };508 f.t[0] == f.t[1]509 "#510 );511 }512513 #[test]514 fn local() {515 assert_eval!("local a = 2; local b = 3; a + b == 5");516 assert_eval!("local a = 1, b = a + 1; a + b == 3");517 assert_eval!("local a = 1; local a = 2; a == 2");518 }519520 #[test]521 fn object_lazyness() {522 assert_json!("local a = {a:error 'test'}; {}", r#"{}"#);523 }524525 #[test]526 fn object_inheritance() {527 assert_json!("{a: self.b} + {b:3}", r#"{"a": 3,"b": 3}"#);528 }529530 #[test]531 fn object_assertion_success() {532 eval!("{assert \"a\" in self} + {a:2}");533 }534535 #[test]536 fn object_assertion_error() {537 eval!("{assert \"a\" in self}");538 }539540 #[test]541 fn lazy_args() {542 eval!("local test(a) = 2; test(error '3')");543 }544545 #[test]546 #[should_panic]547 fn tailstrict_args() {548 eval!("local test(a) = 2; test(error '3') tailstrict");549 }550551 #[test]552 #[should_panic]553 fn no_binding_error() {554 eval!("a");555 }556557 #[test]558 fn test_object() {559 assert_json!("{a:2}", r#"{"a": 2}"#);560 assert_json!("{a:2+2}", r#"{"a": 4}"#);561 assert_json!("{a:2}+{b:2}", r#"{"a": 2,"b": 2}"#);562 assert_json!("{b:3}+{b:2}", r#"{"b": 2}"#);563 assert_json!("{b:3}+{b+:2}", r#"{"b": 5}"#);564 assert_json!("local test='a'; {[test]:2}", r#"{"a": 2}"#);565 assert_json!(566 r#"567 {568 name: "Alice",569 welcome: "Hello " + self.name + "!",570 }571 "#,572 r#"{"name": "Alice","welcome": "Hello Alice!"}"#573 );574 assert_json!(575 r#"576 {577 name: "Alice",578 welcome: "Hello " + self.name + "!",579 } + {580 name: "Bob"581 }582 "#,583 r#"{"name": "Bob","welcome": "Hello Bob!"}"#584 );585 }586587 #[test]588 fn functions() {589 assert_json!(r#"local a = function(b, c = 2) b + c; a(2)"#, "4");590 assert_json!(591 r#"local a = function(b, c = "Dear") b + c + d, d = "World"; a("Hello")"#,592 r#""HelloDearWorld""#593 );594 }595596 #[test]597 fn local_methods() {598 assert_json!(r#"local a(b, c = 2) = b + c; a(2)"#, "4");599 assert_json!(600 r#"local a(b, c = "Dear") = b + c + d, d = "World"; a("Hello")"#,601 r#""HelloDearWorld""#602 );603 }604605 #[test]606 fn object_locals() {607 assert_json!(r#"{local a = 3, b: a}"#, r#"{"b": 3}"#);608 assert_json!(r#"{local a = 3, local c = a, b: c}"#, r#"{"b": 3}"#);609 assert_json!(610 r#"{local a = function (b) {[b]:4}, test: a("test")}"#,611 r#"{"test": {"test": 4}}"#612 );613 }614615 #[test]616 fn object_comp() {617 assert_json!(618 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}"#,619 "{\"h1_2\": \"0a\",\"h1_3\": \"0a\",\"h1_4\": \"0a\",\"h2_3\": \"a1\",\"h2_4\": \"a1\",\"h3_2\": \"0a\",\"h3_4\": \"a1\"}"620 )621 }622623 #[test]624 fn direct_self() {625 println!(626 "{:#?}",627 eval!(628 r#"629 {630 local me = self,631 a: 3,632 b(): me.a,633 }634 "#635 )636 );637 }638639 #[test]640 fn indirect_self() {641 642 643 eval!(644 r#"{645 local me = self,646 a: 3,647 b: me.a,648 }.b"#649 );650 }651652 653 #[test]654 fn std_assert_ok() {655 eval!("std.assertEqual(4.5 << 2, 16)");656 }657658 #[test]659 #[should_panic]660 fn std_assert_failure() {661 eval!("std.assertEqual(4.5 << 2, 15)");662 }663664 #[test]665 fn string_is_string() {666 assert_eq!(667 eval!("local arr = 'hello'; (!std.isArray(arr)) && (!std.isString(arr))"),668 Val::Bool(false)669 );670 }671672 #[test]673 fn base64_works() {674 assert_json!(r#"std.base64("test")"#, r#""dGVzdA==""#);675 }676677 #[test]678 fn utf8_chars() {679 assert_json!(680 r#"local c="😎";{c:std.codepoint(c),l:std.length(c)}"#,681 r#"{"c": 128526,"l": 1}"#682 )683 }684685 #[test]686 fn json() {687 assert_json!(688 r#"std.manifestJsonEx({a:3, b:4, c:6},"")"#,689 r#""{\n\"a\": 3,\n\"b\": 4,\n\"c\": 6\n}""#690 );691 }692693 #[test]694 fn test() {695 assert_json!(696 r#"[[a, b] for a in [1,2,3] for b in [4,5,6]]"#,697 "[[1,4],[1,5],[1,6],[2,4],[2,5],[2,6],[3,4],[3,5],[3,6]]"698 );699 }700701 #[test]702 fn sjsonnet() {703 eval!(704 r#"705 local x0 = {k: 1};706 local x1 = {k: x0.k + x0.k};707 local x2 = {k: x1.k + x1.k};708 local x3 = {k: x2.k + x2.k};709 local x4 = {k: x3.k + x3.k};710 local x5 = {k: x4.k + x4.k};711 local x6 = {k: x5.k + x5.k};712 local x7 = {k: x6.k + x6.k};713 local x8 = {k: x7.k + x7.k};714 local x9 = {k: x8.k + x8.k};715 local x10 = {k: x9.k + x9.k};716 local x11 = {k: x10.k + x10.k};717 local x12 = {k: x11.k + x11.k};718 local x13 = {k: x12.k + x12.k};719 local x14 = {k: x13.k + x13.k};720 local x15 = {k: x14.k + x14.k};721 local x16 = {k: x15.k + x15.k};722 local x17 = {k: x16.k + x16.k};723 local x18 = {k: x17.k + x17.k};724 local x19 = {k: x18.k + x18.k};725 local x20 = {k: x19.k + x19.k};726 local x21 = {k: x20.k + x20.k};727 x21.k728 "#729 );730 }731732 use test::Bencher;733734 735 736 737 738 739 740 741 742 743 744 745 746747 #[bench]748 fn bench_serialize(b: &mut Bencher) {749 b.iter(|| {750 bincode::deserialize::<jrsonnet_parser::LocExpr>(include_bytes!(concat!(751 env!("OUT_DIR"),752 "/stdlib.bincode"753 )))754 .expect("deserialize stdlib")755 })756 }757758 #[bench]759 fn bench_parse(b: &mut Bencher) {760 b.iter(|| {761 jrsonnet_parser::parse(762 jrsonnet_stdlib::STDLIB_STR,763 &jrsonnet_parser::ParserSettings {764 loc_data: true,765 file_name: Rc::new(PathBuf::from("std.jsonnet")),766 },767 )768 })769 }770}